VirtualService

class aws_cdk.aws_appmesh.VirtualService(scope, id, *, virtual_service_provider, 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

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

ExampleMetadata

infused

Example:

# mesh: appmesh.Mesh


node = appmesh.VirtualNode(self, "node",
    mesh=mesh,
    service_discovery=appmesh.ServiceDiscovery.dns("node")
)

virtual_service = appmesh.VirtualService(self, "service-1",
    virtual_service_provider=appmesh.VirtualServiceProvider.virtual_node(node),
    virtual_service_name="service1.domain.local"
)

node.add_backend(appmesh.Backend.virtual_service(virtual_service))
Parameters

  • scope (Construct) –

  • id (str) –

  • virtual_service_provider (VirtualServiceProvider) – The VirtualNode or VirtualRouter which the VirtualService uses as its provider.

  • 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”. Example value: service.domain.local Default: - A name is automatically generated

Methods

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

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

The Mesh which the VirtualService belongs to.

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

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

Return type

str

virtual_service_name

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

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

Return type

IVirtualService

classmethod from_virtual_service_attributes(scope, id, *, mesh, virtual_service_name)

Import an existing VirtualService given its attributes.

Parameters

  • scope (Construct) –

  • id (str) –

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

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

Return type

IVirtualService

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters

construct (IConstruct) –

Return type

bool