Route

class aws_cdk.aws_appmesh.Route(scope, id, *, mesh, virtual_router, route_name=None, route_spec)

Bases: aws_cdk.core.Resource

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

See

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

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appmesh as appmesh

# mesh is of type Mesh
# route_spec is of type RouteSpec
# virtual_router is of type VirtualRouter

route = appmesh.Route(self, "MyRoute",
    mesh=mesh,
    route_spec=route_spec,
    virtual_router=virtual_router,

    # the properties below are optional
    route_name="routeName"
)
Parameters
  • scope (Construct) –

  • id (str) –

  • mesh (IMesh) – The service mesh to define the route in.

  • virtual_router (IVirtualRouter) – The VirtualRouter the Route belongs to.

  • route_name (Optional[str]) – The name of the route. Default: - An automatically generated name

  • route_spec (RouteSpec) – Protocol specific spec.

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters

policy (RemovalPolicy) –

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

Return type

ResourceEnvironment

node

The construct tree node associated with this construct.

Return type

ConstructNode

route_arn

The Amazon Resource Name (ARN) for the route.

Return type

str

route_name

The name of the Route.

Return type

str

stack

The stack in which this resource is defined.

Return type

Stack

virtual_router

The VirtualRouter the Route belongs to.

Return type

IVirtualRouter

Static Methods

classmethod from_route_arn(scope, id, route_arn)

Import an existing Route given an ARN.

Parameters
  • scope (Construct) –

  • id (str) –

  • route_arn (str) –

Return type

IRoute

classmethod from_route_attributes(scope, id, *, route_name, virtual_router)

Import an existing Route given attributes.

Parameters
  • scope (Construct) –

  • id (str) –

  • route_name (str) – The name of the Route.

  • virtual_router (IVirtualRouter) – The VirtualRouter the Route belongs to.

Return type

IRoute

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool