Interface IServiceConnectService

Interface for service connect Service props.

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IServiceConnectService

Syntax (vb)

Public Interface IServiceConnectService

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;
            using Amazon.CDK.AWS.ECS;
            using Amazon.CDK.AWS.IAM;
            using Amazon.CDK.Interfaces.KMS;

            IKeyRef keyRef;
            Role role;

            var serviceConnectService = new ServiceConnectService {
                PortMappingName = "portMappingName",

                // the properties below are optional
                DiscoveryName = "discoveryName",
                DnsName = "dnsName",
                IdleTimeout = Duration.Minutes(30),
                IngressPortOverride = 123,
                PerRequestTimeout = Duration.Minutes(30),
                Port = 123,
                Tls = new ServiceConnectTlsConfiguration {
                    AwsPcaAuthorityArn = "awsPcaAuthorityArn",
                    KmsKey = keyRef,
                    Role = role
                }
            };

Synopsis

Properties

DiscoveryName	Optionally specifies an intermediate dns name to register in the CloudMap namespace.
DnsName	The terse DNS alias to use for this port mapping in the service connect mesh.
IdleTimeout	The amount of time in seconds a connection for Service Connect will stay active while idle.
IngressPortOverride	Optional.
PerRequestTimeout	The amount of time waiting for the upstream to respond with a complete response per request for Service Connect.
Port	The port for clients to use to communicate with this service via Service Connect.
PortMappingName	portMappingName specifies which port and protocol combination should be used for this service connect service.
Tls	A reference to an object that represents a Transport Layer Security (TLS) configuration.

Properties

DiscoveryName

Optionally specifies an intermediate dns name to register in the CloudMap namespace.

string? DiscoveryName { get; }

Property Value

string

Remarks

This is required if you wish to use the same port mapping name in more than one service.

Default: - port mapping name

DnsName

The terse DNS alias to use for this port mapping in the service connect mesh.

string? DnsName { get; }

Property Value

string

Remarks

Service Connect-enabled clients will be able to reach this service at http://dnsName:port.

Default: - No alias is created. The service is reachable at portMappingName.namespace:port.

IdleTimeout

The amount of time in seconds a connection for Service Connect will stay active while idle.

Duration? IdleTimeout { get; }

Property Value

Duration

Remarks

A value of 0 can be set to disable idleTimeout.

If idleTimeout is set to a time that is less than perRequestTimeout, the connection will close when the idleTimeout is reached and not the perRequestTimeout.

Default: - Duration.minutes(5) for HTTP/HTTP2/GRPC, Duration.hours(1) for TCP.

IngressPortOverride

Optional.

double? IngressPortOverride { get; }

Property Value

double?

Remarks

The port on the Service Connect agent container to use for traffic ingress to this service.

Default: - none

PerRequestTimeout

The amount of time waiting for the upstream to respond with a complete response per request for Service Connect.

Duration? PerRequestTimeout { get; }

Property Value

Duration

Remarks

A value of 0 can be set to disable perRequestTimeout. Can only be set when the appProtocol for the application container is HTTP/HTTP2/GRPC.

If idleTimeout is set to a time that is less than perRequestTimeout, the connection will close when the idleTimeout is reached and not the perRequestTimeout.

Default: - Duration.seconds(15)

Port

The port for clients to use to communicate with this service via Service Connect.

double? Port { get; }

Property Value

double?

Remarks

Default: the container port specified by the port mapping in portMappingName.

PortMappingName

portMappingName specifies which port and protocol combination should be used for this service connect service.

string PortMappingName { get; }

Property Value

string

Remarks

ExampleMetadata: fixture=_generated

Tls

A reference to an object that represents a Transport Layer Security (TLS) configuration.

IServiceConnectTlsConfiguration? Tls { get; }

Property Value

IServiceConnectTlsConfiguration

Remarks

Default: - none