All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnGatewayRouteProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-12-17T21:37:26.114Z") @Stability(Stable) public interface CfnGatewayRouteProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnGatewayRoute.

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.*;
 CfnGatewayRouteProps cfnGatewayRouteProps = CfnGatewayRouteProps.builder()
         .meshName("meshName")
         .spec(GatewayRouteSpecProperty.builder()
                 .grpcRoute(GrpcGatewayRouteProperty.builder()
                         .action(GrpcGatewayRouteActionProperty.builder()
                                 .target(GatewayRouteTargetProperty.builder()
                                         .virtualService(GatewayRouteVirtualServiceProperty.builder()
                                                 .virtualServiceName("virtualServiceName")
                                                 .build())
                                         // the properties below are optional
                                         .port(123)
                                         .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()))
                                 .port(123)
                                 .serviceName("serviceName")
                                 .build())
                         .build())
                 .http2Route(HttpGatewayRouteProperty.builder()
                         .action(HttpGatewayRouteActionProperty.builder()
                                 .target(GatewayRouteTargetProperty.builder()
                                         .virtualService(GatewayRouteVirtualServiceProperty.builder()
                                                 .virtualServiceName("virtualServiceName")
                                                 .build())
                                         // the properties below are optional
                                         .port(123)
                                         .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())
                                 .port(123)
                                 .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())
                                         // the properties below are optional
                                         .port(123)
                                         .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())
                                 .port(123)
                                 .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();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnGatewayRouteProps.Builder

A builder for CfnGatewayRouteProps

static final class

CfnGatewayRouteProps.Jsii$Proxy

An implementation for CfnGatewayRouteProps
Method Summary

Modifier and Type

Method

Description

static CfnGatewayRouteProps.Builder

builder()

default String

getGatewayRouteName()

The name of the gateway route.

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.

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.

String

getVirtualGatewayName()

The virtual gateway that the gateway route is associated with.

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

Method Details
- getMeshName
  
  @Stability(Stable) @NotNull 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
- getSpec
  
  @Stability(Stable) @NotNull Object getSpec()
  
  The specifications of the gateway route.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-gatewayroute.html#cfn-appmesh-gatewayroute-spec
- getVirtualGatewayName
  
  @Stability(Stable) @NotNull 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
- 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
- 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
- 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
- builder
  
  @Stability(Stable) static CfnGatewayRouteProps.Builder builder()
  
  Returns:
  
  a CfnGatewayRouteProps.Builder of CfnGatewayRouteProps

Interface CfnGatewayRouteProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getMeshName

getSpec

getVirtualGatewayName

getGatewayRouteName

getMeshOwner

getTags

builder