Package software.amazon.awscdk.cfnpropertymixins.services.appmesh

Class CfnGatewayRoutePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.appmesh.CfnGatewayRoutePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.768Z")
@Stability(Stable)
public class CfnGatewayRoutePropsMixin
extends Mixin
implements software.constructs.IMixin

Creates a gateway route.

A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service.

For more information about gateway routes, see Gateway routes .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.appmesh.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnGatewayRoutePropsMixin cfnGatewayRoutePropsMixin = CfnGatewayRoutePropsMixin.Builder.create(CfnGatewayRouteMixinProps.builder()
         .gatewayRouteName("gatewayRouteName")
         .meshName("meshName")
         .meshOwner("meshOwner")
         .spec(GatewayRouteSpecProperty.builder()
                 .grpcRoute(GrpcGatewayRouteProperty.builder()
                         .action(GrpcGatewayRouteActionProperty.builder()
                                 .rewrite(GrpcGatewayRouteRewriteProperty.builder()
                                         .hostname(GatewayRouteHostnameRewriteProperty.builder()
                                                 .defaultTargetHostname("defaultTargetHostname")
                                                 .build())
                                         .build())
                                 .target(GatewayRouteTargetProperty.builder()
                                         .port(123)
                                         .virtualService(GatewayRouteVirtualServiceProperty.builder()
                                                 .virtualServiceName("virtualServiceName")
                                                 .build())
                                         .build())
                                 .build())
                         .match(GrpcGatewayRouteMatchProperty.builder()
                                 .hostname(GatewayRouteHostnameMatchProperty.builder()
                                         .exact("exact")
                                         .suffix("suffix")
                                         .build())
                                 .metadata(List.of(GrpcGatewayRouteMetadataProperty.builder()
                                         .invert(false)
                                         .match(GatewayRouteMetadataMatchProperty.builder()
                                                 .exact("exact")
                                                 .prefix("prefix")
                                                 .range(GatewayRouteRangeMatchProperty.builder()
                                                         .end(123)
                                                         .start(123)
                                                         .build())
                                                 .regex("regex")
                                                 .suffix("suffix")
                                                 .build())
                                         .name("name")
                                         .build()))
                                 .port(123)
                                 .serviceName("serviceName")
                                 .build())
                         .build())
                 .http2Route(HttpGatewayRouteProperty.builder()
                         .action(HttpGatewayRouteActionProperty.builder()
                                 .rewrite(HttpGatewayRouteRewriteProperty.builder()
                                         .hostname(GatewayRouteHostnameRewriteProperty.builder()
                                                 .defaultTargetHostname("defaultTargetHostname")
                                                 .build())
                                         .path(HttpGatewayRoutePathRewriteProperty.builder()
                                                 .exact("exact")
                                                 .build())
                                         .prefix(HttpGatewayRoutePrefixRewriteProperty.builder()
                                                 .defaultPrefix("defaultPrefix")
                                                 .value("value")
                                                 .build())
                                         .build())
                                 .target(GatewayRouteTargetProperty.builder()
                                         .port(123)
                                         .virtualService(GatewayRouteVirtualServiceProperty.builder()
                                                 .virtualServiceName("virtualServiceName")
                                                 .build())
                                         .build())
                                 .build())
                         .match(HttpGatewayRouteMatchProperty.builder()
                                 .headers(List.of(HttpGatewayRouteHeaderProperty.builder()
                                         .invert(false)
                                         .match(HttpGatewayRouteHeaderMatchProperty.builder()
                                                 .exact("exact")
                                                 .prefix("prefix")
                                                 .range(GatewayRouteRangeMatchProperty.builder()
                                                         .end(123)
                                                         .start(123)
                                                         .build())
                                                 .regex("regex")
                                                 .suffix("suffix")
                                                 .build())
                                         .name("name")
                                         .build()))
                                 .hostname(GatewayRouteHostnameMatchProperty.builder()
                                         .exact("exact")
                                         .suffix("suffix")
                                         .build())
                                 .method("method")
                                 .path(HttpPathMatchProperty.builder()
                                         .exact("exact")
                                         .regex("regex")
                                         .build())
                                 .port(123)
                                 .prefix("prefix")
                                 .queryParameters(List.of(QueryParameterProperty.builder()
                                         .match(HttpQueryParameterMatchProperty.builder()
                                                 .exact("exact")
                                                 .build())
                                         .name("name")
                                         .build()))
                                 .build())
                         .build())
                 .httpRoute(HttpGatewayRouteProperty.builder()
                         .action(HttpGatewayRouteActionProperty.builder()
                                 .rewrite(HttpGatewayRouteRewriteProperty.builder()
                                         .hostname(GatewayRouteHostnameRewriteProperty.builder()
                                                 .defaultTargetHostname("defaultTargetHostname")
                                                 .build())
                                         .path(HttpGatewayRoutePathRewriteProperty.builder()
                                                 .exact("exact")
                                                 .build())
                                         .prefix(HttpGatewayRoutePrefixRewriteProperty.builder()
                                                 .defaultPrefix("defaultPrefix")
                                                 .value("value")
                                                 .build())
                                         .build())
                                 .target(GatewayRouteTargetProperty.builder()
                                         .port(123)
                                         .virtualService(GatewayRouteVirtualServiceProperty.builder()
                                                 .virtualServiceName("virtualServiceName")
                                                 .build())
                                         .build())
                                 .build())
                         .match(HttpGatewayRouteMatchProperty.builder()
                                 .headers(List.of(HttpGatewayRouteHeaderProperty.builder()
                                         .invert(false)
                                         .match(HttpGatewayRouteHeaderMatchProperty.builder()
                                                 .exact("exact")
                                                 .prefix("prefix")
                                                 .range(GatewayRouteRangeMatchProperty.builder()
                                                         .end(123)
                                                         .start(123)
                                                         .build())
                                                 .regex("regex")
                                                 .suffix("suffix")
                                                 .build())
                                         .name("name")
                                         .build()))
                                 .hostname(GatewayRouteHostnameMatchProperty.builder()
                                         .exact("exact")
                                         .suffix("suffix")
                                         .build())
                                 .method("method")
                                 .path(HttpPathMatchProperty.builder()
                                         .exact("exact")
                                         .regex("regex")
                                         .build())
                                 .port(123)
                                 .prefix("prefix")
                                 .queryParameters(List.of(QueryParameterProperty.builder()
                                         .match(HttpQueryParameterMatchProperty.builder()
                                                 .exact("exact")
                                                 .build())
                                         .name("name")
                                         .build()))
                                 .build())
                         .build())
                 .priority(123)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .virtualGatewayName("virtualGatewayName")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnGatewayRoutePropsMixin.Builder	A fluent builder for CfnGatewayRoutePropsMixin.
static interface	CfnGatewayRoutePropsMixin.GatewayRouteHostnameMatchProperty	An object representing the gateway route host name to match.
static interface	CfnGatewayRoutePropsMixin.GatewayRouteHostnameRewriteProperty	An object representing the gateway route host name to rewrite.
static interface	CfnGatewayRoutePropsMixin.GatewayRouteMetadataMatchProperty	An object representing the method header to be matched.
static interface	CfnGatewayRoutePropsMixin.GatewayRouteRangeMatchProperty	An object that represents the range of values to match on.
static interface	CfnGatewayRoutePropsMixin.GatewayRouteSpecProperty	An object that represents a gateway route specification.
static interface	CfnGatewayRoutePropsMixin.GatewayRouteTargetProperty	An object that represents a gateway route target.
static interface	CfnGatewayRoutePropsMixin.GatewayRouteVirtualServiceProperty	An object that represents the virtual service that traffic is routed to.
static interface	CfnGatewayRoutePropsMixin.GrpcGatewayRouteActionProperty	An object that represents the action to take if a match is determined.
static interface	CfnGatewayRoutePropsMixin.GrpcGatewayRouteMatchProperty	An object that represents the criteria for determining a request match.
static interface	CfnGatewayRoutePropsMixin.GrpcGatewayRouteMetadataProperty	An object representing the metadata of the gateway route.
static interface	CfnGatewayRoutePropsMixin.GrpcGatewayRouteProperty	An object that represents a gRPC gateway route.
static interface	CfnGatewayRoutePropsMixin.GrpcGatewayRouteRewriteProperty	An object that represents the gateway route to rewrite.
static interface	CfnGatewayRoutePropsMixin.HttpGatewayRouteActionProperty	An object that represents the action to take if a match is determined.
static interface	CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderMatchProperty	An object that represents the method and value to match with the header value sent in a request.
static interface	CfnGatewayRoutePropsMixin.HttpGatewayRouteHeaderProperty	An object that represents the HTTP header in the gateway route.
static interface	CfnGatewayRoutePropsMixin.HttpGatewayRouteMatchProperty	An object that represents the criteria for determining a request match.
static interface	CfnGatewayRoutePropsMixin.HttpGatewayRoutePathRewriteProperty	An object that represents the path to rewrite.
static interface	CfnGatewayRoutePropsMixin.HttpGatewayRoutePrefixRewriteProperty	An object representing the beginning characters of the route to rewrite.
static interface	CfnGatewayRoutePropsMixin.HttpGatewayRouteProperty	An object that represents an HTTP gateway route.
static interface	CfnGatewayRoutePropsMixin.HttpGatewayRouteRewriteProperty	An object representing the gateway route to rewrite.
static interface	CfnGatewayRoutePropsMixin.HttpPathMatchProperty	An object representing the path to match in the request.
static interface	CfnGatewayRoutePropsMixin.HttpQueryParameterMatchProperty	An object representing the query parameter to match.
static interface	CfnGatewayRoutePropsMixin.QueryParameterProperty	An object that represents the query parameter in the request.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnGatewayRoutePropsMixin(CfnGatewayRouteMixinProps props)	Create a mixin to apply properties to AWS::AppMesh::GatewayRoute.
	CfnGatewayRoutePropsMixin(CfnGatewayRouteMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::AppMesh::GatewayRoute.
protected	CfnGatewayRoutePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnGatewayRoutePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnGatewayRouteMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnGatewayRoutePropsMixin

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

CfnGatewayRoutePropsMixin

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

CfnGatewayRoutePropsMixin

@Stability(Stable)
public CfnGatewayRoutePropsMixin(@NotNull
 CfnGatewayRouteMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::AppMesh::GatewayRoute.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnGatewayRoutePropsMixin

@Stability(Stable)
public CfnGatewayRoutePropsMixin(@NotNull
 CfnGatewayRouteMixinProps props)

Create a mixin to apply properties to AWS::AppMesh::GatewayRoute.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnGatewayRouteMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()