Class GatewayRouteSpec

Used to generate specs with different protocols for a GatewayRoute.

Inheritance

System.Object

GatewayRouteSpec

Namespace: Amazon.CDK.AWS.AppMesh

Assembly: Amazon.CDK.AWS.AppMesh.dll

Syntax (csharp)

public abstract class GatewayRouteSpec : DeputyBase

Syntax (vb)

Public MustInherit Class GatewayRouteSpec
    Inherits DeputyBase

Remarks

ExampleMetadata: infused

Examples

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
        }
    })
});

Synopsis

Constructors

GatewayRouteSpec()
GatewayRouteSpec(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
GatewayRouteSpec(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Methods

Bind(Construct)	Called when the GatewayRouteSpec type is initialized.
Grpc(IGrpcGatewayRouteSpecOptions)	Creates an gRPC Based GatewayRoute.
Http(IHttpGatewayRouteSpecOptions)	Creates an HTTP Based GatewayRoute.
Http2(IHttpGatewayRouteSpecOptions)	Creates an HTTP2 Based GatewayRoute.

Constructors

GatewayRouteSpec()

protected GatewayRouteSpec()

GatewayRouteSpec(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected GatewayRouteSpec(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

GatewayRouteSpec(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected GatewayRouteSpec(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Methods

Bind(Construct)

Called when the GatewayRouteSpec type is initialized.

public abstract IGatewayRouteSpecConfig Bind(Construct scope)

Parameters

scope Construct

Returns

IGatewayRouteSpecConfig

Remarks

Can be used to enforce mutual exclusivity with future properties

Grpc(IGrpcGatewayRouteSpecOptions)

Creates an gRPC Based GatewayRoute.

public static GatewayRouteSpec Grpc(IGrpcGatewayRouteSpecOptions options)

Parameters

options IGrpcGatewayRouteSpecOptions

no grpc gateway route.

Returns

GatewayRouteSpec

Http(IHttpGatewayRouteSpecOptions)

Creates an HTTP Based GatewayRoute.

public static GatewayRouteSpec Http(IHttpGatewayRouteSpecOptions options)

Parameters

options IHttpGatewayRouteSpecOptions

no http gateway route.

Returns

GatewayRouteSpec

Http2(IHttpGatewayRouteSpecOptions)

Creates an HTTP2 Based GatewayRoute.

public static GatewayRouteSpec Http2(IHttpGatewayRouteSpecOptions options)

Parameters

options IHttpGatewayRouteSpecOptions

no http2 gateway route.

Returns

GatewayRouteSpec