Package software.amazon.awscdk.services.ecs

Interface ServiceConnectService

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ServiceConnectService.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-17T14:40:50.600Z") @Stability(Stable) public interface ServiceConnectService extends software.amazon.jsii.JsiiSerializable
Interface for service connect Service props.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.ecs.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.interfaces.kms.*;
 IKeyRef keyRef;
 Role role;
 ServiceConnectService serviceConnectService = ServiceConnectService.builder()
         .portMappingName("portMappingName")
         // the properties below are optional
         .discoveryName("discoveryName")
         .dnsName("dnsName")
         .idleTimeout(Duration.minutes(30))
         .ingressPortOverride(123)
         .perRequestTimeout(Duration.minutes(30))
         .port(123)
         .tls(ServiceConnectTlsConfiguration.builder()
                 .awsPcaAuthorityArn("awsPcaAuthorityArn")
                 .kmsKey(keyRef)
                 .role(role)
                 .build())
         .build();

  • Method Details

    • getPortMappingName

      @Stability(Stable) @NotNull String getPortMappingName()
      portMappingName specifies which port and protocol combination should be used for this service connect service.

    • getDiscoveryName

      @Stability(Stable) @Nullable default String getDiscoveryName()
      Optionally specifies an intermediate dns name to register in the CloudMap namespace.

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

      Default: - port mapping name

    • getDnsName

      @Stability(Stable) @Nullable default String getDnsName()
      The terse DNS alias to use for this port mapping in the service connect mesh.

      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`.

    • getIdleTimeout

      @Stability(Stable) @Nullable default Duration getIdleTimeout()
      The amount of time in seconds a connection for Service Connect will stay active while idle.

      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.

    • getIngressPortOverride

      @Stability(Stable) @Nullable default Number getIngressPortOverride()
      Optional.

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

      Default: - none

    • getPerRequestTimeout

      @Stability(Stable) @Nullable default Duration getPerRequestTimeout()
      The amount of time waiting for the upstream to respond with a complete response per request for Service Connect.

      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)

    • getPort

      @Stability(Stable) @Nullable default Number getPort()
      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.

    • getTls

      @Stability(Stable) @Nullable default ServiceConnectTlsConfiguration getTls()
      A reference to an object that represents a Transport Layer Security (TLS) configuration.

      Default: - none

    • builder

      @Stability(Stable) static ServiceConnectService.Builder builder()
      Returns:
      a ServiceConnectService.Builder of ServiceConnectService