Class VirtualGatewayListener

Represents the properties needed to define listeners for a VirtualGateway.

Inheritance

object

VirtualGatewayListener

Namespace: Amazon.CDK.AWS.AppMesh

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public abstract class VirtualGatewayListener : DeputyBase

Syntax (vb)

Public MustInherit Class VirtualGatewayListener Inherits DeputyBase

Remarks

ExampleMetadata: infused

Examples

Mesh mesh;

            var certificateAuthorityArn = "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012";

            var gateway = new VirtualGateway(this, "gateway", new VirtualGatewayProps {
                Mesh = mesh,
                Listeners = new [] { VirtualGatewayListener.Http(new HttpGatewayListenerOptions {
                    Port = 443,
                    HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
                        Interval = Duration.Seconds(10)
                    })
                }) },
                BackendDefaults = new BackendDefaults {
                    TlsClientPolicy = new TlsClientPolicy {
                        Ports = new [] { 8080, 8081 },
                        Validation = new TlsValidation {
                            Trust = TlsValidationTrust.Acm(new [] { CertificateAuthority.FromCertificateAuthorityArn(this, "certificate", certificateAuthorityArn) })
                        }
                    }
                },
                AccessLog = AccessLog.FromFilePath("/dev/stdout"),
                VirtualGatewayName = "virtualGateway"
            });

Synopsis

Constructors

VirtualGatewayListener()

Represents the properties needed to define listeners for a VirtualGateway.

Methods

Bind(Construct)	Called when the GatewayListener type is initialized.
Grpc(IGrpcGatewayListenerOptions?)	Returns a GRPC Listener for a VirtualGateway.
Http(IHttpGatewayListenerOptions?)	Returns an HTTP Listener for a VirtualGateway.
Http2(IHttp2GatewayListenerOptions?)	Returns an HTTP2 Listener for a VirtualGateway.

Constructors

VirtualGatewayListener()

Represents the properties needed to define listeners for a VirtualGateway.

protected VirtualGatewayListener()

Remarks

ExampleMetadata: infused

Examples

Mesh mesh;

            var certificateAuthorityArn = "arn:aws:acm-pca:us-east-1:123456789012:certificate-authority/12345678-1234-1234-1234-123456789012";

            var gateway = new VirtualGateway(this, "gateway", new VirtualGatewayProps {
                Mesh = mesh,
                Listeners = new [] { VirtualGatewayListener.Http(new HttpGatewayListenerOptions {
                    Port = 443,
                    HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
                        Interval = Duration.Seconds(10)
                    })
                }) },
                BackendDefaults = new BackendDefaults {
                    TlsClientPolicy = new TlsClientPolicy {
                        Ports = new [] { 8080, 8081 },
                        Validation = new TlsValidation {
                            Trust = TlsValidationTrust.Acm(new [] { CertificateAuthority.FromCertificateAuthorityArn(this, "certificate", certificateAuthorityArn) })
                        }
                    }
                },
                AccessLog = AccessLog.FromFilePath("/dev/stdout"),
                VirtualGatewayName = "virtualGateway"
            });

Methods

Bind(Construct)

Called when the GatewayListener type is initialized.

public abstract IVirtualGatewayListenerConfig Bind(Construct scope)

Parameters

scope Construct

Returns

IVirtualGatewayListenerConfig

Remarks

Can be used to enforce mutual exclusivity

Grpc(IGrpcGatewayListenerOptions?)

Returns a GRPC Listener for a VirtualGateway.

public static VirtualGatewayListener Grpc(IGrpcGatewayListenerOptions? options = null)

Parameters

options IGrpcGatewayListenerOptions

Returns

VirtualGatewayListener

Remarks

ExampleMetadata: infused

Http(IHttpGatewayListenerOptions?)

Returns an HTTP Listener for a VirtualGateway.

public static VirtualGatewayListener Http(IHttpGatewayListenerOptions? options = null)

Parameters

options IHttpGatewayListenerOptions

Returns

VirtualGatewayListener

Remarks

ExampleMetadata: infused

Http2(IHttp2GatewayListenerOptions?)

Returns an HTTP2 Listener for a VirtualGateway.

public static VirtualGatewayListener Http2(IHttp2GatewayListenerOptions? options = null)

Parameters

options IHttp2GatewayListenerOptions

Returns

VirtualGatewayListener

Remarks

ExampleMetadata: infused