software.amazon.awscdk.services.appmesh

Class CfnRoute

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appmesh.CfnRoute

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:04.985Z")
 @Stability(value=Stable)
public class CfnRoute
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppMesh::Route`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appmesh.*;
 CfnRoute cfnRoute = CfnRoute.Builder.create(this, "MyCfnRoute")
         .meshName("meshName")
         .spec(RouteSpecProperty.builder()
                 .grpcRoute(GrpcRouteProperty.builder()
                         .action(GrpcRouteActionProperty.builder()
                                 .weightedTargets(List.of(WeightedTargetProperty.builder()
                                         .virtualNode("virtualNode")
                                         .weight(123)
                                         .build()))
                                 .build())
                         .match(GrpcRouteMatchProperty.builder()
                                 .metadata(List.of(GrpcRouteMetadataProperty.builder()
                                         .name("name")
                                         // the properties below are optional
                                         .invert(false)
                                         .match(GrpcRouteMetadataMatchMethodProperty.builder()
                                                 .exact("exact")
                                                 .prefix("prefix")
                                                 .range(MatchRangeProperty.builder()
                                                         .end(123)
                                                         .start(123)
                                                         .build())
                                                 .regex("regex")
                                                 .suffix("suffix")
                                                 .build())
                                         .build()))
                                 .methodName("methodName")
                                 .serviceName("serviceName")
                                 .build())
                         // the properties below are optional
                         .retryPolicy(GrpcRetryPolicyProperty.builder()
                                 .maxRetries(123)
                                 .perRetryTimeout(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 // the properties below are optional
                                 .grpcRetryEvents(List.of("grpcRetryEvents"))
                                 .httpRetryEvents(List.of("httpRetryEvents"))
                                 .tcpRetryEvents(List.of("tcpRetryEvents"))
                                 .build())
                         .timeout(GrpcTimeoutProperty.builder()
                                 .idle(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 .perRequest(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 .build())
                         .build())
                 .http2Route(HttpRouteProperty.builder()
                         .action(HttpRouteActionProperty.builder()
                                 .weightedTargets(List.of(WeightedTargetProperty.builder()
                                         .virtualNode("virtualNode")
                                         .weight(123)
                                         .build()))
                                 .build())
                         .match(HttpRouteMatchProperty.builder()
                                 .headers(List.of(HttpRouteHeaderProperty.builder()
                                         .name("name")
                                         // the properties below are optional
                                         .invert(false)
                                         .match(HeaderMatchMethodProperty.builder()
                                                 .exact("exact")
                                                 .prefix("prefix")
                                                 .range(MatchRangeProperty.builder()
                                                         .end(123)
                                                         .start(123)
                                                         .build())
                                                 .regex("regex")
                                                 .suffix("suffix")
                                                 .build())
                                         .build()))
                                 .method("method")
                                 .path(HttpPathMatchProperty.builder()
                                         .exact("exact")
                                         .regex("regex")
                                         .build())
                                 .prefix("prefix")
                                 .queryParameters(List.of(QueryParameterProperty.builder()
                                         .name("name")
                                         // the properties below are optional
                                         .match(HttpQueryParameterMatchProperty.builder()
                                                 .exact("exact")
                                                 .build())
                                         .build()))
                                 .scheme("scheme")
                                 .build())
                         // the properties below are optional
                         .retryPolicy(HttpRetryPolicyProperty.builder()
                                 .maxRetries(123)
                                 .perRetryTimeout(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 // the properties below are optional
                                 .httpRetryEvents(List.of("httpRetryEvents"))
                                 .tcpRetryEvents(List.of("tcpRetryEvents"))
                                 .build())
                         .timeout(HttpTimeoutProperty.builder()
                                 .idle(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 .perRequest(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 .build())
                         .build())
                 .httpRoute(HttpRouteProperty.builder()
                         .action(HttpRouteActionProperty.builder()
                                 .weightedTargets(List.of(WeightedTargetProperty.builder()
                                         .virtualNode("virtualNode")
                                         .weight(123)
                                         .build()))
                                 .build())
                         .match(HttpRouteMatchProperty.builder()
                                 .headers(List.of(HttpRouteHeaderProperty.builder()
                                         .name("name")
                                         // the properties below are optional
                                         .invert(false)
                                         .match(HeaderMatchMethodProperty.builder()
                                                 .exact("exact")
                                                 .prefix("prefix")
                                                 .range(MatchRangeProperty.builder()
                                                         .end(123)
                                                         .start(123)
                                                         .build())
                                                 .regex("regex")
                                                 .suffix("suffix")
                                                 .build())
                                         .build()))
                                 .method("method")
                                 .path(HttpPathMatchProperty.builder()
                                         .exact("exact")
                                         .regex("regex")
                                         .build())
                                 .prefix("prefix")
                                 .queryParameters(List.of(QueryParameterProperty.builder()
                                         .name("name")
                                         // the properties below are optional
                                         .match(HttpQueryParameterMatchProperty.builder()
                                                 .exact("exact")
                                                 .build())
                                         .build()))
                                 .scheme("scheme")
                                 .build())
                         // the properties below are optional
                         .retryPolicy(HttpRetryPolicyProperty.builder()
                                 .maxRetries(123)
                                 .perRetryTimeout(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 // the properties below are optional
                                 .httpRetryEvents(List.of("httpRetryEvents"))
                                 .tcpRetryEvents(List.of("tcpRetryEvents"))
                                 .build())
                         .timeout(HttpTimeoutProperty.builder()
                                 .idle(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 .perRequest(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 .build())
                         .build())
                 .priority(123)
                 .tcpRoute(TcpRouteProperty.builder()
                         .action(TcpRouteActionProperty.builder()
                                 .weightedTargets(List.of(WeightedTargetProperty.builder()
                                         .virtualNode("virtualNode")
                                         .weight(123)
                                         .build()))
                                 .build())
                         // the properties below are optional
                         .timeout(TcpTimeoutProperty.builder()
                                 .idle(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 .build())
                         .build())
                 .build())
         .virtualRouterName("virtualRouterName")
         // the properties below are optional
         .meshOwner("meshOwner")
         .routeName("routeName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnRoute.Builder A fluent builder for CfnRoute.
static interface	CfnRoute.DurationProperty Example:
static interface	CfnRoute.GrpcRetryPolicyProperty Example:
static interface	CfnRoute.GrpcRouteActionProperty Example:
static interface	CfnRoute.GrpcRouteMatchProperty Example:
static interface	CfnRoute.GrpcRouteMetadataMatchMethodProperty Example:
static interface	CfnRoute.GrpcRouteMetadataProperty Example:
static interface	CfnRoute.GrpcRouteProperty Example:
static interface	CfnRoute.GrpcTimeoutProperty Example:
static interface	CfnRoute.HeaderMatchMethodProperty Example:
static interface	CfnRoute.HttpPathMatchProperty Example:
static interface	CfnRoute.HttpQueryParameterMatchProperty Example:
static interface	CfnRoute.HttpRetryPolicyProperty Example:
static interface	CfnRoute.HttpRouteActionProperty Example:
static interface	CfnRoute.HttpRouteHeaderProperty Example:
static interface	CfnRoute.HttpRouteMatchProperty Example:
static interface	CfnRoute.HttpRouteProperty Example:
static interface	CfnRoute.HttpTimeoutProperty Example:
static interface	CfnRoute.MatchRangeProperty Example:
static interface	CfnRoute.QueryParameterProperty Example:
static interface	CfnRoute.RouteSpecProperty Example:
static interface	CfnRoute.TcpRouteActionProperty Example:
static interface	CfnRoute.TcpRouteProperty Example:
static interface	CfnRoute.TcpTimeoutProperty Example:
static interface	CfnRoute.WeightedTargetProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnRoute(software.constructs.Construct scope, String id, CfnRouteProps props) Create a new `AWS::AppMesh::Route`.
protected	CfnRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRoute(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrMeshName()
String	getAttrMeshOwner()
String	getAttrResourceOwner()
String	getAttrRouteName()
String	getAttrUid()
String	getAttrVirtualRouterName()
protected Map<String,Object>	getCfnProperties()
String	getMeshName() `AWS::AppMesh::Route.MeshName`.
String	getMeshOwner() `AWS::AppMesh::Route.MeshOwner`.
String	getRouteName() `AWS::AppMesh::Route.RouteName`.
Object	getSpec() `AWS::AppMesh::Route.Spec`.
TagManager	getTags() `AWS::AppMesh::Route.Tags`.
String	getVirtualRouterName() `AWS::AppMesh::Route.VirtualRouterName`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setMeshName(String value) `AWS::AppMesh::Route.MeshName`.
void	setMeshOwner(String value) `AWS::AppMesh::Route.MeshOwner`.
void	setRouteName(String value) `AWS::AppMesh::Route.RouteName`.
void	setSpec(CfnRoute.RouteSpecProperty value) `AWS::AppMesh::Route.Spec`.
void	setSpec(IResolvable value) `AWS::AppMesh::Route.Spec`.
void	setVirtualRouterName(String value) `AWS::AppMesh::Route.VirtualRouterName`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnRoute

protected CfnRoute(software.amazon.jsii.JsiiObjectRef objRef)

CfnRoute

protected CfnRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRoute

@Stability(value=Stable)
public CfnRoute(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnRouteProps props)

Create a new `AWS::AppMesh::Route`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getAttrMeshName

@Stability(value=Stable)
 @NotNull
public String getAttrMeshName()

getAttrMeshOwner

@Stability(value=Stable)
 @NotNull
public String getAttrMeshOwner()

getAttrResourceOwner

@Stability(value=Stable)
 @NotNull
public String getAttrResourceOwner()

getAttrRouteName

@Stability(value=Stable)
 @NotNull
public String getAttrRouteName()

getAttrUid

@Stability(value=Stable)
 @NotNull
public String getAttrUid()

getAttrVirtualRouterName

@Stability(value=Stable)
 @NotNull
public String getAttrVirtualRouterName()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getMeshName

@Stability(value=Stable)
 @NotNull
public String getMeshName()

`AWS::AppMesh::Route.MeshName`.

setMeshName

@Stability(value=Stable)
public void setMeshName(@NotNull
                                                 String value)

`AWS::AppMesh::Route.MeshName`.

getMeshOwner

@Stability(value=Stable)
 @Nullable
public String getMeshOwner()

`AWS::AppMesh::Route.MeshOwner`.

setMeshOwner

@Stability(value=Stable)
public void setMeshOwner(@Nullable
                                                  String value)

`AWS::AppMesh::Route.MeshOwner`.

getRouteName

@Stability(value=Stable)
 @Nullable
public String getRouteName()

`AWS::AppMesh::Route.RouteName`.

setRouteName

@Stability(value=Stable)
public void setRouteName(@Nullable
                                                  String value)

`AWS::AppMesh::Route.RouteName`.

getSpec

@Stability(value=Stable)
 @NotNull
public Object getSpec()

`AWS::AppMesh::Route.Spec`.

setSpec

@Stability(value=Stable)
public void setSpec(@NotNull
                                             CfnRoute.RouteSpecProperty value)

`AWS::AppMesh::Route.Spec`.

setSpec

@Stability(value=Stable)
public void setSpec(@NotNull
                                             IResolvable value)

`AWS::AppMesh::Route.Spec`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::AppMesh::Route.Tags`.

getVirtualRouterName

@Stability(value=Stable)
 @NotNull
public String getVirtualRouterName()

`AWS::AppMesh::Route.VirtualRouterName`.

setVirtualRouterName

@Stability(value=Stable)
public void setVirtualRouterName(@NotNull
                                                          String value)

`AWS::AppMesh::Route.VirtualRouterName`.