VirtualService

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

Bases: aws_cdk.core.Resource

(experimental) VirtualService represents a service inside an AppMesh.

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

See

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

Stability

experimental

Parameters

  • scope (Construct) –

  • id (str) –

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

  • client_policy (Optional[ClientPolicy]) – (experimental) Client policy for this Virtual Service. Default: - none

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

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

  • virtual_service_name (Optional[str]) – (experimental) 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

experimental

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

client_policy

(experimental) Client policy for this Virtual Service.

Stability

experimental

Return type

Optional[ClientPolicy]

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 Mesh which the VirtualService 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_service_arn

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

Stability

experimental

Return type

str

virtual_service_name

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

Stability

experimental

Return type

str

Static Methods

classmethod from_virtual_service_arn(scope, id, virtual_service_arn)

(experimental) Import an existing VirtualService given an ARN.

Parameters

  • scope (Construct) –

  • id (str) –

  • virtual_service_arn (str) –

Stability

experimental

Return type

IVirtualService

classmethod from_virtual_service_attributes(scope, id, *, mesh, virtual_service_name, client_policy=None)

(experimental) Import an existing VirtualService given its attributes.

Parameters

  • scope (Construct) –

  • id (str) –

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

  • virtual_service_name (str) – (experimental) The name of the VirtualService, it is recommended this follows the fully-qualified domain name format.

  • client_policy (Optional[ClientPolicy]) – (experimental) Client policy for this Virtual Service. Default: - none

Stability

experimental

Return type

IVirtualService

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool