Package software.amazon.awscdk.services.appmesh

Interface CfnVirtualGateway.VirtualGatewaySpecProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnVirtualGateway.VirtualGatewaySpecProperty.Jsii$Proxy

Enclosing class:

CfnVirtualGateway

@Stability(Stable)
public static interface CfnVirtualGateway.VirtualGatewaySpecProperty
extends software.amazon.jsii.JsiiSerializable

An object that represents the specification of a service mesh resource.

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.*;
 VirtualGatewaySpecProperty virtualGatewaySpecProperty = 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnVirtualGateway.VirtualGatewaySpecProperty.Builder	A builder for CfnVirtualGateway.VirtualGatewaySpecProperty
static final class	CfnVirtualGateway.VirtualGatewaySpecProperty.Jsii$Proxy	An implementation for CfnVirtualGateway.VirtualGatewaySpecProperty

Method Summary

Modifier and Type	Method	Description
static CfnVirtualGateway.VirtualGatewaySpecProperty.Builder	builder()
default Object	getBackendDefaults()	A reference to an object that represents the defaults for backends.
Object	getListeners()	The listeners that the mesh endpoint is expected to receive inbound traffic from.
default Object	getLogging()	An object that represents logging information.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getListeners

@Stability(Stable)
@NotNull
Object getListeners()

The listeners that the mesh endpoint is expected to receive inbound traffic from.

You can specify one listener.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayspec.html#cfn-appmesh-virtualgateway-virtualgatewayspec-listeners

getBackendDefaults

@Stability(Stable)
@Nullable
default Object getBackendDefaults()

A reference to an object that represents the defaults for backends.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayspec.html#cfn-appmesh-virtualgateway-virtualgatewayspec-backenddefaults

getLogging

@Stability(Stable)
@Nullable
default Object getLogging()

An object that represents logging information.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualgateway-virtualgatewayspec.html#cfn-appmesh-virtualgateway-virtualgatewayspec-logging

builder

@Stability(Stable)
static CfnVirtualGateway.VirtualGatewaySpecProperty.Builder builder()

Returns:

a CfnVirtualGateway.VirtualGatewaySpecProperty.Builder of CfnVirtualGateway.VirtualGatewaySpecProperty