Class CfnVirtualGateway

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-10-31T19:12:52.525Z") @Stability(Stable) public class CfnVirtualGateway extends CfnResource implements IInspectable, 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:
  • 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
    • 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.
    • 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.