Class GatewayRoute

GatewayRoute represents a new or existing gateway route attached to a VirtualGateway and Mesh.

Inheritance

object

Resource

GatewayRoute

Implements

IGatewayRoute

IResource

IGatewayRouteRef

IConstruct

IDependable

IEnvironmentAware

Inherited Members

Resource.IsOwnedResource(IConstruct)

Resource.IsResource(IConstruct)

Resource.ApplyRemovalPolicy(RemovalPolicy)

Resource.GeneratePhysicalName()

Resource.GetResourceArnAttribute(string, IArnComponents)

Resource.GetResourceNameAttribute(string)

Resource.With(params IMixin[])

Resource.Env

Resource.PhysicalName

Resource.Stack

Namespace: Amazon.CDK.AWS.AppMesh

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class GatewayRoute : Resource, IGatewayRoute, IResource, IGatewayRouteRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Class GatewayRoute Inherits Resource Implements IGatewayRoute, IResource, IGatewayRouteRef, IConstruct, IDependable, IEnvironmentAware

Remarks

See: https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppMesh;

             GatewayRouteSpec gatewayRouteSpec;
             VirtualGateway virtualGateway;

             var gatewayRoute = new GatewayRoute(this, "MyGatewayRoute", new GatewayRouteProps {
                 RouteSpec = gatewayRouteSpec,
                 VirtualGateway = virtualGateway,

                 // the properties below are optional
                 GatewayRouteName = "gatewayRouteName"
             });

Synopsis

Constructors

GatewayRoute(Construct, string, IGatewayRouteProps)

GatewayRoute represents a new or existing gateway route attached to a VirtualGateway and Mesh.

Properties

GatewayRouteArn	The Amazon Resource Name (ARN) for the GatewayRoute.
GatewayRouteName	The name of the GatewayRoute.
GatewayRouteRef	A reference to a GatewayRoute resource.
PROPERTY_INJECTION_ID	Uniquely identifies this class.
VirtualGateway	The VirtualGateway this GatewayRoute is a part of.

Methods

FromGatewayRouteArn(Construct, string, string)	Import an existing GatewayRoute given an ARN.
FromGatewayRouteAttributes(Construct, string, IGatewayRouteAttributes)	Import an existing GatewayRoute given attributes.

Constructors

GatewayRoute(Construct, string, IGatewayRouteProps)

GatewayRoute represents a new or existing gateway route attached to a VirtualGateway and Mesh.

public GatewayRoute(Construct scope, string id, IGatewayRouteProps props)

Parameters

scope Construct

id string

props IGatewayRouteProps

Remarks

See: https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppMesh;

             GatewayRouteSpec gatewayRouteSpec;
             VirtualGateway virtualGateway;

             var gatewayRoute = new GatewayRoute(this, "MyGatewayRoute", new GatewayRouteProps {
                 RouteSpec = gatewayRouteSpec,
                 VirtualGateway = virtualGateway,

                 // the properties below are optional
                 GatewayRouteName = "gatewayRouteName"
             });

Properties

GatewayRouteArn

The Amazon Resource Name (ARN) for the GatewayRoute.

public virtual string GatewayRouteArn { get; }

Property Value

string

Remarks

See: https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html

ExampleMetadata: fixture=_generated

GatewayRouteName

The name of the GatewayRoute.

public virtual string GatewayRouteName { get; }

Property Value

string

Remarks

See: https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html

ExampleMetadata: fixture=_generated

GatewayRouteRef

A reference to a GatewayRoute resource.

public virtual IGatewayRouteReference GatewayRouteRef { get; }

Property Value

IGatewayRouteReference

Remarks

See: https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html

ExampleMetadata: fixture=_generated

PROPERTY_INJECTION_ID

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }

Property Value

string

Remarks

See: https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html

ExampleMetadata: fixture=_generated

VirtualGateway

The VirtualGateway this GatewayRoute is a part of.

public virtual IVirtualGateway VirtualGateway { get; }

Property Value

IVirtualGateway

Remarks

See: https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html

ExampleMetadata: fixture=_generated

Methods

FromGatewayRouteArn(Construct, string, string)

Import an existing GatewayRoute given an ARN.

public static IGatewayRoute FromGatewayRouteArn(Construct scope, string id, string gatewayRouteArn)

Parameters

scope Construct

id string

gatewayRouteArn string

Returns

IGatewayRoute

Remarks

See: https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html

ExampleMetadata: fixture=_generated

FromGatewayRouteAttributes(Construct, string, IGatewayRouteAttributes)

Import an existing GatewayRoute given attributes.

public static IGatewayRoute FromGatewayRouteAttributes(Construct scope, string id, IGatewayRouteAttributes attrs)

Parameters

scope Construct

id string

attrs IGatewayRouteAttributes

Returns

IGatewayRoute

Remarks

See: https://docs.aws.amazon.com/app-mesh/latest/userguide/gateway-routes.html

ExampleMetadata: fixture=_generated

Implements

IGatewayRoute

IResource

IGatewayRouteRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware