software.amazon.awscdk.services.appmesh

Interface VirtualNodeBaseProps

All Known Subinterfaces:

VirtualNodeProps

All Known Implementing Classes:

VirtualNodeBaseProps.Jsii$Proxy, VirtualNodeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:27.916Z")
public interface VirtualNodeBaseProps

Basic configuration properties for a VirtualNode.

Example:

 Mesh mesh;
 Vpc vpc = new Vpc(this, "vpc");
 PrivateDnsNamespace namespace = PrivateDnsNamespace.Builder.create(this, "test-namespace")
         .vpc(vpc)
         .name("domain.local")
         .build();
 Service service = namespace.createService("Svc");
 VirtualNode node = mesh.addVirtualNode("virtual-node", VirtualNodeBaseProps.builder()
         .serviceDiscovery(ServiceDiscovery.cloudMap(service))
         .listeners(List.of(VirtualNodeListener.http(HttpVirtualNodeListenerOptions.builder()
                 .port(8081)
                 .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder()
                         .healthyThreshold(3)
                         .interval(Duration.seconds(5)) // minimum
                         .path("/health-check-path")
                         .timeout(Duration.seconds(2)) // minimum
                         .unhealthyThreshold(2)
                         .build()))
                 .build())))
         .accessLog(AccessLog.fromFilePath("/dev/stdout"))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VirtualNodeBaseProps.Builder A builder for VirtualNodeBaseProps
static class	VirtualNodeBaseProps.Jsii$Proxy An implementation for VirtualNodeBaseProps

Method Summary

Modifier and Type	Method and Description
static VirtualNodeBaseProps.Builder	builder()
default AccessLog	getAccessLog() Access Logging Configuration for the virtual node.
default BackendDefaults	getBackendDefaults() Default Configuration Virtual Node uses to communicate with Virtual Service.
default java.util.List<Backend>	getBackends() Virtual Services that this is node expected to send outbound traffic to.
default java.util.List<VirtualNodeListener>	getListeners() Initial listener for the virtual node.
default ServiceDiscovery	getServiceDiscovery() Defines how upstream clients will discover this VirtualNode.
default java.lang.String	getVirtualNodeName() The name of the VirtualNode.

Method Detail

getAccessLog

default AccessLog getAccessLog()

Access Logging Configuration for the virtual node.

Default: - No access logging

getBackendDefaults

default BackendDefaults getBackendDefaults()

Default Configuration Virtual Node uses to communicate with Virtual Service.

Default: - No Config

getBackends

default java.util.List<Backend> getBackends()

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

Default: - No backends

getListeners

default java.util.List<VirtualNodeListener> getListeners()

Initial listener for the virtual node.

Default: - No listeners

getServiceDiscovery

default ServiceDiscovery getServiceDiscovery()

Defines how upstream clients will discover this VirtualNode.

Default: - No Service Discovery

getVirtualNodeName

default java.lang.String getVirtualNodeName()

The name of the VirtualNode.

Default: - A name is automatically determined

builder

static VirtualNodeBaseProps.Builder builder()

Returns:

a VirtualNodeBaseProps.Builder of VirtualNodeBaseProps