software.amazon.awscdk.services.appmesh

Class RouteSpec

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appmesh.RouteSpec

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:48.644Z")
public abstract class RouteSpec
extends software.amazon.jsii.JsiiObject

Used to generate specs with different protocols for a RouteSpec.

Example:

 VirtualRouter router;
 VirtualNode node;
 router.addRoute("route-http2-retry", RouteBaseProps.builder()
         .routeSpec(RouteSpec.http2(HttpRouteSpecOptions.builder()
                 .weightedTargets(List.of(WeightedTarget.builder().virtualNode(node).build()))
                 .retryPolicy(HttpRetryPolicy.builder()
                         // Retry if the connection failed
                         .tcpRetryEvents(List.of(TcpRetryEvent.CONNECTION_ERROR))
                         // Retry if HTTP responds with a gateway error (502, 503, 504)
                         .httpRetryEvents(List.of(HttpRetryEvent.GATEWAY_ERROR))
                         // Retry five times
                         .retryAttempts(5)
                         // Use a 1 second timeout per retry
                         .retryTimeout(Duration.seconds(1))
                         .build())
                 .build()))
         .build());
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RouteSpec()
protected	RouteSpec(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	RouteSpec(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
abstract RouteSpecConfig	bind(Construct scope) Called when the RouteSpec type is initialized.
static RouteSpec	grpc(GrpcRouteSpecOptions options) Creates a GRPC Based RouteSpec.
static RouteSpec	http(HttpRouteSpecOptions options) Creates an HTTP Based RouteSpec.
static RouteSpec	http2(HttpRouteSpecOptions options) Creates an HTTP2 Based RouteSpec.
static RouteSpec	tcp(TcpRouteSpecOptions options) Creates a TCP Based RouteSpec.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RouteSpec

protected RouteSpec(software.amazon.jsii.JsiiObjectRef objRef)

RouteSpec

protected RouteSpec(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

RouteSpec

protected RouteSpec()

Method Detail

grpc

public static RouteSpec grpc(GrpcRouteSpecOptions options)

Creates a GRPC Based RouteSpec.

Parameters:

options - This parameter is required.

http

public static RouteSpec http(HttpRouteSpecOptions options)

Creates an HTTP Based RouteSpec.

Parameters:

options - This parameter is required.

http2

public static RouteSpec http2(HttpRouteSpecOptions options)

Creates an HTTP2 Based RouteSpec.

Parameters:

options - This parameter is required.

tcp

public static RouteSpec tcp(TcpRouteSpecOptions options)

Creates a TCP Based RouteSpec.

Parameters:

options - This parameter is required.

bind

public abstract RouteSpecConfig bind(Construct scope)

Called when the RouteSpec type is initialized.

Can be used to enforce mutual exclusivity with future properties

Parameters:

scope - This parameter is required.