Package software.amazon.awscdk.services.appmesh

Interface GatewayRouteSpecConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GatewayRouteSpecConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:46.056Z")
@Stability(Stable)
public interface GatewayRouteSpecConfig
extends software.amazon.jsii.JsiiSerializable

All Properties for GatewayRoute Specs.

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.*;
 GatewayRouteSpecConfig gatewayRouteSpecConfig = GatewayRouteSpecConfig.builder()
         .grpcSpecConfig(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())
         .http2SpecConfig(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())
         .httpSpecConfig(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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static GatewayRouteSpecConfig.Builder	builder()
default CfnGatewayRoute.GrpcGatewayRouteProperty	getGrpcSpecConfig()	The spec for a grpc gateway route.
default CfnGatewayRoute.HttpGatewayRouteProperty	getHttp2SpecConfig()	The spec for an http2 gateway route.
default CfnGatewayRoute.HttpGatewayRouteProperty	getHttpSpecConfig()	The spec for an http gateway route.
default Number	getPriority()	The priority for the gateway route.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGrpcSpecConfig

@Stability(Stable)
@Nullable
default CfnGatewayRoute.GrpcGatewayRouteProperty getGrpcSpecConfig()

The spec for a grpc gateway route.

Default: - no grpc spec

getHttp2SpecConfig

@Stability(Stable)
@Nullable
default CfnGatewayRoute.HttpGatewayRouteProperty getHttp2SpecConfig()

The spec for an http2 gateway route.

Default: - no http2 spec

getHttpSpecConfig

@Stability(Stable)
@Nullable
default CfnGatewayRoute.HttpGatewayRouteProperty getHttpSpecConfig()

The spec for an http gateway route.

Default: - no http spec

getPriority

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

The priority for the gateway route.

When a Virtual Gateway has multiple gateway routes, gateway route match is performed in the order of specified value, where 0 is the highest priority, and first matched gateway route is selected.

Default: - no particular priority

builder

@Stability(Stable)
static GatewayRouteSpecConfig.Builder builder()

Returns:

a GatewayRouteSpecConfig.Builder of GatewayRouteSpecConfig