Package software.amazon.awscdk.services.appmesh

Class CfnVirtualGateway

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appmesh.CfnVirtualGateway

All Implemented Interfaces:

IInspectable, ITaggable, IVirtualGatewayRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:32.247Z")
@Stability(Stable)
public class CfnVirtualGateway
extends CfnResource
implements IInspectable, IVirtualGatewayRef, ITaggable

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.services.appmesh.*;
 CfnVirtualGateway cfnVirtualGateway = CfnVirtualGateway.Builder.create(this, "MyCfnVirtualGateway")
         .meshName("meshName")
         .spec(VirtualGatewaySpecProperty.builder()
                 .listeners(List.of(VirtualGatewayListenerProperty.builder()
                         .portMapping(VirtualGatewayPortMappingProperty.builder()
                                 .port(123)
                                 .protocol("protocol")
                                 .build())
                         // the properties below are optional
                         .connectionPool(VirtualGatewayConnectionPoolProperty.builder()
                                 .grpc(VirtualGatewayGrpcConnectionPoolProperty.builder()
                                         .maxRequests(123)
                                         .build())
                                 .http(VirtualGatewayHttpConnectionPoolProperty.builder()
                                         .maxConnections(123)
                                         // the properties below are optional
                                         .maxPendingRequests(123)
                                         .build())
                                 .http2(VirtualGatewayHttp2ConnectionPoolProperty.builder()
                                         .maxRequests(123)
                                         .build())
                                 .build())
                         .healthCheck(VirtualGatewayHealthCheckPolicyProperty.builder()
                                 .healthyThreshold(123)
                                 .intervalMillis(123)
                                 .protocol("protocol")
                                 .timeoutMillis(123)
                                 .unhealthyThreshold(123)
                                 // the properties below are optional
                                 .path("path")
                                 .port(123)
                                 .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")
                                 // the properties below are optional
                                 .validation(VirtualGatewayListenerTlsValidationContextProperty.builder()
                                         .trust(VirtualGatewayListenerTlsValidationContextTrustProperty.builder()
                                                 .file(VirtualGatewayTlsValidationContextFileTrustProperty.builder()
                                                         .certificateChain("certificateChain")
                                                         .build())
                                                 .sds(VirtualGatewayTlsValidationContextSdsTrustProperty.builder()
                                                         .secretName("secretName")
                                                         .build())
                                                 .build())
                                         // the properties below are optional
                                         .subjectAlternativeNames(SubjectAlternativeNamesProperty.builder()
                                                 .match(SubjectAlternativeNameMatchersProperty.builder()
                                                         .exact(List.of("exact"))
                                                         .build())
                                                 .build())
                                         .build())
                                 .build())
                         .build()))
                 // the properties below are optional
                 .backendDefaults(VirtualGatewayBackendDefaultsProperty.builder()
                         .clientPolicy(VirtualGatewayClientPolicyProperty.builder()
                                 .tls(VirtualGatewayClientPolicyTlsProperty.builder()
                                         .validation(VirtualGatewayTlsValidationContextProperty.builder()
                                                 .trust(VirtualGatewayTlsValidationContextTrustProperty.builder()
                                                         .acm(VirtualGatewayTlsValidationContextAcmTrustProperty.builder()
                                                                 .certificateAuthorityArns(List.of("certificateAuthorityArns"))
                                                                 .build())
                                                         .file(VirtualGatewayTlsValidationContextFileTrustProperty.builder()
                                                                 .certificateChain("certificateChain")
                                                                 .build())
                                                         .sds(VirtualGatewayTlsValidationContextSdsTrustProperty.builder()
                                                                 .secretName("secretName")
                                                                 .build())
                                                         .build())
                                                 // the properties below are optional
                                                 .subjectAlternativeNames(SubjectAlternativeNamesProperty.builder()
                                                         .match(SubjectAlternativeNameMatchersProperty.builder()
                                                                 .exact(List.of("exact"))
                                                                 .build())
                                                         .build())
                                                 .build())
                                         // the properties below are optional
                                         .certificate(VirtualGatewayClientTlsCertificateProperty.builder()
                                                 .file(VirtualGatewayListenerTlsFileCertificateProperty.builder()
                                                         .certificateChain("certificateChain")
                                                         .privateKey("privateKey")
                                                         .build())
                                                 .sds(VirtualGatewayListenerTlsSdsCertificateProperty.builder()
                                                         .secretName("secretName")
                                                         .build())
                                                 .build())
                                         .enforce(false)
                                         .ports(List.of(123))
                                         .build())
                                 .build())
                         .build())
                 .logging(VirtualGatewayLoggingProperty.builder()
                         .accessLog(VirtualGatewayAccessLogProperty.builder()
                                 .file(VirtualGatewayFileAccessLogProperty.builder()
                                         .path("path")
                                         // the properties below are optional
                                         .format(LoggingFormatProperty.builder()
                                                 .json(List.of(JsonFormatRefProperty.builder()
                                                         .key("key")
                                                         .value("value")
                                                         .build()))
                                                 .text("text")
                                                 .build())
                                         .build())
                                 .build())
                         .build())
                 .build())
         // the properties below are optional
         .meshOwner("meshOwner")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .virtualGatewayName("virtualGatewayName")
         .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	CfnVirtualGateway.Builder	A fluent builder for CfnVirtualGateway.
static interface	CfnVirtualGateway.JsonFormatRefProperty	An object that represents the key value pairs for the JSON.
static interface	CfnVirtualGateway.LoggingFormatProperty	An object that represents the format for the logs.
static interface	CfnVirtualGateway.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	CfnVirtualGateway.SubjectAlternativeNamesProperty	An object that represents the subject alternative names secured by the certificate.
static interface	CfnVirtualGateway.VirtualGatewayAccessLogProperty	The access log configuration for a virtual gateway.
static interface	CfnVirtualGateway.VirtualGatewayBackendDefaultsProperty	An object that represents the default properties for a backend.
static interface	CfnVirtualGateway.VirtualGatewayClientPolicyProperty	An object that represents a client policy.
static interface	CfnVirtualGateway.VirtualGatewayClientPolicyTlsProperty	An object that represents a Transport Layer Security (TLS) client policy.
static interface	CfnVirtualGateway.VirtualGatewayClientTlsCertificateProperty	An object that represents the virtual gateway's client's Transport Layer Security (TLS) certificate.
static interface	CfnVirtualGateway.VirtualGatewayConnectionPoolProperty	An object that represents the type of virtual gateway connection pool.
static interface	CfnVirtualGateway.VirtualGatewayFileAccessLogProperty	An object that represents an access log file.
static interface	CfnVirtualGateway.VirtualGatewayGrpcConnectionPoolProperty	An object that represents a type of connection pool.
static interface	CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty	An object that represents the health check policy for a virtual gateway's listener.
static interface	CfnVirtualGateway.VirtualGatewayHttp2ConnectionPoolProperty	An object that represents a type of connection pool.
static interface	CfnVirtualGateway.VirtualGatewayHttpConnectionPoolProperty	An object that represents a type of connection pool.
static interface	CfnVirtualGateway.VirtualGatewayListenerProperty	An object that represents a listener for a virtual gateway.
static interface	CfnVirtualGateway.VirtualGatewayListenerTlsAcmCertificateProperty	An object that represents an Certificate Manager certificate.
static interface	CfnVirtualGateway.VirtualGatewayListenerTlsCertificateProperty	An object that represents a listener's Transport Layer Security (TLS) certificate.
static interface	CfnVirtualGateway.VirtualGatewayListenerTlsFileCertificateProperty	An object that represents a local file certificate.
static interface	CfnVirtualGateway.VirtualGatewayListenerTlsProperty	An object that represents the Transport Layer Security (TLS) properties for a listener.
static interface	CfnVirtualGateway.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	CfnVirtualGateway.VirtualGatewayListenerTlsValidationContextProperty	An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context.
static interface	CfnVirtualGateway.VirtualGatewayListenerTlsValidationContextTrustProperty	An object that represents a virtual gateway's listener's Transport Layer Security (TLS) validation context trust.
static interface	CfnVirtualGateway.VirtualGatewayLoggingProperty	An object that represents logging information.
static interface	CfnVirtualGateway.VirtualGatewayPortMappingProperty	An object that represents a port mapping.
static interface	CfnVirtualGateway.VirtualGatewaySpecProperty	An object that represents the specification of a service mesh resource.
static interface	CfnVirtualGateway.VirtualGatewayTlsValidationContextAcmTrustProperty	An object that represents a Transport Layer Security (TLS) validation context trust for an Certificate Manager certificate.
static interface	CfnVirtualGateway.VirtualGatewayTlsValidationContextFileTrustProperty	An object that represents a Transport Layer Security (TLS) validation context trust for a local file.
static interface	CfnVirtualGateway.VirtualGatewayTlsValidationContextProperty	An object that represents a Transport Layer Security (TLS) validation context.
static interface	CfnVirtualGateway.VirtualGatewayTlsValidationContextSdsTrustProperty	An object that represents a virtual gateway's listener's Transport Layer Security (TLS) Secret Discovery Service validation context trust.
static interface	CfnVirtualGateway.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.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appmesh.IVirtualGatewayRef

IVirtualGatewayRef.Jsii$Default, IVirtualGatewayRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnVirtualGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnVirtualGateway(software.amazon.jsii.JsiiObjectRef objRef)
	CfnVirtualGateway(software.constructs.Construct scope, String id, CfnVirtualGatewayProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The full Amazon Resource Name (ARN) for the virtual gateway.
String	getAttrId()
String	getAttrMeshName()	The name of the service mesh that the virtual gateway resides in.
String	getAttrMeshOwner()	The AWS IAM account ID of the service mesh owner.
String	getAttrResourceOwner()	The AWS IAM account ID of the resource owner.
String	getAttrUid()	The unique identifier for the virtual gateway.
String	getAttrVirtualGatewayName()	The name of the virtual gateway.
protected Map<String,Object>	getCfnProperties()
String	getMeshName()	The name of the service mesh that the virtual gateway resides in.
String	getMeshOwner()	The AWS IAM account ID of the service mesh owner.
Object	getSpec()	The specifications of the virtual gateway.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Optional metadata that you can apply to the virtual gateway to assist with categorization and organization.
String	getVirtualGatewayName()	The name of the virtual gateway.
VirtualGatewayReference	getVirtualGatewayRef()	A reference to a VirtualGateway resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setMeshName(String value)	The name of the service mesh that the virtual gateway resides in.
void	setMeshOwner(String value)	The AWS IAM account ID of the service mesh owner.
void	setSpec(IResolvable value)	The specifications of the virtual gateway.
void	setSpec(CfnVirtualGateway.VirtualGatewaySpecProperty value)	The specifications of the virtual gateway.
void	setTagsRaw(List<CfnTag> value)	Optional metadata that you can apply to the virtual gateway to assist with categorization and organization.
void	setVirtualGatewayName(String value)	The name of the virtual gateway.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnVirtualGateway

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

CfnVirtualGateway

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

CfnVirtualGateway

@Stability(Stable)
public CfnVirtualGateway(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnVirtualGatewayProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The full Amazon Resource Name (ARN) for the virtual gateway.

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

getAttrMeshName

@Stability(Stable)
@NotNull
public String getAttrMeshName()

The name of the service mesh that the virtual gateway resides in.

getAttrMeshOwner

@Stability(Stable)
@NotNull
public String getAttrMeshOwner()

The AWS IAM account ID of the service mesh owner.

If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with Shared Meshes .

getAttrResourceOwner

@Stability(Stable)
@NotNull
public String getAttrResourceOwner()

The AWS IAM account ID of the resource owner.

If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with Shared Meshes .

getAttrUid

@Stability(Stable)
@NotNull
public String getAttrUid()

The unique identifier for the virtual gateway.

getAttrVirtualGatewayName

@Stability(Stable)
@NotNull
public String getAttrVirtualGatewayName()

The name of the virtual gateway.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getVirtualGatewayRef

@Stability(Stable)
@NotNull
public VirtualGatewayReference getVirtualGatewayRef()

A reference to a VirtualGateway resource.

Specified by:

getVirtualGatewayRef in interface IVirtualGatewayRef

getMeshName

@Stability(Stable)
@NotNull
public String getMeshName()

The name of the service mesh that the virtual gateway resides in.

setMeshName

@Stability(Stable)
public void setMeshName(@NotNull
 String value)

The name of the service mesh that the virtual gateway resides in.

getSpec

@Stability(Stable)
@NotNull
public Object getSpec()

The specifications of the virtual gateway.

Returns union: either IResolvable or CfnVirtualGateway.VirtualGatewaySpecProperty

setSpec

@Stability(Stable)
public void setSpec(@NotNull
 IResolvable value)

The specifications of the virtual gateway.

setSpec

@Stability(Stable)
public void setSpec(@NotNull
 CfnVirtualGateway.VirtualGatewaySpecProperty value)

The specifications of the virtual gateway.

getMeshOwner

@Stability(Stable)
@Nullable
public String getMeshOwner()

The AWS IAM account ID of the service mesh owner.

setMeshOwner

@Stability(Stable)
public void setMeshOwner(@Nullable
 String value)

The AWS IAM account ID of the service mesh owner.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

Optional metadata that you can apply to the virtual gateway to assist with categorization and organization.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

Optional metadata that you can apply to the virtual gateway to assist with categorization and organization.

getVirtualGatewayName

@Stability(Stable)
@Nullable
public String getVirtualGatewayName()

The name of the virtual gateway.

setVirtualGatewayName

@Stability(Stable)
public void setVirtualGatewayName(@Nullable
 String value)

The name of the virtual gateway.