RouteSpecConfig (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: RouteSpecConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.572Z")
 @Stability(value=Stable)
public interface RouteSpecConfig
extends software.amazon.jsii.JsiiSerializable

All Properties for Route 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.*;
 RouteSpecConfig routeSpecConfig = RouteSpecConfig.builder()
         .grpcRouteSpec(GrpcRouteProperty.builder()
                 .action(GrpcRouteActionProperty.builder()
                         .weightedTargets(List.of(WeightedTargetProperty.builder()
                                 .virtualNode("virtualNode")
                                 .weight(123)
                                 // the properties below are optional
                                 .port(123)
                                 .build()))
                         .build())
                 .match(GrpcRouteMatchProperty.builder()
                         .metadata(List.of(GrpcRouteMetadataProperty.builder()
                                 .name("name")
                                 // the properties below are optional
                                 .invert(false)
                                 .match(GrpcRouteMetadataMatchMethodProperty.builder()
                                         .exact("exact")
                                         .prefix("prefix")
                                         .range(MatchRangeProperty.builder()
                                                 .end(123)
                                                 .start(123)
                                                 .build())
                                         .regex("regex")
                                         .suffix("suffix")
                                         .build())
                                 .build()))
                         .methodName("methodName")
                         .port(123)
                         .serviceName("serviceName")
                         .build())
                 // the properties below are optional
                 .retryPolicy(GrpcRetryPolicyProperty.builder()
                         .maxRetries(123)
                         .perRetryTimeout(DurationProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         // the properties below are optional
                         .grpcRetryEvents(List.of("grpcRetryEvents"))
                         .httpRetryEvents(List.of("httpRetryEvents"))
                         .tcpRetryEvents(List.of("tcpRetryEvents"))
                         .build())
                 .timeout(GrpcTimeoutProperty.builder()
                         .idle(DurationProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .perRequest(DurationProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .build())
                 .build())
         .http2RouteSpec(HttpRouteProperty.builder()
                 .action(HttpRouteActionProperty.builder()
                         .weightedTargets(List.of(WeightedTargetProperty.builder()
                                 .virtualNode("virtualNode")
                                 .weight(123)
                                 // the properties below are optional
                                 .port(123)
                                 .build()))
                         .build())
                 .match(HttpRouteMatchProperty.builder()
                         .headers(List.of(HttpRouteHeaderProperty.builder()
                                 .name("name")
                                 // the properties below are optional
                                 .invert(false)
                                 .match(HeaderMatchMethodProperty.builder()
                                         .exact("exact")
                                         .prefix("prefix")
                                         .range(MatchRangeProperty.builder()
                                                 .end(123)
                                                 .start(123)
                                                 .build())
                                         .regex("regex")
                                         .suffix("suffix")
                                         .build())
                                 .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()))
                         .scheme("scheme")
                         .build())
                 // the properties below are optional
                 .retryPolicy(HttpRetryPolicyProperty.builder()
                         .maxRetries(123)
                         .perRetryTimeout(DurationProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         // the properties below are optional
                         .httpRetryEvents(List.of("httpRetryEvents"))
                         .tcpRetryEvents(List.of("tcpRetryEvents"))
                         .build())
                 .timeout(HttpTimeoutProperty.builder()
                         .idle(DurationProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .perRequest(DurationProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .build())
                 .build())
         .httpRouteSpec(HttpRouteProperty.builder()
                 .action(HttpRouteActionProperty.builder()
                         .weightedTargets(List.of(WeightedTargetProperty.builder()
                                 .virtualNode("virtualNode")
                                 .weight(123)
                                 // the properties below are optional
                                 .port(123)
                                 .build()))
                         .build())
                 .match(HttpRouteMatchProperty.builder()
                         .headers(List.of(HttpRouteHeaderProperty.builder()
                                 .name("name")
                                 // the properties below are optional
                                 .invert(false)
                                 .match(HeaderMatchMethodProperty.builder()
                                         .exact("exact")
                                         .prefix("prefix")
                                         .range(MatchRangeProperty.builder()
                                                 .end(123)
                                                 .start(123)
                                                 .build())
                                         .regex("regex")
                                         .suffix("suffix")
                                         .build())
                                 .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()))
                         .scheme("scheme")
                         .build())
                 // the properties below are optional
                 .retryPolicy(HttpRetryPolicyProperty.builder()
                         .maxRetries(123)
                         .perRetryTimeout(DurationProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         // the properties below are optional
                         .httpRetryEvents(List.of("httpRetryEvents"))
                         .tcpRetryEvents(List.of("tcpRetryEvents"))
                         .build())
                 .timeout(HttpTimeoutProperty.builder()
                         .idle(DurationProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .perRequest(DurationProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .build())
                 .build())
         .priority(123)
         .tcpRouteSpec(TcpRouteProperty.builder()
                 .action(TcpRouteActionProperty.builder()
                         .weightedTargets(List.of(WeightedTargetProperty.builder()
                                 .virtualNode("virtualNode")
                                 .weight(123)
                                 // the properties below are optional
                                 .port(123)
                                 .build()))
                         .build())
                 // the properties below are optional
                 .match(TcpRouteMatchProperty.builder()
                         .port(123)
                         .build())
                 .timeout(TcpTimeoutProperty.builder()
                         .idle(DurationProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .build())
                 .build())
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`RouteSpecConfig.Builder` A builder for `RouteSpecConfig`
`static class`	`RouteSpecConfig.Jsii$Proxy` An implementation for `RouteSpecConfig`

Method Summary

All Methods Static Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`static RouteSpecConfig.Builder`	`builder()`
`default CfnRoute.GrpcRouteProperty`	`getGrpcRouteSpec()` The spec for a grpc route.
`default CfnRoute.HttpRouteProperty`	`getHttp2RouteSpec()` The spec for an http2 route.
`default CfnRoute.HttpRouteProperty`	`getHttpRouteSpec()` The spec for an http route.
`default Number`	`getPriority()` The priority for the route.
`default CfnRoute.TcpRouteProperty`	`getTcpRouteSpec()` The spec for a tcp route.

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

- Method Detail
  - getGrpcRouteSpec
```
@Stability(value=Stable)
 @Nullable
default CfnRoute.GrpcRouteProperty getGrpcRouteSpec()
```
    The spec for a grpc route.
    Default: - no grpc spec
  - getHttp2RouteSpec
```
@Stability(value=Stable)
 @Nullable
default CfnRoute.HttpRouteProperty getHttp2RouteSpec()
```
    The spec for an http2 route.
    Default: - no http2 spec
  - getHttpRouteSpec
```
@Stability(value=Stable)
 @Nullable
default CfnRoute.HttpRouteProperty getHttpRouteSpec()
```
    The spec for an http route.
    Default: - no http spec
  - getPriority
```
@Stability(value=Stable)
 @Nullable
default Number getPriority()
```
    The priority for the route.
    When a Virtual Router has multiple routes, route match is performed in the order of specified value, where 0 is the highest priority, and first matched route is selected.
    Default: - no particular priority
  - getTcpRouteSpec
```
@Stability(value=Stable)
 @Nullable
default CfnRoute.TcpRouteProperty getTcpRouteSpec()
```
    The spec for a tcp route.
    Default: - no tcp spec
  - builder
```
@Stability(value=Stable)
static RouteSpecConfig.Builder builder()
```
    Returns:
    
    a RouteSpecConfig.Builder of RouteSpecConfig

Interface RouteSpecConfig

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getGrpcRouteSpec

getHttp2RouteSpec

getHttpRouteSpec

getPriority

getTcpRouteSpec

builder