VirtualRouter

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

Bases: aws_cdk.core.Resource

stability :stability: experimental

__init__(scope, id, *, mesh, listener=None, virtual_router_name=None)
Parameters
  • scope (Construct) –

  • id (str) –

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

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

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

stability :stability: experimental

Return type

None

Methods

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

Add a single route to the router.

Parameters
  • id (str) –

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

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

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

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

stability :stability: experimental

Return type

Route

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

mesh

The AppMesh mesh the VirtualRouter belongs to.

stability :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

The Amazon Resource Name (ARN) for the VirtualRouter.

stability :stability: experimental

Return type

str

virtual_router_name

The name of the VirtualRouter.

stability :stability: experimental

Return type

str

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) –

stability :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)

Import an existing virtual router given attributes.

Parameters
  • scope (Construct) –

  • id (str) –

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

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

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

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

stability :stability: experimental

Return type

IVirtualRouter

classmethod from_virtual_router_name(scope, id, mesh_name, virtual_router_name)

Import an existing VirtualRouter given names.

Parameters
  • scope (Construct) –

  • id (str) –

  • mesh_name (str) –

  • virtual_router_name (str) –

stability :stability: experimental

Return type

IVirtualRouter

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool