Class ListenerTlsOptions

Represents TLS properties for listener.

Inheritance

object

ListenerTlsOptions

Implements

IListenerTlsOptions

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 ListenerTlsOptions : IListenerTlsOptions

Syntax (vb)

Public Class ListenerTlsOptions Implements IListenerTlsOptions

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

ListenerTlsOptions()

Represents TLS properties for listener.

Properties

Certificate	Represents TLS certificate.
Mode	The TLS mode.
MutualTlsValidation	Represents a listener's TLS validation context.

Constructors

ListenerTlsOptions()

Represents TLS properties for listener.

public ListenerTlsOptions()

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

Certificate

Represents TLS certificate.

public TlsCertificate Certificate { get; set; }

Property Value

TlsCertificate

Remarks

ExampleMetadata: infused

Mode

The TLS mode.

public TlsMode Mode { get; set; }

Property Value

TlsMode

Remarks

ExampleMetadata: infused

MutualTlsValidation

Represents a listener's TLS validation context.

public IMutualTlsValidation? MutualTlsValidation { get; set; }

Property Value

IMutualTlsValidation

Remarks

The client certificate will only be validated if the client provides it, enabling mutual TLS.

Default: - client TLS certificate is not required

Implements

IListenerTlsOptions