Class Http2GatewayListenerOptions

Represents the properties needed to define HTTP2 Listeners for a VirtualGateway.

Inheritance

object

Http2GatewayListenerOptions

Implements

IHttp2GatewayListenerOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AppMesh

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class Http2GatewayListenerOptions : IHttp2GatewayListenerOptions

Syntax (vb)

Public Class Http2GatewayListenerOptions Implements IHttp2GatewayListenerOptions

Remarks

ExampleMetadata: infused

Examples

// A Virtual Node with listener TLS from an ACM provided certificate
            Certificate cert;
            Mesh mesh;


            var node = new VirtualNode(this, "node", new VirtualNodeProps {
                Mesh = mesh,
                ServiceDiscovery = ServiceDiscovery.Dns("node"),
                Listeners = new [] { VirtualNodeListener.Grpc(new GrpcVirtualNodeListenerOptions {
                    Port = 80,
                    Tls = new ListenerTlsOptions {
                        Mode = TlsMode.STRICT,
                        Certificate = TlsCertificate.Acm(cert)
                    }
                }) }
            });

            // A Virtual Gateway with listener TLS from a customer provided file certificate
            var gateway = new VirtualGateway(this, "gateway", new VirtualGatewayProps {
                Mesh = mesh,
                Listeners = new [] { VirtualGatewayListener.Grpc(new GrpcGatewayListenerOptions {
                    Port = 8080,
                    Tls = new ListenerTlsOptions {
                        Mode = TlsMode.STRICT,
                        Certificate = TlsCertificate.File("path/to/certChain", "path/to/privateKey")
                    }
                }) },
                VirtualGatewayName = "gateway"
            });

            // A Virtual Gateway with listener TLS from a SDS provided certificate
            var gateway2 = new VirtualGateway(this, "gateway2", new VirtualGatewayProps {
                Mesh = mesh,
                Listeners = new [] { VirtualGatewayListener.Http2(new Http2GatewayListenerOptions {
                    Port = 8080,
                    Tls = new ListenerTlsOptions {
                        Mode = TlsMode.STRICT,
                        Certificate = TlsCertificate.Sds("secrete_certificate")
                    }
                }) },
                VirtualGatewayName = "gateway2"
            });

Synopsis

Constructors

Http2GatewayListenerOptions()

Represents the properties needed to define HTTP2 Listeners for a VirtualGateway.

Properties

ConnectionPool	Connection pool for http listeners.
HealthCheck	The health check information for the listener.
Port	Port to listen for connections on.
Tls	Represents the configuration for enabling TLS on a listener.

Constructors

Http2GatewayListenerOptions()

Represents the properties needed to define HTTP2 Listeners for a VirtualGateway.

public Http2GatewayListenerOptions()

Remarks

ExampleMetadata: infused

Examples

// A Virtual Node with listener TLS from an ACM provided certificate
            Certificate cert;
            Mesh mesh;


            var node = new VirtualNode(this, "node", new VirtualNodeProps {
                Mesh = mesh,
                ServiceDiscovery = ServiceDiscovery.Dns("node"),
                Listeners = new [] { VirtualNodeListener.Grpc(new GrpcVirtualNodeListenerOptions {
                    Port = 80,
                    Tls = new ListenerTlsOptions {
                        Mode = TlsMode.STRICT,
                        Certificate = TlsCertificate.Acm(cert)
                    }
                }) }
            });

            // A Virtual Gateway with listener TLS from a customer provided file certificate
            var gateway = new VirtualGateway(this, "gateway", new VirtualGatewayProps {
                Mesh = mesh,
                Listeners = new [] { VirtualGatewayListener.Grpc(new GrpcGatewayListenerOptions {
                    Port = 8080,
                    Tls = new ListenerTlsOptions {
                        Mode = TlsMode.STRICT,
                        Certificate = TlsCertificate.File("path/to/certChain", "path/to/privateKey")
                    }
                }) },
                VirtualGatewayName = "gateway"
            });

            // A Virtual Gateway with listener TLS from a SDS provided certificate
            var gateway2 = new VirtualGateway(this, "gateway2", new VirtualGatewayProps {
                Mesh = mesh,
                Listeners = new [] { VirtualGatewayListener.Http2(new Http2GatewayListenerOptions {
                    Port = 8080,
                    Tls = new ListenerTlsOptions {
                        Mode = TlsMode.STRICT,
                        Certificate = TlsCertificate.Sds("secrete_certificate")
                    }
                }) },
                VirtualGatewayName = "gateway2"
            });

Properties

ConnectionPool

Connection pool for http listeners.

public IHttp2ConnectionPool? ConnectionPool { get; set; }

Property Value

IHttp2ConnectionPool

Remarks

Default: - None

HealthCheck

The health check information for the listener.

public HealthCheck? HealthCheck { get; set; }

Property Value

HealthCheck

Remarks

Default: - no healthcheck

Port

Port to listen for connections on.

public double? Port { get; set; }

Property Value

double?

Remarks

Default: - 8080

Tls

Represents the configuration for enabling TLS on a listener.

public IListenerTlsOptions? Tls { get; set; }

Property Value

IListenerTlsOptions

Remarks

Default: - none

Implements

IHttp2GatewayListenerOptions