Package software.amazon.awscdk.services.appmesh

Class VirtualGatewayListener

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appmesh.VirtualGatewayListener

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-09-06T01:36:23.430Z")
@Stability(Stable)
public abstract class VirtualGatewayListener
extends software.amazon.jsii.JsiiObject

Represents the properties needed to define listeners for a VirtualGateway.

Example:

 Mesh mesh;
 String certificateAuthorityArn = "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012";
 VirtualGateway gateway = VirtualGateway.Builder.create(this, "gateway")
         .mesh(mesh)
         .listeners(List.of(VirtualGatewayListener.http(HttpGatewayListenerOptions.builder()
                 .port(443)
                 .healthCheck(HealthCheck.http(HttpHealthCheckOptions.builder()
                         .interval(Duration.seconds(10))
                         .build()))
                 .build())))
         .backendDefaults(BackendDefaults.builder()
                 .tlsClientPolicy(TlsClientPolicy.builder()
                         .ports(List.of(8080, 8081))
                         .validation(TlsValidation.builder()
                                 .trust(TlsValidationTrust.acm(List.of(CertificateAuthority.fromCertificateAuthorityArn(this, "certificate", certificateAuthorityArn))))
                                 .build())
                         .build())
                 .build())
         .accessLog(AccessLog.fromFilePath("/dev/stdout"))
         .virtualGatewayName("virtualGateway")
         .build();
 

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	VirtualGatewayListener()
protected	VirtualGatewayListener(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	VirtualGatewayListener(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
abstract VirtualGatewayListenerConfig	bind(software.constructs.Construct scope)	Called when the GatewayListener type is initialized.
static VirtualGatewayListener	grpc()	Returns a GRPC Listener for a VirtualGateway.
static VirtualGatewayListener	grpc(GrpcGatewayListenerOptions options)	Returns a GRPC Listener for a VirtualGateway.
static VirtualGatewayListener	http()	Returns an HTTP Listener for a VirtualGateway.
static VirtualGatewayListener	http(HttpGatewayListenerOptions options)	Returns an HTTP Listener for a VirtualGateway.
static VirtualGatewayListener	http2()	Returns an HTTP2 Listener for a VirtualGateway.
static VirtualGatewayListener	http2(Http2GatewayListenerOptions options)	Returns an HTTP2 Listener for a VirtualGateway.

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

VirtualGatewayListener

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

VirtualGatewayListener

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

VirtualGatewayListener

@Stability(Stable)
protected VirtualGatewayListener()

Method Details

grpc

@Stability(Stable)
@NotNull
public static VirtualGatewayListener grpc(@Nullable
 GrpcGatewayListenerOptions options)

Returns a GRPC Listener for a VirtualGateway.

Parameters:

options -

grpc

@Stability(Stable)
@NotNull
public static VirtualGatewayListener grpc()

Returns a GRPC Listener for a VirtualGateway.

http

@Stability(Stable)
@NotNull
public static VirtualGatewayListener http(@Nullable
 HttpGatewayListenerOptions options)

Returns an HTTP Listener for a VirtualGateway.

Parameters:

options -

http

@Stability(Stable)
@NotNull
public static VirtualGatewayListener http()

Returns an HTTP Listener for a VirtualGateway.

http2

@Stability(Stable)
@NotNull
public static VirtualGatewayListener http2(@Nullable
 Http2GatewayListenerOptions options)

Returns an HTTP2 Listener for a VirtualGateway.

Parameters:

options -

http2

@Stability(Stable)
@NotNull
public static VirtualGatewayListener http2()

Returns an HTTP2 Listener for a VirtualGateway.

bind

@Stability(Stable)
@NotNull
public abstract VirtualGatewayListenerConfig bind(@NotNull
 software.constructs.Construct scope)

Called when the GatewayListener type is initialized.

Can be used to enforce mutual exclusivity

Parameters:

scope - This parameter is required.