aws-cdk-lib.aws_ecs.ServiceConnectService

ServiceConnectService Struct

Interface for service connect Service props.

Source

aws-ecs/lib/base/base-service.ts

Type last changed

v2.178.0 · 6 Feb 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ecs as ecs } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_kms as interfaces_kms } from 'aws-cdk-lib/interfaces';

declare const keyRef: interfaces_kms.IKeyRef;
declare const role: iam.Role;
const serviceConnectService: ecs.ServiceConnectService = {
  portMappingName: 'portMappingName',

  // the properties below are optional
  discoveryName: 'discoveryName',
  dnsName: 'dnsName',
  idleTimeout: cdk.Duration.minutes(30),
  ingressPortOverride: 123,
  perRequestTimeout: cdk.Duration.minutes(30),
  port: 123,
  tls: {
    awsPcaAuthorityArn: 'awsPcaAuthorityArn',
    kmsKey: keyRef,
    role: role,
  },
};

Properties

discoveryNamestringdiscovery_namestrdiscoveryNameStringDiscoveryNamestringDiscoveryName*string#

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

Default: port mapping name

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

dnsNamestringdns_namestrdnsNameStringDnsNamestringDnsName*string#

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

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

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

idleTimeoutDurationidle_timeoutDurationidleTimeoutDurationIdleTimeoutDurationIdleTimeoutDuration#

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

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

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.

ingressPortOverridenumberingress_port_overrideint | floatingressPortOverrideNumberIngressPortOverridedoubleIngressPortOverride*float64= none#

Optional.

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

perRequestTimeoutDurationper_request_timeoutDurationperRequestTimeoutDurationPerRequestTimeoutDurationPerRequestTimeoutDuration= Duration.seconds(15)#

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

notes

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.

portnumberportint | floatportNumberPortdoublePort*float64#

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

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

portMappingNamestringport_mapping_namestrportMappingNameStringPortMappingNamestringPortMappingName*stringrequired#

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

tlsServiceConnectTlsConfigurationtlsServiceConnectTlsConfigurationtlsServiceConnectTlsConfigurationTlsServiceConnectTlsConfigurationTlsServiceConnectTlsConfiguration= none#

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