software.amazon.awscdk.services.appmesh

Interface CfnGatewayRoute.GatewayRouteSpecProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGatewayRoute.GatewayRouteSpecProperty.Jsii$Proxy

Enclosing class:

CfnGatewayRoute

@Stability(value=Stable)
public static interface CfnGatewayRoute.GatewayRouteSpecProperty
extends software.amazon.jsii.JsiiSerializable

An object that represents a gateway route specification.

Specify one gateway route type.

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.*;
 GatewayRouteSpecProperty gatewayRouteSpecProperty = 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnGatewayRoute.GatewayRouteSpecProperty.Builder A builder for CfnGatewayRoute.GatewayRouteSpecProperty
static class	CfnGatewayRoute.GatewayRouteSpecProperty.Jsii$Proxy An implementation for CfnGatewayRoute.GatewayRouteSpecProperty

Method Summary

Modifier and Type	Method and Description
static CfnGatewayRoute.GatewayRouteSpecProperty.Builder	builder()
default Object	getGrpcRoute() An object that represents the specification of a gRPC gateway route.
default Object	getHttp2Route() An object that represents the specification of an HTTP/2 gateway route.
default Object	getHttpRoute() An object that represents the specification of an HTTP gateway route.
default Number	getPriority() The ordering of the gateway routes spec.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getGrpcRoute

@Stability(value=Stable)
 @Nullable
default Object getGrpcRoute()

An object that represents the specification of a gRPC gateway route.

getHttp2Route

@Stability(value=Stable)
 @Nullable
default Object getHttp2Route()

An object that represents the specification of an HTTP/2 gateway route.

getHttpRoute

@Stability(value=Stable)
 @Nullable
default Object getHttpRoute()

An object that represents the specification of an HTTP gateway route.

getPriority

@Stability(value=Stable)
 @Nullable
default Number getPriority()

The ordering of the gateway routes spec.

builder

@Stability(value=Stable)
static CfnGatewayRoute.GatewayRouteSpecProperty.Builder builder()

Returns:

a CfnGatewayRoute.GatewayRouteSpecProperty.Builder of CfnGatewayRoute.GatewayRouteSpecProperty