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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:15.924Z")
 @Stability(value=Stable)
public class CfnVirtualGateway
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppMesh::VirtualGateway`.

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")
                                         .build())
                                 .build())
                         .build())
                 .build())
         // the properties below are optional
         .meshOwner("meshOwner")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .virtualGatewayName("virtualGatewayName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnVirtualGateway.Builder A fluent builder for CfnVirtualGateway.
static interface	CfnVirtualGateway.SubjectAlternativeNameMatchersProperty Example:
static interface	CfnVirtualGateway.SubjectAlternativeNamesProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayAccessLogProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayBackendDefaultsProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayClientPolicyProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayClientPolicyTlsProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayClientTlsCertificateProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayConnectionPoolProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayFileAccessLogProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayGrpcConnectionPoolProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayHealthCheckPolicyProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayHttp2ConnectionPoolProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayHttpConnectionPoolProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayListenerProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayListenerTlsAcmCertificateProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayListenerTlsCertificateProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayListenerTlsFileCertificateProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayListenerTlsProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayListenerTlsSdsCertificateProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayListenerTlsValidationContextProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayListenerTlsValidationContextTrustProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayLoggingProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayPortMappingProperty Example:
static interface	CfnVirtualGateway.VirtualGatewaySpecProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayTlsValidationContextAcmTrustProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayTlsValidationContextFileTrustProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayTlsValidationContextProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayTlsValidationContextSdsTrustProperty Example:
static interface	CfnVirtualGateway.VirtualGatewayTlsValidationContextTrustProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnVirtualGateway(software.constructs.Construct scope, 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)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrMeshName()
String	getAttrMeshOwner()
String	getAttrResourceOwner()
String	getAttrUid()
String	getAttrVirtualGatewayName()
protected Map<String,Object>	getCfnProperties()
String	getMeshName() `AWS::AppMesh::VirtualGateway.MeshName`.
String	getMeshOwner() `AWS::AppMesh::VirtualGateway.MeshOwner`.
Object	getSpec() `AWS::AppMesh::VirtualGateway.Spec`.
TagManager	getTags() `AWS::AppMesh::VirtualGateway.Tags`.
String	getVirtualGatewayName() `AWS::AppMesh::VirtualGateway.VirtualGatewayName`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setMeshName(String value) `AWS::AppMesh::VirtualGateway.MeshName`.
void	setMeshOwner(String value) `AWS::AppMesh::VirtualGateway.MeshOwner`.
void	setSpec(CfnVirtualGateway.VirtualGatewaySpecProperty value) `AWS::AppMesh::VirtualGateway.Spec`.
void	setSpec(IResolvable value) `AWS::AppMesh::VirtualGateway.Spec`.
void	setVirtualGatewayName(String value) `AWS::AppMesh::VirtualGateway.VirtualGatewayName`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, 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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnVirtualGateway

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

CfnVirtualGateway

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

CfnVirtualGateway

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

Create a new `AWS::AppMesh::VirtualGateway`.

Parameters:

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.

Method Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

getAttrMeshName

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

getAttrMeshOwner

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

getAttrResourceOwner

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

getAttrUid

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

getAttrVirtualGatewayName

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getMeshName

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

`AWS::AppMesh::VirtualGateway.MeshName`.

setMeshName

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

`AWS::AppMesh::VirtualGateway.MeshName`.

getMeshOwner

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

`AWS::AppMesh::VirtualGateway.MeshOwner`.

setMeshOwner

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

`AWS::AppMesh::VirtualGateway.MeshOwner`.

getSpec

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

`AWS::AppMesh::VirtualGateway.Spec`.

setSpec

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

`AWS::AppMesh::VirtualGateway.Spec`.

setSpec

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

`AWS::AppMesh::VirtualGateway.Spec`.

getTags

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

`AWS::AppMesh::VirtualGateway.Tags`.

getVirtualGatewayName

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

`AWS::AppMesh::VirtualGateway.VirtualGatewayName`.

setVirtualGatewayName

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

`AWS::AppMesh::VirtualGateway.VirtualGatewayName`.