VirtualNode

class aws_cdk.aws_appmesh.VirtualNode(scope, id, *, mesh, backends=None, cloud_map_service=None, cloud_map_service_instance_attributes=None, dns_host_name=None, listener=None, virtual_node_name=None)

Bases: aws_cdk.core.Resource

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 :see: https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_nodes.html stability :stability: experimental

__init__(scope, id, *, mesh, backends=None, cloud_map_service=None, cloud_map_service_instance_attributes=None, dns_host_name=None, listener=None, virtual_node_name=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • mesh (IMesh) – The name of the AppMesh which the virtual node belongs to.

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

  • cloud_map_service (Optional[IService]) – CloudMap service where Virtual Node members register themselves. Instances registering themselves into this CloudMap will be considered part of the Virtual Node. Default: - Don’t use CloudMap-based service discovery

  • cloud_map_service_instance_attributes (Optional[Mapping[str, str]]) – Filter down the list of CloudMap service instance. Default: - No CloudMap instance filter

  • dns_host_name (Optional[str]) – Host name of DNS record used to discover Virtual Node members. The IP addresses returned by querying this DNS record will be considered part of the Virtual Node. Default: - Don’t use DNS-based service discovery

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

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

stability :stability: experimental

Return type

None

Methods

add_backends(*props)

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

Parameters

props (IVirtualService) –

stability :stability: experimental

Return type

None

add_listeners(*listeners)

Utility method to add an inbound listener for this virtual node.

Parameters

listeners (VirtualNodeListener) –

stability :stability: experimental

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

mesh

The service mesh that the virtual node resides in.

stability :stability: experimental

Return type

IMesh

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_node_arn

The Amazon Resource Name belonging to the VirtualNdoe.

stability :stability: experimental

Return type

str

virtual_node_name

The name of the VirtualNode.

stability :stability: experimental

Return type

str

Static Methods

classmethod from_virtual_node_arn(scope, id, virtual_node_arn)

Import an existing VirtualNode given an ARN.

Parameters
  • scope (Construct) –

  • id (str) –

  • virtual_node_arn (str) –

stability :stability: experimental

Return type

IVirtualNode

classmethod from_virtual_node_name(scope, id, mesh_name, virtual_node_name)

Import an existing VirtualNode given its name.

Parameters
  • scope (Construct) –

  • id (str) –

  • mesh_name (str) –

  • virtual_node_name (str) –

stability :stability: experimental

Return type

IVirtualNode

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool