VirtualService

class aws_cdk.aws_appmesh.VirtualService(scope, id, *, mesh, virtual_node=None, virtual_router=None, virtual_service_name=None)

Bases: aws_cdk.core.Resource

VirtualService represents a service inside an AppMesh.

It routes traffic either to a Virtual Node or to a Virtual Router.

see :see: https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_services.html stability :stability: experimental

__init__(scope, id, *, mesh, virtual_node=None, virtual_router=None, virtual_service_name=None)
Parameters

  • scope (Construct) –

  • id (str) –

  • mesh (IMesh) – The AppMesh mesh name for which the VirtualService belongs to.

  • virtual_node (Optional[IVirtualNode]) – The VirtualNode attached to the virtual service. Default: - At most one of virtualRouter and virtualNode is allowed.

  • virtual_router (Optional[IVirtualRouter]) – The VirtualRouter which the VirtualService uses as provider. Default: - At most one of virtualRouter and virtualNode is allowed.

  • virtual_service_name (Optional[str]) – The name of the VirtualService. It is recommended this follows the fully-qualified domain name format, such as “my-service.default.svc.cluster.local”. Default: - A name is automatically generated

stability :stability: experimental

Return type

None

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

stack

The stack in which this resource is defined.

Return type

Stack

virtual_service_arn

The Amazon Resource Name (ARN) for the virtual service.

stability :stability: experimental

Return type

str

virtual_service_name

The name of the VirtualService, it is recommended this follows the fully-qualified domain name format.

stability :stability: experimental

Return type

str

Static Methods

classmethod from_virtual_service_arn(scope, id, virtual_service_arn)

Import an existing VirtualService given an ARN.

Parameters

  • scope (Construct) –

  • id (str) –

  • virtual_service_arn (str) –

stability :stability: experimental

Return type

IVirtualService

classmethod from_virtual_service_name(scope, id, mesh_name, virtual_service_name)

Import an existing VirtualService given mesh and service names.

Parameters

  • scope (Construct) –

  • id (str) –

  • mesh_name (str) –

  • virtual_service_name (str) –

stability :stability: experimental

Return type

IVirtualService

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool