@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-28T21:34:27.644Z")
public class CfnVirtualGateway
extends CfnResource
implements IInspectable
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();
| Modifier and Type | Class and Description |
|---|---|
static 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 AWS 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 AWS 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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnVirtualGateway(Construct scope,
java.lang.String id,
CfnVirtualGatewayProps props)
Create a new `AWS::AppMesh::VirtualGateway`.
|
protected |
CfnVirtualGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnVirtualGateway(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getAttrArn()
The full Amazon Resource Name (ARN) for the virtual gateway.
|
java.lang.String |
getAttrMeshName()
The name of the service mesh that the virtual gateway resides in.
|
java.lang.String |
getAttrMeshOwner()
The AWS IAM account ID of the service mesh owner.
|
java.lang.String |
getAttrResourceOwner()
The AWS IAM account ID of the resource owner.
|
java.lang.String |
getAttrUid()
The unique identifier for the virtual gateway.
|
java.lang.String |
getAttrVirtualGatewayName()
The name of the virtual gateway.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getMeshName()
The name of the service mesh that the virtual gateway resides in.
|
java.lang.String |
getMeshOwner()
The AWS IAM account ID of the service mesh owner.
|
java.lang.Object |
getSpec()
The specifications of the virtual gateway.
|
TagManager |
getTags()
Optional metadata that you can apply to the virtual gateway to assist with categorization and organization.
|
java.lang.String |
getVirtualGatewayName()
The name of the virtual gateway.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setMeshName(java.lang.String value)
The name of the service mesh that the virtual gateway resides in.
|
void |
setMeshOwner(java.lang.String value)
The AWS IAM account ID of the service mesh owner.
|
void |
setSpec(CfnVirtualGateway.VirtualGatewaySpecProperty value)
The specifications of the virtual gateway.
|
void |
setSpec(IResolvable value)
The specifications of the virtual gateway.
|
void |
setVirtualGatewayName(java.lang.String value)
The name of the virtual gateway.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatepublic static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnVirtualGateway(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnVirtualGateway(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnVirtualGateway(Construct scope, java.lang.String id, CfnVirtualGatewayProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties in class CfnResourceprops - This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrMeshName()
public java.lang.String getAttrMeshOwner()
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 .
public java.lang.String getAttrResourceOwner()
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 .
public java.lang.String getAttrUid()
public java.lang.String getAttrVirtualGatewayName()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties in class CfnResourcepublic TagManager getTags()
Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.
public java.lang.String getMeshName()
public void setMeshName(java.lang.String value)
public java.lang.Object getSpec()
public void setSpec(IResolvable value)
public void setSpec(CfnVirtualGateway.VirtualGatewaySpecProperty value)
public java.lang.String getMeshOwner()
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 .
public void setMeshOwner(java.lang.String value)
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 .
public java.lang.String getVirtualGatewayName()
public void setVirtualGatewayName(java.lang.String value)