Package software.amazon.awscdk.services.appmesh

Interface VirtualNodeBaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

VirtualNodeProps

All Known Implementing Classes:

VirtualNodeBaseProps.Jsii$Proxy, VirtualNodeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:10.197Z")
@Stability(Stable)
public interface VirtualNodeBaseProps
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	VirtualNodeBaseProps.Builder	A builder for VirtualNodeBaseProps
static final class	VirtualNodeBaseProps.Jsii$Proxy	An implementation for VirtualNodeBaseProps

Method Summary

Modifier and Type	Method	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 List<Backend>	getBackends()	Virtual Services that this is node expected to send outbound traffic to.
default List<VirtualNodeListener>	getListeners()	Initial listener for the virtual node.
default ServiceDiscovery	getServiceDiscovery()	Defines how upstream clients will discover this VirtualNode.
default String	getVirtualNodeName()	The name of the VirtualNode.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAccessLog

@Stability(Stable)
@Nullable
default AccessLog getAccessLog()

Access Logging Configuration for the virtual node.

Default: - No access logging

getBackendDefaults

@Stability(Stable)
@Nullable
default BackendDefaults getBackendDefaults()

Default Configuration Virtual Node uses to communicate with Virtual Service.

Default: - No Config

getBackends

@Stability(Stable)
@Nullable
default List<Backend> getBackends()

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

Default: - No backends

getListeners

@Stability(Stable)
@Nullable
default List<VirtualNodeListener> getListeners()

Initial listener for the virtual node.

Default: - No listeners

getServiceDiscovery

@Stability(Stable)
@Nullable
default ServiceDiscovery getServiceDiscovery()

Defines how upstream clients will discover this VirtualNode.

Default: - No Service Discovery

getVirtualNodeName

@Stability(Stable)
@Nullable
default String getVirtualNodeName()

The name of the VirtualNode.

Default: - A name is automatically determined

builder

@Stability(Stable)
static VirtualNodeBaseProps.Builder builder()

Returns:

a VirtualNodeBaseProps.Builder of VirtualNodeBaseProps