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

Class CfnVirtualGatewayPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.appmesh.CfnVirtualGatewayPropsMixin

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.812Z")
@Stability(Stable)
public class CfnVirtualGatewayPropsMixin
extends Mixin
implements software.constructs.IMixin

Creates a virtual gateway.

A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself.

For more information about virtual gateways, see Virtual gateways .

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;
 CfnVirtualGatewayPropsMixin cfnVirtualGatewayPropsMixin = CfnVirtualGatewayPropsMixin.Builder.create(CfnVirtualGatewayMixinProps.builder()
         .meshName("meshName")
         .meshOwner("meshOwner")
         .spec(VirtualGatewaySpecProperty.builder()
                 .backendDefaults(VirtualGatewayBackendDefaultsProperty.builder()
                         .clientPolicy(VirtualGatewayClientPolicyProperty.builder()
                                 .tls(VirtualGatewayClientPolicyTlsProperty.builder()
                                         .certificate(VirtualGatewayClientTlsCertificateProperty.builder()
                                                 .file(VirtualGatewayListenerTlsFileCertificateProperty.builder()
                                                         .certificateChain("certificateChain")
                                                         .privateKey("privateKey")
                                                         .build())
                                                 .sds(VirtualGatewayListenerTlsSdsCertificateProperty.builder()
                                                         .secretName("secretName")
                                                         .build())
                                                 .build())
                                         .enforce(false)
                                         .ports(List.of(123))
                                         .validation(VirtualGatewayTlsValidationContextProperty.builder()
                                                 .subjectAlternativeNames(SubjectAlternativeNamesProperty.builder()
                                                         .match(SubjectAlternativeNameMatchersProperty.builder()
                                                                 .exact(List.of("exact"))
                                                                 .build())
                                                         .build())
                                                 .trust(VirtualGatewayTlsValidationContextTrustProperty.builder()
                                                         .acm(VirtualGatewayTlsValidationContextAcmTrustProperty.builder()
                                                                 .certificateAuthorityArns(List.of("certificateAuthorityArns"))
                                                                 .build())
                                                         .file(VirtualGatewayTlsValidationContextFileTrustProperty.builder()
                                                                 .certificateChain("certificateChain")
                                                                 .build())
                                                         .sds(VirtualGatewayTlsValidationContextSdsTrustProperty.builder()
                                                                 .secretName("secretName")
                                                                 .build())
                                                         .build())
                                                 .build())
                                         .build())
                                 .build())
                         .build())
                 .listeners(List.of(VirtualGatewayListenerProperty.builder()
                         .connectionPool(VirtualGatewayConnectionPoolProperty.builder()
                                 .grpc(VirtualGatewayGrpcConnectionPoolProperty.builder()
                                         .maxRequests(123)
                                         .build())
                                 .http(VirtualGatewayHttpConnectionPoolProperty.builder()
                                         .maxConnections(123)
                                         .maxPendingRequests(123)
                                         .build())
                                 .http2(VirtualGatewayHttp2ConnectionPoolProperty.builder()
                                         .maxRequests(123)
                                         .build())
                                 .build())
                         .healthCheck(VirtualGatewayHealthCheckPolicyProperty.builder()
                                 .healthyThreshold(123)
                                 .intervalMillis(123)
                                 .path("path")
                                 .port(123)
                                 .protocol("protocol")
                                 .timeoutMillis(123)
                                 .unhealthyThreshold(123)
                                 .build())
                         .portMapping(VirtualGatewayPortMappingProperty.builder()
                                 .port(123)
                                 .protocol("protocol")
                                 .build())
                         .tls(VirtualGatewayListenerTlsProperty.builder()
                                 .certificate(VirtualGatewayListenerTlsCertificateProperty.builder()
                                         .acm(VirtualGatewayListenerTlsAcmCertificateProperty.builder()
                                                 .certificateArn("certificateArn")
                                                 .build())
                                         .file(VirtualGatewayListenerTlsFileCertificateProperty.builder()
                                                 .certificateChain("certificateChain")
                                                 .privateKey("privateKey")
                                                 .build())
                                         .sds(VirtualGatewayListenerTlsSdsCertificateProperty.builder()
                                                 .secretName("secretName")
                                                 .build())
                                         .build())
                                 .mode("mode")
                                 .validation(VirtualGatewayListenerTlsValidationContextProperty.builder()
                                         .subjectAlternativeNames(SubjectAlternativeNamesProperty.builder()
                                                 .match(SubjectAlternativeNameMatchersProperty.builder()
                                                         .exact(List.of("exact"))
                                                         .build())
                                                 .build())
                                         .trust(VirtualGatewayListenerTlsValidationContextTrustProperty.builder()
                                                 .file(VirtualGatewayTlsValidationContextFileTrustProperty.builder()
                                                         .certificateChain("certificateChain")
                                                         .build())
                                                 .sds(VirtualGatewayTlsValidationContextSdsTrustProperty.builder()
                                                         .secretName("secretName")
                                                         .build())
                                                 .build())
                                         .build())
                                 .build())
                         .build()))
                 .logging(VirtualGatewayLoggingProperty.builder()
                         .accessLog(VirtualGatewayAccessLogProperty.builder()
                                 .file(VirtualGatewayFileAccessLogProperty.builder()
                                         .format(LoggingFormatProperty.builder()
                                                 .json(List.of(JsonFormatRefProperty.builder()
                                                         .key("key")
                                                         .value("value")
                                                         .build()))
                                                 .text("text")
                                                 .build())
                                         .path("path")
                                         .build())
                                 .build())
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .virtualGatewayName("virtualGatewayName")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnVirtualGatewayPropsMixin.Builder	A fluent builder for CfnVirtualGatewayPropsMixin.
static interface	CfnVirtualGatewayPropsMixin.JsonFormatRefProperty	An object that represents the key value pairs for the JSON.
static interface	CfnVirtualGatewayPropsMixin.LoggingFormatProperty	An object that represents the format for the logs.
static interface	CfnVirtualGatewayPropsMixin.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	CfnVirtualGatewayPropsMixin.SubjectAlternativeNamesProperty	An object that represents the subject alternative names secured by the certificate.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayAccessLogProperty	The access log configuration for a virtual gateway.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayBackendDefaultsProperty	An object that represents the default properties for a backend.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayClientPolicyProperty	An object that represents a client policy.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayClientPolicyTlsProperty	An object that represents a Transport Layer Security (TLS) client policy.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayClientTlsCertificateProperty	An object that represents the virtual gateway's client's Transport Layer Security (TLS) certificate.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayConnectionPoolProperty	An object that represents the type of virtual gateway connection pool.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayFileAccessLogProperty	An object that represents an access log file.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayGrpcConnectionPoolProperty	An object that represents a type of connection pool.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayHealthCheckPolicyProperty	An object that represents the health check policy for a virtual gateway's listener.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayHttp2ConnectionPoolProperty	An object that represents a type of connection pool.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayHttpConnectionPoolProperty	An object that represents a type of connection pool.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayListenerProperty	An object that represents a listener for a virtual gateway.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsAcmCertificateProperty	An object that represents an Certificate Manager certificate.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsCertificateProperty	An object that represents a listener's Transport Layer Security (TLS) certificate.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsFileCertificateProperty	An object that represents a local file certificate.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsProperty	An object that represents the Transport Layer Security (TLS) properties for a listener.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsSdsCertificateProperty	An object that represents the virtual gateway's listener's Secret Discovery Service certificate.The proxy must be configured with a local SDS provider via a Unix Domain Socket.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextProperty	An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayListenerTlsValidationContextTrustProperty	An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context trust.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayLoggingProperty	An object that represents logging information.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayPortMappingProperty	An object that represents a port mapping.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewaySpecProperty	An object that represents the specification of a service mesh resource.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextAcmTrustProperty	An object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextFileTrustProperty	An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextProperty	An object that represents a Transport Layer Security (TLS) validation context.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextSdsTrustProperty	An object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
static interface	CfnVirtualGatewayPropsMixin.VirtualGatewayTlsValidationContextTrustProperty	An object that represents a Transport Layer Security (TLS) validation context trust.

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
	CfnVirtualGatewayPropsMixin(CfnVirtualGatewayMixinProps props)	Create a mixin to apply properties to AWS::AppMesh::VirtualGateway.
	CfnVirtualGatewayPropsMixin(CfnVirtualGatewayMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::AppMesh::VirtualGateway.
protected	CfnVirtualGatewayPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVirtualGatewayPropsMixin(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 CfnVirtualGatewayMixinProps	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

CfnVirtualGatewayPropsMixin

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

CfnVirtualGatewayPropsMixin

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

CfnVirtualGatewayPropsMixin

@Stability(Stable)
public CfnVirtualGatewayPropsMixin(@NotNull
 CfnVirtualGatewayMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

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

Parameters:

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

options - Mixin options.

CfnVirtualGatewayPropsMixin

@Stability(Stable)
public CfnVirtualGatewayPropsMixin(@NotNull
 CfnVirtualGatewayMixinProps props)

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

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 CfnVirtualGatewayMixinProps getProps()

getStrategy

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