VirtualNode

class aws_cdk.aws_appmesh.VirtualNode(scope, id, *, mesh, access_log=None, backends=None, backends_default_client_policy=None, listeners=None, service_discovery=None, virtual_node_name=None)

Bases: aws_cdk.core.Resource

(experimental) VirtualNode represents a newly defined AppMesh VirtualNode.

Any inbound traffic that your virtual node expects should be specified as a listener. Any outbound traffic that your virtual node expects to reach should be specified as a backend.

See

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

Stability

experimental

Parameters
  • scope (Construct) –

  • id (str) –

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

  • access_log (Optional[AccessLog]) – (experimental) Access Logging Configuration for the virtual node. Default: - No access logging

  • backends (Optional[List[IVirtualService]]) – (experimental) Virtual Services that this is node expected to send outbound traffic to. Default: - No backends

  • backends_default_client_policy (Optional[ClientPolicy]) – (experimental) Default Configuration Virtual Node uses to communicate with Virtual Service. Default: - No Config

  • listeners (Optional[List[VirtualNodeListener]]) – (experimental) Initial listener for the virtual node. Default: - No listeners

  • service_discovery (Optional[ServiceDiscovery]) – (experimental) Defines how upstream clients will discover this VirtualNode. Default: - No Service Discovery

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

Stability

experimental

Methods

add_backend(virtual_service)

(experimental) Add a Virtual Services that this node is expected to send outbound traffic to.

Parameters

virtual_service (IVirtualService) –

Stability

experimental

Return type

None

add_listener(listener)

(experimental) Utility method to add an inbound listener for this VirtualNode.

Parameters

listener (VirtualNodeListener) –

Stability

experimental

Return type

None

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.DELETE), 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

(experimental) The Mesh which the VirtualNode 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_node_arn

(experimental) The Amazon Resource Name belonging to the VirtualNode.

Stability

experimental

Return type

str

virtual_node_name

(experimental) The name of the VirtualNode.

Stability

experimental

Return type

str

Static Methods

classmethod from_virtual_node_arn(scope, id, virtual_node_arn)

(experimental) Import an existing VirtualNode given an ARN.

Parameters
  • scope (Construct) –

  • id (str) –

  • virtual_node_arn (str) –

Stability

experimental

Return type

IVirtualNode

classmethod from_virtual_node_attributes(scope, id, *, mesh, virtual_node_name)

(experimental) Import an existing VirtualNode given its name.

Parameters
  • scope (Construct) –

  • id (str) –

  • mesh (IMesh) – (experimental) The Mesh that the VirtualNode belongs to.

  • virtual_node_name (str) – (experimental) The name of the VirtualNode.

Stability

experimental

Return type

IVirtualNode

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