software.amazon.awscdk.services.appmesh

Class CfnGatewayRoute

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.CfnGatewayRoute

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.897Z")
 @Stability(value=Stable)
public class CfnGatewayRoute
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppMesh::GatewayRoute`.

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.*;
 CfnGatewayRoute cfnGatewayRoute = CfnGatewayRoute.Builder.create(this, "MyCfnGatewayRoute")
         .meshName("meshName")
         .spec(GatewayRouteSpecProperty.builder()
                 .grpcRoute(GrpcGatewayRouteProperty.builder()
                         .action(GrpcGatewayRouteActionProperty.builder()
                                 .target(GatewayRouteTargetProperty.builder()
                                         .virtualService(GatewayRouteVirtualServiceProperty.builder()
                                                 .virtualServiceName("virtualServiceName")
                                                 .build())
                                         .build())
                                 // the properties below are optional
                                 .rewrite(GrpcGatewayRouteRewriteProperty.builder()
                                         .hostname(GatewayRouteHostnameRewriteProperty.builder()
                                                 .defaultTargetHostname("defaultTargetHostname")
                                                 .build())
                                         .build())
                                 .build())
                         .match(GrpcGatewayRouteMatchProperty.builder()
                                 .hostname(GatewayRouteHostnameMatchProperty.builder()
                                         .exact("exact")
                                         .suffix("suffix")
                                         .build())
                                 .metadata(List.of(GrpcGatewayRouteMetadataProperty.builder()
                                         .name("name")
                                         // the properties below are optional
                                         .invert(false)
                                         .match(GatewayRouteMetadataMatchProperty.builder()
                                                 .exact("exact")
                                                 .prefix("prefix")
                                                 .range(GatewayRouteRangeMatchProperty.builder()
                                                         .end(123)
                                                         .start(123)
                                                         .build())
                                                 .regex("regex")
                                                 .suffix("suffix")
                                                 .build())
                                         .build()))
                                 .serviceName("serviceName")
                                 .build())
                         .build())
                 .http2Route(HttpGatewayRouteProperty.builder()
                         .action(HttpGatewayRouteActionProperty.builder()
                                 .target(GatewayRouteTargetProperty.builder()
                                         .virtualService(GatewayRouteVirtualServiceProperty.builder()
                                                 .virtualServiceName("virtualServiceName")
                                                 .build())
                                         .build())
                                 // the properties below are optional
                                 .rewrite(HttpGatewayRouteRewriteProperty.builder()
                                         .hostname(GatewayRouteHostnameRewriteProperty.builder()
                                                 .defaultTargetHostname("defaultTargetHostname")
                                                 .build())
                                         .path(HttpGatewayRoutePathRewriteProperty.builder()
                                                 .exact("exact")
                                                 .build())
                                         .prefix(HttpGatewayRoutePrefixRewriteProperty.builder()
                                                 .defaultPrefix("defaultPrefix")
                                                 .value("value")
                                                 .build())
                                         .build())
                                 .build())
                         .match(HttpGatewayRouteMatchProperty.builder()
                                 .headers(List.of(HttpGatewayRouteHeaderProperty.builder()
                                         .name("name")
                                         // the properties below are optional
                                         .invert(false)
                                         .match(HttpGatewayRouteHeaderMatchProperty.builder()
                                                 .exact("exact")
                                                 .prefix("prefix")
                                                 .range(GatewayRouteRangeMatchProperty.builder()
                                                         .end(123)
                                                         .start(123)
                                                         .build())
                                                 .regex("regex")
                                                 .suffix("suffix")
                                                 .build())
                                         .build()))
                                 .hostname(GatewayRouteHostnameMatchProperty.builder()
                                         .exact("exact")
                                         .suffix("suffix")
                                         .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()))
                                 .build())
                         .build())
                 .httpRoute(HttpGatewayRouteProperty.builder()
                         .action(HttpGatewayRouteActionProperty.builder()
                                 .target(GatewayRouteTargetProperty.builder()
                                         .virtualService(GatewayRouteVirtualServiceProperty.builder()
                                                 .virtualServiceName("virtualServiceName")
                                                 .build())
                                         .build())
                                 // the properties below are optional
                                 .rewrite(HttpGatewayRouteRewriteProperty.builder()
                                         .hostname(GatewayRouteHostnameRewriteProperty.builder()
                                                 .defaultTargetHostname("defaultTargetHostname")
                                                 .build())
                                         .path(HttpGatewayRoutePathRewriteProperty.builder()
                                                 .exact("exact")
                                                 .build())
                                         .prefix(HttpGatewayRoutePrefixRewriteProperty.builder()
                                                 .defaultPrefix("defaultPrefix")
                                                 .value("value")
                                                 .build())
                                         .build())
                                 .build())
                         .match(HttpGatewayRouteMatchProperty.builder()
                                 .headers(List.of(HttpGatewayRouteHeaderProperty.builder()
                                         .name("name")
                                         // the properties below are optional
                                         .invert(false)
                                         .match(HttpGatewayRouteHeaderMatchProperty.builder()
                                                 .exact("exact")
                                                 .prefix("prefix")
                                                 .range(GatewayRouteRangeMatchProperty.builder()
                                                         .end(123)
                                                         .start(123)
                                                         .build())
                                                 .regex("regex")
                                                 .suffix("suffix")
                                                 .build())
                                         .build()))
                                 .hostname(GatewayRouteHostnameMatchProperty.builder()
                                         .exact("exact")
                                         .suffix("suffix")
                                         .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()))
                                 .build())
                         .build())
                 .priority(123)
                 .build())
         .virtualGatewayName("virtualGatewayName")
         // the properties below are optional
         .gatewayRouteName("gatewayRouteName")
         .meshOwner("meshOwner")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnGatewayRoute.Builder A fluent builder for CfnGatewayRoute.
static interface	CfnGatewayRoute.GatewayRouteHostnameMatchProperty Example:
static interface	CfnGatewayRoute.GatewayRouteHostnameRewriteProperty Example:
static interface	CfnGatewayRoute.GatewayRouteMetadataMatchProperty Example:
static interface	CfnGatewayRoute.GatewayRouteRangeMatchProperty Example:
static interface	CfnGatewayRoute.GatewayRouteSpecProperty Example:
static interface	CfnGatewayRoute.GatewayRouteTargetProperty Example:
static interface	CfnGatewayRoute.GatewayRouteVirtualServiceProperty Example:
static interface	CfnGatewayRoute.GrpcGatewayRouteActionProperty Example:
static interface	CfnGatewayRoute.GrpcGatewayRouteMatchProperty Example:
static interface	CfnGatewayRoute.GrpcGatewayRouteMetadataProperty Example:
static interface	CfnGatewayRoute.GrpcGatewayRouteProperty Example:
static interface	CfnGatewayRoute.GrpcGatewayRouteRewriteProperty Example:
static interface	CfnGatewayRoute.HttpGatewayRouteActionProperty Example:
static interface	CfnGatewayRoute.HttpGatewayRouteHeaderMatchProperty Example:
static interface	CfnGatewayRoute.HttpGatewayRouteHeaderProperty Example:
static interface	CfnGatewayRoute.HttpGatewayRouteMatchProperty Example:
static interface	CfnGatewayRoute.HttpGatewayRoutePathRewriteProperty Example:
static interface	CfnGatewayRoute.HttpGatewayRoutePrefixRewriteProperty Example:
static interface	CfnGatewayRoute.HttpGatewayRouteProperty Example:
static interface	CfnGatewayRoute.HttpGatewayRouteRewriteProperty Example:
static interface	CfnGatewayRoute.HttpPathMatchProperty Example:
static interface	CfnGatewayRoute.HttpQueryParameterMatchProperty Example:
static interface	CfnGatewayRoute.QueryParameterProperty 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
	CfnGatewayRoute(software.constructs.Construct scope, String id, CfnGatewayRouteProps props) Create a new `AWS::AppMesh::GatewayRoute`.
protected	CfnGatewayRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGatewayRoute(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrGatewayRouteName()
String	getAttrMeshName()
String	getAttrMeshOwner()
String	getAttrResourceOwner()
String	getAttrUid()
String	getAttrVirtualGatewayName()
protected Map<String,Object>	getCfnProperties()
String	getGatewayRouteName() `AWS::AppMesh::GatewayRoute.GatewayRouteName`.
String	getMeshName() `AWS::AppMesh::GatewayRoute.MeshName`.
String	getMeshOwner() `AWS::AppMesh::GatewayRoute.MeshOwner`.
Object	getSpec() `AWS::AppMesh::GatewayRoute.Spec`.
TagManager	getTags() `AWS::AppMesh::GatewayRoute.Tags`.
String	getVirtualGatewayName() `AWS::AppMesh::GatewayRoute.VirtualGatewayName`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setGatewayRouteName(String value) `AWS::AppMesh::GatewayRoute.GatewayRouteName`.
void	setMeshName(String value) `AWS::AppMesh::GatewayRoute.MeshName`.
void	setMeshOwner(String value) `AWS::AppMesh::GatewayRoute.MeshOwner`.
void	setSpec(CfnGatewayRoute.GatewayRouteSpecProperty value) `AWS::AppMesh::GatewayRoute.Spec`.
void	setSpec(IResolvable value) `AWS::AppMesh::GatewayRoute.Spec`.
void	setVirtualGatewayName(String value) `AWS::AppMesh::GatewayRoute.VirtualGatewayName`.

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

CfnGatewayRoute

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

CfnGatewayRoute

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

CfnGatewayRoute

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

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

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()

getAttrGatewayRouteName

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

getAttrMeshName

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

getAttrMeshOwner

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

getAttrResourceOwner

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

getAttrUid

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

getAttrVirtualGatewayName

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getGatewayRouteName

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

`AWS::AppMesh::GatewayRoute.GatewayRouteName`.

setGatewayRouteName

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

`AWS::AppMesh::GatewayRoute.GatewayRouteName`.

getMeshName

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

`AWS::AppMesh::GatewayRoute.MeshName`.

setMeshName

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

`AWS::AppMesh::GatewayRoute.MeshName`.

getMeshOwner

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

`AWS::AppMesh::GatewayRoute.MeshOwner`.

setMeshOwner

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

`AWS::AppMesh::GatewayRoute.MeshOwner`.

getSpec

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

`AWS::AppMesh::GatewayRoute.Spec`.

setSpec

@Stability(value=Stable)
public void setSpec(@NotNull
                                             CfnGatewayRoute.GatewayRouteSpecProperty value)

`AWS::AppMesh::GatewayRoute.Spec`.

setSpec

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

`AWS::AppMesh::GatewayRoute.Spec`.

getTags

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

`AWS::AppMesh::GatewayRoute.Tags`.

getVirtualGatewayName

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

`AWS::AppMesh::GatewayRoute.VirtualGatewayName`.

setVirtualGatewayName

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

`AWS::AppMesh::GatewayRoute.VirtualGatewayName`.