Class HttpVirtualNodeListenerOptions

Represent the HTTP Node Listener property.

Inheritance

object

HttpVirtualNodeListenerOptions

Implements

IHttpVirtualNodeListenerOptions

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 HttpVirtualNodeListenerOptions : IHttpVirtualNodeListenerOptions

Syntax (vb)

Public Class HttpVirtualNodeListenerOptions Implements IHttpVirtualNodeListenerOptions

Remarks

ExampleMetadata: infused

Examples

Mesh mesh;
            var vpc = new Vpc(this, "vpc");
            var namespace = new PrivateDnsNamespace(this, "test-namespace", new PrivateDnsNamespaceProps {
                Vpc = vpc,
                Name = "domain.local"
            });
            var service = namespace.CreateService("Svc");
            var node = mesh.AddVirtualNode("virtual-node", new VirtualNodeBaseProps {
                ServiceDiscovery = ServiceDiscovery.CloudMap(service),
                Listeners = new [] { VirtualNodeListener.Http(new HttpVirtualNodeListenerOptions {
                    Port = 8081,
                    HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
                        HealthyThreshold = 3,
                        Interval = Duration.Seconds(5),  // minimum
                        Path = "/health-check-path",
                        Timeout = Duration.Seconds(2),  // minimum
                        UnhealthyThreshold = 2
                    })
                }) },
                AccessLog = AccessLog.FromFilePath("/dev/stdout")
            });

Synopsis

Constructors

HttpVirtualNodeListenerOptions()

Represent the HTTP Node Listener property.

Properties

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

Constructors

HttpVirtualNodeListenerOptions()

Represent the HTTP Node Listener property.

public HttpVirtualNodeListenerOptions()

Remarks

ExampleMetadata: infused

Examples

Mesh mesh;
            var vpc = new Vpc(this, "vpc");
            var namespace = new PrivateDnsNamespace(this, "test-namespace", new PrivateDnsNamespaceProps {
                Vpc = vpc,
                Name = "domain.local"
            });
            var service = namespace.CreateService("Svc");
            var node = mesh.AddVirtualNode("virtual-node", new VirtualNodeBaseProps {
                ServiceDiscovery = ServiceDiscovery.CloudMap(service),
                Listeners = new [] { VirtualNodeListener.Http(new HttpVirtualNodeListenerOptions {
                    Port = 8081,
                    HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
                        HealthyThreshold = 3,
                        Interval = Duration.Seconds(5),  // minimum
                        Path = "/health-check-path",
                        Timeout = Duration.Seconds(2),  // minimum
                        UnhealthyThreshold = 2
                    })
                }) },
                AccessLog = AccessLog.FromFilePath("/dev/stdout")
            });

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

OutlierDetection

Represents the configuration for enabling outlier detection.

public IOutlierDetection? OutlierDetection { get; set; }

Property Value

IOutlierDetection

Remarks

Default: - none

Port

Port to listen for connections on.

public double? Port { get; set; }

Property Value

double?

Remarks

Default: - 8080

Timeout

Timeout for HTTP protocol.

public IHttpTimeout? Timeout { get; set; }

Property Value

IHttpTimeout

Remarks

Default: - None

Tls

Represents the configuration for enabling TLS on a listener.

public IListenerTlsOptions? Tls { get; set; }

Property Value

IListenerTlsOptions

Remarks

Default: - none

Implements

IHttpVirtualNodeListenerOptions