VirtualRouter

class aws_cdk.aws_appmesh.VirtualRouter(scope, id, *, mesh, listeners=None, virtual_router_name=None)

Bases: Resource

ExampleMetadata:

infused

Example:

# mesh: appmesh.Mesh

router = mesh.add_virtual_router("router",
    listeners=[appmesh.VirtualRouterListener.http(8080)]
)
Parameters:

  • scope (Construct)

  • id (str)

  • mesh (IMesh) – The Mesh which the VirtualRouter belongs to.

  • listeners (Optional[Sequence[VirtualRouterListener]]) – Listener specification for the VirtualRouter. Default: - A listener on HTTP port 8080

  • virtual_router_name (Optional[str]) – The name of the VirtualRouter. Default: - A name is automatically determined

Methods

add_route(id, *, route_spec, route_name=None)

Add a single route to the router.

Parameters:

  • id (str)

  • route_spec (RouteSpec) – Protocol specific spec.

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

Return type:

Route

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

PROPERTY_INJECTION_ID = 'aws-cdk-lib.aws-appmesh.VirtualRouter'
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.

mesh

The Mesh which the VirtualRouter belongs to.

node

The tree node.

stack

The stack in which this resource is defined.

virtual_router_arn

The Amazon Resource Name (ARN) for the VirtualRouter.

virtual_router_name

The name of the VirtualRouter.

Static Methods

classmethod from_virtual_router_arn(scope, id, virtual_router_arn)

Import an existing VirtualRouter given an ARN.

Parameters:

  • scope (Construct)

  • id (str)

  • virtual_router_arn (str)

Return type:

IVirtualRouter

classmethod from_virtual_router_attributes(scope, id, *, mesh, virtual_router_name)

Import an existing VirtualRouter given attributes.

Parameters:

  • scope (Construct)

  • id (str)

  • mesh (IMesh) – The Mesh which the VirtualRouter belongs to.

  • virtual_router_name (str) – The name of the VirtualRouter.

Return type:

IVirtualRouter

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct)

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct)

Return type:

bool