AWS CDK Reference

Appearance

v2.274.0

GatewayRouteSpec Class ​

Used to generate specs with different protocols for a GatewayRoute.

Source
aws-appmesh/lib/gateway-route-spec.ts

Example ​

ts
declare const gateway: appmesh.VirtualGateway;
declare const virtualService: appmesh.VirtualService;

gateway.addGatewayRoute('gateway-route-grpc', {
  routeSpec: appmesh.GatewayRouteSpec.grpc({
    routeTarget: virtualService,
    match: {
      hostname: appmesh.GatewayRouteHostnameMatch.exactly('example.com'),
      // This disables the default rewrite to virtual service name and retain original request.
      rewriteRequestHostname: false,
    },
  }),
});

Initializer ​

ts
new GatewayRouteSpec()
python
GatewayRouteSpec()
java
new GatewayRouteSpec()
csharp
new GatewayRouteSpec()
go
NewGatewayRouteSpec()

Methods ​

bind(scope: Construct): GatewayRouteSpecConfigdef bind(self, scope: Construct) -> GatewayRouteSpecConfigpublic GatewayRouteSpecConfig bind(Construct scope)public GatewayRouteSpecConfig Bind(Construct scope)func Bind(Scope Construct) GatewayRouteSpecConfig#
Called when the GatewayRouteSpec type is initialized.

Can be used to enforce mutual exclusivity with future properties

grpc(options: GrpcGatewayRouteSpecOptions): GatewayRouteSpec // chainable@staticmethod def grpc(options: GrpcGatewayRouteSpecOptions) -> GatewayRouteSpecpublic static GatewayRouteSpec grpc(GrpcGatewayRouteSpecOptions options)public static GatewayRouteSpec Grpc(GrpcGatewayRouteSpecOptions options)func Grpc(Options GrpcGatewayRouteSpecOptions) GatewayRouteSpecstatic#
Creates an gRPC Based GatewayRoute.
1 parameter

Parameters

  • optionsoptionsoptionsoptionsOptions — - no grpc gateway route.
http(options: HttpGatewayRouteSpecOptions): GatewayRouteSpec // chainable@staticmethod def http(options: HttpGatewayRouteSpecOptions) -> GatewayRouteSpecpublic static GatewayRouteSpec http(HttpGatewayRouteSpecOptions options)public static GatewayRouteSpec Http(HttpGatewayRouteSpecOptions options)func Http(Options HttpGatewayRouteSpecOptions) GatewayRouteSpecstatic#
Creates an HTTP Based GatewayRoute.
1 parameter

Parameters

  • optionsoptionsoptionsoptionsOptions — - no http gateway route.
http2(options: HttpGatewayRouteSpecOptions): GatewayRouteSpec // chainable@staticmethod def http2(options: HttpGatewayRouteSpecOptions) -> GatewayRouteSpecpublic static GatewayRouteSpec http2(HttpGatewayRouteSpecOptions options)public static GatewayRouteSpec Http2(HttpGatewayRouteSpecOptions options)func Http2(Options HttpGatewayRouteSpecOptions) GatewayRouteSpecstatic#
Creates an HTTP2 Based GatewayRoute.
1 parameter

Parameters

  • optionsoptionsoptionsoptionsOptions — - no http2 gateway route.