Package software.amazon.awscdk.cfnpropertymixins.services.appmesh

Class CfnVirtualNodePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.appmesh.CfnVirtualNodePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.830Z")
@Stability(Stable)
public class CfnVirtualNodePropsMixin
extends Mixin
implements software.constructs.IMixin

Creates a virtual node within a service mesh.

A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS service or a Kubernetes deployment. When you create a virtual node, you can specify the service discovery information for your task group, and whether the proxy running in a task group will communicate with other proxies using Transport Layer Security (TLS).

You define a listener for any inbound traffic that your virtual node expects. Any virtual service that your virtual node expects to communicate to is specified as a backend .

The response metadata for your new virtual node contains the arn that is associated with the virtual node. Set this value to the full ARN; for example, arn:aws:appmesh:us-west-2:123456789012:myMesh/default/virtualNode/myApp ) as the APPMESH_RESOURCE_ARN environment variable for your task group's Envoy proxy container in your task definition or pod spec. This is then mapped to the node.id and node.cluster Envoy parameters.

By default, App Mesh uses the name of the resource you specified in APPMESH_RESOURCE_ARN when Envoy is referring to itself in metrics and traces. You can override this behavior by setting the APPMESH_RESOURCE_CLUSTER environment variable with your own name.

For more information about virtual nodes, see Virtual nodes . You must be using 1.15.0 or later of the Envoy image when setting these variables. For more information aboutApp Mesh Envoy variables, see Envoy image in the AWS App Mesh User Guide.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.appmesh.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnVirtualNodePropsMixin cfnVirtualNodePropsMixin = CfnVirtualNodePropsMixin.Builder.create(CfnVirtualNodeMixinProps.builder()
         .meshName("meshName")
         .meshOwner("meshOwner")
         .spec(VirtualNodeSpecProperty.builder()
                 .backendDefaults(BackendDefaultsProperty.builder()
                         .clientPolicy(ClientPolicyProperty.builder()
                                 .tls(ClientPolicyTlsProperty.builder()
                                         .certificate(ClientTlsCertificateProperty.builder()
                                                 .file(ListenerTlsFileCertificateProperty.builder()
                                                         .certificateChain("certificateChain")
                                                         .privateKey("privateKey")
                                                         .build())
                                                 .sds(ListenerTlsSdsCertificateProperty.builder()
                                                         .secretName("secretName")
                                                         .build())
                                                 .build())
                                         .enforce(false)
                                         .ports(List.of(123))
                                         .validation(TlsValidationContextProperty.builder()
                                                 .subjectAlternativeNames(SubjectAlternativeNamesProperty.builder()
                                                         .match(SubjectAlternativeNameMatchersProperty.builder()
                                                                 .exact(List.of("exact"))
                                                                 .build())
                                                         .build())
                                                 .trust(TlsValidationContextTrustProperty.builder()
                                                         .acm(TlsValidationContextAcmTrustProperty.builder()
                                                                 .certificateAuthorityArns(List.of("certificateAuthorityArns"))
                                                                 .build())
                                                         .file(TlsValidationContextFileTrustProperty.builder()
                                                                 .certificateChain("certificateChain")
                                                                 .build())
                                                         .sds(TlsValidationContextSdsTrustProperty.builder()
                                                                 .secretName("secretName")
                                                                 .build())
                                                         .build())
                                                 .build())
                                         .build())
                                 .build())
                         .build())
                 .backends(List.of(BackendProperty.builder()
                         .virtualService(VirtualServiceBackendProperty.builder()
                                 .clientPolicy(ClientPolicyProperty.builder()
                                         .tls(ClientPolicyTlsProperty.builder()
                                                 .certificate(ClientTlsCertificateProperty.builder()
                                                         .file(ListenerTlsFileCertificateProperty.builder()
                                                                 .certificateChain("certificateChain")
                                                                 .privateKey("privateKey")
                                                                 .build())
                                                         .sds(ListenerTlsSdsCertificateProperty.builder()
                                                                 .secretName("secretName")
                                                                 .build())
                                                         .build())
                                                 .enforce(false)
                                                 .ports(List.of(123))
                                                 .validation(TlsValidationContextProperty.builder()
                                                         .subjectAlternativeNames(SubjectAlternativeNamesProperty.builder()
                                                                 .match(SubjectAlternativeNameMatchersProperty.builder()
                                                                         .exact(List.of("exact"))
                                                                         .build())
                                                                 .build())
                                                         .trust(TlsValidationContextTrustProperty.builder()
                                                                 .acm(TlsValidationContextAcmTrustProperty.builder()
                                                                         .certificateAuthorityArns(List.of("certificateAuthorityArns"))
                                                                         .build())
                                                                 .file(TlsValidationContextFileTrustProperty.builder()
                                                                         .certificateChain("certificateChain")
                                                                         .build())
                                                                 .sds(TlsValidationContextSdsTrustProperty.builder()
                                                                         .secretName("secretName")
                                                                         .build())
                                                                 .build())
                                                         .build())
                                                 .build())
                                         .build())
                                 .virtualServiceName("virtualServiceName")
                                 .build())
                         .build()))
                 .listeners(List.of(ListenerProperty.builder()
                         .connectionPool(VirtualNodeConnectionPoolProperty.builder()
                                 .grpc(VirtualNodeGrpcConnectionPoolProperty.builder()
                                         .maxRequests(123)
                                         .build())
                                 .http(VirtualNodeHttpConnectionPoolProperty.builder()
                                         .maxConnections(123)
                                         .maxPendingRequests(123)
                                         .build())
                                 .http2(VirtualNodeHttp2ConnectionPoolProperty.builder()
                                         .maxRequests(123)
                                         .build())
                                 .tcp(VirtualNodeTcpConnectionPoolProperty.builder()
                                         .maxConnections(123)
                                         .build())
                                 .build())
                         .healthCheck(HealthCheckProperty.builder()
                                 .healthyThreshold(123)
                                 .intervalMillis(123)
                                 .path("path")
                                 .port(123)
                                 .protocol("protocol")
                                 .timeoutMillis(123)
                                 .unhealthyThreshold(123)
                                 .build())
                         .outlierDetection(OutlierDetectionProperty.builder()
                                 .baseEjectionDuration(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 .interval(DurationProperty.builder()
                                         .unit("unit")
                                         .value(123)
                                         .build())
                                 .maxEjectionPercent(123)
                                 .maxServerErrors(123)
                                 .build())
                         .portMapping(PortMappingProperty.builder()
                                 .port(123)
                                 .protocol("protocol")
                                 .build())
                         .timeout(ListenerTimeoutProperty.builder()
                                 .grpc(GrpcTimeoutProperty.builder()
                                         .idle(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .perRequest(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .build())
                                 .http(HttpTimeoutProperty.builder()
                                         .idle(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .perRequest(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .build())
                                 .http2(HttpTimeoutProperty.builder()
                                         .idle(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .perRequest(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .build())
                                 .tcp(TcpTimeoutProperty.builder()
                                         .idle(DurationProperty.builder()
                                                 .unit("unit")
                                                 .value(123)
                                                 .build())
                                         .build())
                                 .build())
                         .tls(ListenerTlsProperty.builder()
                                 .certificate(ListenerTlsCertificateProperty.builder()
                                         .acm(ListenerTlsAcmCertificateProperty.builder()
                                                 .certificateArn("certificateArn")
                                                 .build())
                                         .file(ListenerTlsFileCertificateProperty.builder()
                                                 .certificateChain("certificateChain")
                                                 .privateKey("privateKey")
                                                 .build())
                                         .sds(ListenerTlsSdsCertificateProperty.builder()
                                                 .secretName("secretName")
                                                 .build())
                                         .build())
                                 .mode("mode")
                                 .validation(ListenerTlsValidationContextProperty.builder()
                                         .subjectAlternativeNames(SubjectAlternativeNamesProperty.builder()
                                                 .match(SubjectAlternativeNameMatchersProperty.builder()
                                                         .exact(List.of("exact"))
                                                         .build())
                                                 .build())
                                         .trust(ListenerTlsValidationContextTrustProperty.builder()
                                                 .file(TlsValidationContextFileTrustProperty.builder()
                                                         .certificateChain("certificateChain")
                                                         .build())
                                                 .sds(TlsValidationContextSdsTrustProperty.builder()
                                                         .secretName("secretName")
                                                         .build())
                                                 .build())
                                         .build())
                                 .build())
                         .build()))
                 .logging(LoggingProperty.builder()
                         .accessLog(AccessLogProperty.builder()
                                 .file(FileAccessLogProperty.builder()
                                         .format(LoggingFormatProperty.builder()
                                                 .json(List.of(JsonFormatRefProperty.builder()
                                                         .key("key")
                                                         .value("value")
                                                         .build()))
                                                 .text("text")
                                                 .build())
                                         .path("path")
                                         .build())
                                 .build())
                         .build())
                 .serviceDiscovery(ServiceDiscoveryProperty.builder()
                         .awsCloudMap(AwsCloudMapServiceDiscoveryProperty.builder()
                                 .attributes(List.of(AwsCloudMapInstanceAttributeProperty.builder()
                                         .key("key")
                                         .value("value")
                                         .build()))
                                 .ipPreference("ipPreference")
                                 .namespaceName("namespaceName")
                                 .serviceName("serviceName")
                                 .build())
                         .dns(DnsServiceDiscoveryProperty.builder()
                                 .hostname("hostname")
                                 .ipPreference("ipPreference")
                                 .responseType("responseType")
                                 .build())
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .virtualNodeName("virtualNodeName")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appmesh-virtualnode.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnVirtualNodePropsMixin.AccessLogProperty	An object that represents the access logging information for a virtual node.
static interface	CfnVirtualNodePropsMixin.AwsCloudMapInstanceAttributeProperty	An object that represents the AWS Cloud Map attribute information for your virtual node.
static interface	CfnVirtualNodePropsMixin.AwsCloudMapServiceDiscoveryProperty	An object that represents the AWS Cloud Map service discovery information for your virtual node.
static interface	CfnVirtualNodePropsMixin.BackendDefaultsProperty	An object that represents the default properties for a backend.
static interface	CfnVirtualNodePropsMixin.BackendProperty	An object that represents the backends that a virtual node is expected to send outbound traffic to.
static final class	CfnVirtualNodePropsMixin.Builder	A fluent builder for CfnVirtualNodePropsMixin.
static interface	CfnVirtualNodePropsMixin.ClientPolicyProperty	An object that represents a client policy.
static interface	CfnVirtualNodePropsMixin.ClientPolicyTlsProperty	A reference to an object that represents a Transport Layer Security (TLS) client policy.
static interface	CfnVirtualNodePropsMixin.ClientTlsCertificateProperty	An object that represents the client's certificate.
static interface	CfnVirtualNodePropsMixin.DnsServiceDiscoveryProperty	An object that represents the DNS service discovery information for your virtual node.
static interface	CfnVirtualNodePropsMixin.DurationProperty	An object that represents a duration of time.
static interface	CfnVirtualNodePropsMixin.FileAccessLogProperty	An object that represents an access log file.
static interface	CfnVirtualNodePropsMixin.GrpcTimeoutProperty	An object that represents types of timeouts.
static interface	CfnVirtualNodePropsMixin.HealthCheckProperty	An object that represents the health check policy for a virtual node's listener.
static interface	CfnVirtualNodePropsMixin.HttpTimeoutProperty	An object that represents types of timeouts.
static interface	CfnVirtualNodePropsMixin.JsonFormatRefProperty	An object that represents the key value pairs for the JSON.
static interface	CfnVirtualNodePropsMixin.ListenerProperty	An object that represents a listener for a virtual node.
static interface	CfnVirtualNodePropsMixin.ListenerTimeoutProperty	An object that represents timeouts for different protocols.
static interface	CfnVirtualNodePropsMixin.ListenerTlsAcmCertificateProperty	An object that represents an Certificate Manager certificate.
static interface	CfnVirtualNodePropsMixin.ListenerTlsCertificateProperty	An object that represents a listener's Transport Layer Security (TLS) certificate.
static interface	CfnVirtualNodePropsMixin.ListenerTlsFileCertificateProperty	An object that represents a local file certificate.
static interface	CfnVirtualNodePropsMixin.ListenerTlsProperty	An object that represents the Transport Layer Security (TLS) properties for a listener.
static interface	CfnVirtualNodePropsMixin.ListenerTlsSdsCertificateProperty	An object that represents the listener's Secret Discovery Service certificate.
static interface	CfnVirtualNodePropsMixin.ListenerTlsValidationContextProperty	An object that represents a listener's Transport Layer Security (TLS) validation context.
static interface	CfnVirtualNodePropsMixin.ListenerTlsValidationContextTrustProperty	An object that represents a listener's Transport Layer Security (TLS) validation context trust.
static interface	CfnVirtualNodePropsMixin.LoggingFormatProperty	An object that represents the format for the logs.
static interface	CfnVirtualNodePropsMixin.LoggingProperty	An object that represents the logging information for a virtual node.
static interface	CfnVirtualNodePropsMixin.OutlierDetectionProperty	An object that represents the outlier detection for a virtual node's listener.
static interface	CfnVirtualNodePropsMixin.PortMappingProperty	An object representing a virtual node or virtual router listener port mapping.
static interface	CfnVirtualNodePropsMixin.ServiceDiscoveryProperty	An object that represents the service discovery information for a virtual node.
static interface	CfnVirtualNodePropsMixin.SubjectAlternativeNameMatchersProperty	An object that represents the methods by which a subject alternative name on a peer Transport Layer Security (TLS) certificate can be matched.
static interface	CfnVirtualNodePropsMixin.SubjectAlternativeNamesProperty	An object that represents the subject alternative names secured by the certificate.
static interface	CfnVirtualNodePropsMixin.TcpTimeoutProperty	An object that represents types of timeouts.
static interface	CfnVirtualNodePropsMixin.TlsValidationContextAcmTrustProperty	An object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
static interface	CfnVirtualNodePropsMixin.TlsValidationContextFileTrustProperty	An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
static interface	CfnVirtualNodePropsMixin.TlsValidationContextProperty	An object that represents how the proxy will validate its peer during Transport Layer Security (TLS) negotiation.
static interface	CfnVirtualNodePropsMixin.TlsValidationContextSdsTrustProperty	An object that represents a Transport Layer Security (TLS) Secret Discovery Service validation context trust.
static interface	CfnVirtualNodePropsMixin.TlsValidationContextTrustProperty	An object that represents a Transport Layer Security (TLS) validation context trust.
static interface	CfnVirtualNodePropsMixin.VirtualNodeConnectionPoolProperty	An object that represents the type of virtual node connection pool.
static interface	CfnVirtualNodePropsMixin.VirtualNodeGrpcConnectionPoolProperty	An object that represents a type of connection pool.
static interface	CfnVirtualNodePropsMixin.VirtualNodeHttp2ConnectionPoolProperty	An object that represents a type of connection pool.
static interface	CfnVirtualNodePropsMixin.VirtualNodeHttpConnectionPoolProperty	An object that represents a type of connection pool.
static interface	CfnVirtualNodePropsMixin.VirtualNodeSpecProperty	An object that represents the specification of a virtual node.
static interface	CfnVirtualNodePropsMixin.VirtualNodeTcpConnectionPoolProperty	An object that represents a type of connection pool.
static interface	CfnVirtualNodePropsMixin.VirtualServiceBackendProperty	An object that represents a virtual service backend for a virtual node.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnVirtualNodePropsMixin(CfnVirtualNodeMixinProps props)	Create a mixin to apply properties to AWS::AppMesh::VirtualNode.
	CfnVirtualNodePropsMixin(CfnVirtualNodeMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::AppMesh::VirtualNode.
protected	CfnVirtualNodePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVirtualNodePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnVirtualNodeMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnVirtualNodePropsMixin

protected CfnVirtualNodePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnVirtualNodePropsMixin

protected CfnVirtualNodePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnVirtualNodePropsMixin

@Stability(Stable)
public CfnVirtualNodePropsMixin(@NotNull
 CfnVirtualNodeMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::AppMesh::VirtualNode.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnVirtualNodePropsMixin

@Stability(Stable)
public CfnVirtualNodePropsMixin(@NotNull
 CfnVirtualNodeMixinProps props)

Create a mixin to apply properties to AWS::AppMesh::VirtualNode.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnVirtualNodeMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()