AWS CDK Reference

Appearance

v2.274.0

VirtualNodeBaseProps Struct ​

Basic configuration properties for a VirtualNode.

Source
aws-appmesh/lib/virtual-node.ts

Example ​

ts
const vpc = new ec2.Vpc(this, 'vpc');
const namespace = new cloudmap.PrivateDnsNamespace(this, 'test-namespace', {
    vpc,
    name: 'domain.local',
});
const service = namespace.createService('Svc');

declare const mesh: appmesh.Mesh;
const node = mesh.addVirtualNode('virtual-node', {
  serviceDiscovery: appmesh.ServiceDiscovery.cloudMap(service),
  listeners: [appmesh.VirtualNodeListener.http({
    port: 8081,
    healthCheck: appmesh.HealthCheck.http({
      healthyThreshold: 3,
      interval: Duration.seconds(5), // minimum
      path: '/health-check-path',
      timeout: Duration.seconds(2), // minimum
      unhealthyThreshold: 2,
    }),
  })],
  accessLog: appmesh.AccessLog.fromFilePath('/dev/stdout'),
});

Properties ​

accessLogoptionalAccessLogaccess_logoptionalAccessLogaccessLogoptionalAccessLogAccessLogoptionalAccessLogAccessLogoptionalAccessLog#
Access Logging Configuration for the virtual node.

Default: No access logging

backendDefaultsoptionalBackendDefaultsbackend_defaultsoptionalBackendDefaultsbackendDefaultsoptionalBackendDefaultsBackendDefaultsoptionalBackendDefaultsBackendDefaultsoptionalBackendDefaults#
Default Configuration Virtual Node uses to communicate with Virtual Service.

Default: No Config

backendsoptionalBackend[]backendsoptionaltyping.List[Backend]backendsoptionalList<Backend>BackendsoptionalBackend[]Backendsoptional*[]Backend#
Virtual Services that this is node expected to send outbound traffic to.

Default: No backends

listenersoptionalVirtualNodeListener[]listenersoptionaltyping.List[VirtualNodeListener]listenersoptionalList<VirtualNodeListener>ListenersoptionalVirtualNodeListener[]Listenersoptional*[]VirtualNodeListener#
Initial listener for the virtual node.

Default: No listeners

serviceDiscoveryoptionalServiceDiscoveryservice_discoveryoptionalServiceDiscoveryserviceDiscoveryoptionalServiceDiscoveryServiceDiscoveryoptionalServiceDiscoveryServiceDiscoveryoptionalServiceDiscovery#
Defines how upstream clients will discover this VirtualNode.

Default: No Service Discovery

virtualNodeNameoptionalstringvirtual_node_nameoptionalstrvirtualNodeNameoptionalStringVirtualNodeNameoptionalstringVirtualNodeNameoptional*string#
The name of the VirtualNode.

Default: A name is automatically determined