Class HttpGatewayListenerOptions

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

Inheritance
object
HttpGatewayListenerOptions
Inherited Members
Namespace: Amazon.CDK.AWS.AppMesh
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class HttpGatewayListenerOptions : IHttpGatewayListenerOptions
Syntax (vb)
Public Class HttpGatewayListenerOptions Implements IHttpGatewayListenerOptions
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

HttpGatewayListenerOptions()

Represents the properties needed to define HTTP 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

HttpGatewayListenerOptions()

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

public HttpGatewayListenerOptions()
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"
            });

Properties

ConnectionPool

Connection pool for http listeners.

public IHttpConnectionPool? ConnectionPool { get; set; }
Property Value

IHttpConnectionPool

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