GatewayRouteBaseProps Struct
Basic configuration properties for a GatewayRoute.
| Source | aws-appmesh/lib/gateway-route.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,
},
}),
});
python
# gateway: appmesh.VirtualGateway
# virtual_service: appmesh.VirtualService
gateway.add_gateway_route("gateway-route-grpc",
route_spec=appmesh.GatewayRouteSpec.grpc(
route_target=virtual_service,
match=appmesh.GrpcGatewayRouteMatch(
hostname=appmesh.GatewayRouteHostnameMatch.exactly("example.com"),
# This disables the default rewrite to virtual service name and retain original request.
rewrite_request_hostname=False
)
)
)
java
VirtualGateway gateway;
VirtualService virtualService;
gateway.addGatewayRoute("gateway-route-grpc", GatewayRouteBaseProps.builder()
.routeSpec(GatewayRouteSpec.grpc(GrpcGatewayRouteSpecOptions.builder()
.routeTarget(virtualService)
.match(GrpcGatewayRouteMatch.builder()
.hostname(GatewayRouteHostnameMatch.exactly("example.com"))
// This disables the default rewrite to virtual service name and retain original request.
.rewriteRequestHostname(false)
.build())
.build()))
.build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
VirtualGateway gateway;
VirtualService virtualService;
gateway.AddGatewayRoute("gateway-route-grpc", new GatewayRouteBaseProps {
RouteSpec = GatewayRouteSpec.Grpc(new GrpcGatewayRouteSpecOptions {
RouteTarget = virtualService,
Match = new GrpcGatewayRouteMatch {
Hostname = GatewayRouteHostnameMatch.Exactly("example.com"),
// This disables the default rewrite to virtual service name and retain original request.
RewriteRequestHostname = false
}
})
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var gateway VirtualGateway
var virtualService VirtualService
gateway.addGatewayRoute(jsii.String("gateway-route-grpc"), &GatewayRouteBaseProps{
RouteSpec: appmesh.GatewayRouteSpec_Grpc(&GrpcGatewayRouteSpecOptions{
RouteTarget: virtualService,
Match: &GrpcGatewayRouteMatch{
Hostname: appmesh.GatewayRouteHostnameMatch_Exactly(jsii.String("example.com")),
// This disables the default rewrite to virtual service name and retain original request.
RewriteRequestHostname: jsii.Boolean(false),
},
}),
})
Properties
gatewayRouteNameoptionalstringgateway_route_nameoptionalstrgatewayRouteNameoptionalStringGatewayRouteNameoptionalstringGatewayRouteNameoptional*string #The name of the GatewayRoute.
Default: an automatically generated name
routeSpecGatewayRouteSpecroute_specGatewayRouteSpecrouteSpecGatewayRouteSpecRouteSpecGatewayRouteSpecRouteSpecGatewayRouteSpec required #What protocol the route uses.