class RouteSpec

Language	Type name
.NET	Amazon.CDK.AWS.AppMesh.RouteSpec
Java	software.amazon.awscdk.services.appmesh.RouteSpec
Python	aws_cdk.aws_appmesh.RouteSpec
TypeScript (source)	@aws-cdk/aws-appmesh » RouteSpec

Used to generate specs with different protocols for a RouteSpec.

Example

declare const router: appmesh.VirtualRouter;
declare const node: appmesh.VirtualNode;

router.addRoute('route-http2-retry', {
  routeSpec: appmesh.RouteSpec.http2({
    weightedTargets: [{ virtualNode: node }],
    retryPolicy: {
      // Retry if the connection failed
      tcpRetryEvents: [appmesh.TcpRetryEvent.CONNECTION_ERROR],
      // Retry if HTTP responds with a gateway error (502, 503, 504)
      httpRetryEvents: [appmesh.HttpRetryEvent.GATEWAY_ERROR],
      // Retry five times
      retryAttempts: 5,
      // Use a 1 second timeout per retry
      retryTimeout: cdk.Duration.seconds(1),
    },
  }),
});

Initializer

new RouteSpec()

Methods

Name	Description
bind(scope)	Called when the RouteSpec type is initialized.
static grpc(options)	Creates a GRPC Based RouteSpec.
static http(options)	Creates an HTTP Based RouteSpec.
static http2(options)	Creates an HTTP2 Based RouteSpec.
static tcp(options)	Creates a TCP Based RouteSpec.

---

bind(scope)

public bind(scope: Construct): RouteSpecConfig

Parameters

• scope Construct

Returns

• RouteSpecConfig

Called when the RouteSpec type is initialized.

Can be used to enforce mutual exclusivity with future properties

---

static grpc(options)

public static grpc(options: GrpcRouteSpecOptions): RouteSpec

Parameters

• options GrpcRouteSpecOptions

Returns

• RouteSpec

Creates a GRPC Based RouteSpec.

---

static http(options)

public static http(options: HttpRouteSpecOptions): RouteSpec

Parameters

• options HttpRouteSpecOptions

Returns

• RouteSpec

Creates an HTTP Based RouteSpec.

---

static http2(options)

public static http2(options: HttpRouteSpecOptions): RouteSpec

Parameters

• options HttpRouteSpecOptions

Returns

• RouteSpec

Creates an HTTP2 Based RouteSpec.

---

static tcp(options)

public static tcp(options: TcpRouteSpecOptions): RouteSpec

Parameters

• options TcpRouteSpecOptions

Returns

• RouteSpec

Creates a TCP Based RouteSpec.