Show / Hide Table of Contents

Class Route

Route represents a new or existing route attached to a VirtualRouter and Mesh.

Inheritance
object
Resource
Route
Implements
IRoute
IResource
IConstruct
IDependable
Inherited Members
Resource.IsOwnedResource(IConstruct)
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(string, IArnComponents)
Resource.GetResourceNameAttribute(string)
Resource.Env
Resource.PhysicalName
Resource.Stack
Namespace: Amazon.CDK.AWS.AppMesh
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class Route : Resource, IRoute, IResource, IConstruct, IDependable
Syntax (vb)
Public Class Route Inherits Resource Implements IRoute, IResource, IConstruct, IDependable
Remarks

See: https://docs.aws.amazon.com/app-mesh/latest/userguide/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;

             Mesh mesh;
             RouteSpec routeSpec;
             VirtualRouter virtualRouter;

             var route = new Route(this, "MyRoute", new RouteProps {
                 Mesh = mesh,
                 RouteSpec = routeSpec,
                 VirtualRouter = virtualRouter,

                 // the properties below are optional
                 RouteName = "routeName"
             });

Synopsis

Constructors

Route(Construct, string, IRouteProps)

Route represents a new or existing route attached to a VirtualRouter and Mesh.

Properties

PROPERTY_INJECTION_ID

Uniquely identifies this class.

RouteArn

The Amazon Resource Name (ARN) for the route.

RouteName

The name of the Route.

VirtualRouter

The VirtualRouter the Route belongs to.

Methods

FromRouteArn(Construct, string, string)

Import an existing Route given an ARN.

FromRouteAttributes(Construct, string, IRouteAttributes)

Import an existing Route given attributes.

Constructors

Route(Construct, string, IRouteProps)

Route represents a new or existing route attached to a VirtualRouter and Mesh.

public Route(Construct scope, string id, IRouteProps props)
Parameters
scope Construct
id string
props IRouteProps
Remarks

See: https://docs.aws.amazon.com/app-mesh/latest/userguide/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;

             Mesh mesh;
             RouteSpec routeSpec;
             VirtualRouter virtualRouter;

             var route = new Route(this, "MyRoute", new RouteProps {
                 Mesh = mesh,
                 RouteSpec = routeSpec,
                 VirtualRouter = virtualRouter,

                 // the properties below are optional
                 RouteName = "routeName"
             });

Properties

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/routes.html

ExampleMetadata: fixture=_generated

RouteArn

The Amazon Resource Name (ARN) for the route.

public virtual string RouteArn { get; }
Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

RouteName

The name of the Route.

public virtual string RouteName { get; }
Property Value

string

Remarks

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

ExampleMetadata: fixture=_generated

VirtualRouter

The VirtualRouter the Route belongs to.

public virtual IVirtualRouter VirtualRouter { get; }
Property Value

IVirtualRouter

Remarks

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

ExampleMetadata: fixture=_generated

Methods

FromRouteArn(Construct, string, string)

Import an existing Route given an ARN.

public static IRoute FromRouteArn(Construct scope, string id, string routeArn)
Parameters
scope Construct
id string
routeArn string
Returns

IRoute

Remarks

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

ExampleMetadata: fixture=_generated

FromRouteAttributes(Construct, string, IRouteAttributes)

Import an existing Route given attributes.

public static IRoute FromRouteAttributes(Construct scope, string id, IRouteAttributes attrs)
Parameters
scope Construct
id string
attrs IRouteAttributes
Returns

IRoute

Remarks

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

ExampleMetadata: fixture=_generated

Implements

IRoute
IResource
Constructs.IConstruct
Constructs.IDependable
Back to top Generated by DocFX