All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnGatewayRouteMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:55.766Z") @Stability(Stable) public interface CfnGatewayRouteMixinProps extends software.amazon.jsii.JsiiSerializable

Properties for CfnGatewayRoutePropsMixin.

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.*;
 CfnGatewayRouteMixinProps cfnGatewayRouteMixinProps = 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();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnGatewayRouteMixinProps.Builder

A builder for CfnGatewayRouteMixinProps

static final class

CfnGatewayRouteMixinProps.Jsii$Proxy

An implementation for CfnGatewayRouteMixinProps
Method Summary

Modifier and Type

Method

Description

static CfnGatewayRouteMixinProps.Builder

builder()

default String

getGatewayRouteName()

The name of the gateway route.

default String

getMeshName()

The name of the service mesh that the resource resides in.

default String

getMeshOwner()

The AWS IAM account ID of the service mesh owner.

default Object

getSpec()

The specifications of the gateway route.

default List<CfnTag>

getTags()

Optional metadata that you can apply to the gateway route to assist with categorization and organization.

default String

getVirtualGatewayName()

The virtual gateway that the gateway route is associated with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getGatewayRouteName
  
  @Stability(Stable) @Nullable default String getGatewayRouteName()
  
  The name of the gateway route.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-gatewayroutename
- getMeshName
  
  @Stability(Stable) @Nullable default String getMeshName()
  
  The name of the service mesh that the resource resides in.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshname
- getMeshOwner
  
  @Stability(Stable) @Nullable default String getMeshOwner()
  
  The AWS IAM account ID of the service mesh owner.
  If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-meshowner
- getSpec
  
  @Stability(Stable) @Nullable default Object getSpec()
  
  The specifications of the gateway route.
  Returns union: either IResolvable or CfnGatewayRoutePropsMixin.GatewayRouteSpecProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-spec
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  Optional metadata that you can apply to the gateway route to assist with categorization and organization.
  Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-tags
- getVirtualGatewayName
  
  @Stability(Stable) @Nullable default String getVirtualGatewayName()
  
  The virtual gateway that the gateway route is associated with.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-virtualgatewayname
- builder
  
  @Stability(Stable) static CfnGatewayRouteMixinProps.Builder builder()
  
  Returns:
  
  a CfnGatewayRouteMixinProps.Builder of CfnGatewayRouteMixinProps

Interface CfnGatewayRouteMixinProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getGatewayRouteName

getMeshName

getMeshOwner

getSpec

getTags

getVirtualGatewayName

builder