VirtualRouter

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

Bases: aws_cdk.core.Resource

Stability

experimental

Parameters
  • scope (Construct) –

  • id (str) –

  • mesh (IMesh) – (experimental) The AppMesh mesh the VirtualRouter belongs to.

  • listener (Optional[Listener]) – (experimental) Listener specification for the virtual router. Default: - A listener on HTTP port 8080

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

Stability

experimental

Methods

add_route(id, *, route_targets, prefix=None, route_name=None, route_type=None)

(experimental) Add a single route to the router.

Parameters
  • id (str) –

  • route_targets (List[WeightedTargetProps]) – (experimental) Array of weighted route targets.

  • prefix (Optional[str]) – (experimental) The path prefix to match for the route. Default: “/” if http otherwise none

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

  • route_type (Optional[RouteType]) – (experimental) Weather the route is HTTP based. Default: - HTTP if prefix is given, TCP otherwise

Stability

experimental

Return type

Route

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

mesh

(experimental) The AppMesh mesh the VirtualRouter belongs to.

Stability

experimental

Return type

IMesh

node

The construct tree node associated with this construct.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

virtual_router_arn

(experimental) The Amazon Resource Name (ARN) for the VirtualRouter.

Stability

experimental

Return type

str

virtual_router_name

(experimental) The name of the VirtualRouter.

Stability

experimental

Return type

str

Static Methods

classmethod from_virtual_router_arn(scope, id, virtual_router_arn)

(experimental) Import an existing VirtualRouter given an ARN.

Parameters
  • scope (Construct) –

  • id (str) –

  • virtual_router_arn (str) –

Stability

experimental

Return type

IVirtualRouter

classmethod from_virtual_router_attributes(scope, id, *, mesh=None, mesh_name=None, virtual_router_arn=None, virtual_router_name=None)

(experimental) Import an existing virtual router given attributes.

Parameters
  • scope (Construct) –

  • id (str) –

  • mesh (Optional[IMesh]) – (experimental) The AppMesh mesh the VirtualRouter belongs to.

  • mesh_name (Optional[str]) – (experimental) The name of the AppMesh mesh the VirtualRouter belongs to.

  • virtual_router_arn (Optional[str]) – (experimental) The Amazon Resource Name (ARN) for the VirtualRouter.

  • virtual_router_name (Optional[str]) – (experimental) The name of the VirtualRouter.

Stability

experimental

Return type

IVirtualRouter

classmethod from_virtual_router_name(scope, id, mesh_name, virtual_router_name)

(experimental) Import an existing VirtualRouter given names.

Parameters
  • scope (Construct) –

  • id (str) –

  • mesh_name (str) –

  • virtual_router_name (str) –

Stability

experimental

Return type

IVirtualRouter

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool