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.93.0 (build 1706ca5)",
           date="2024-01-03T18:29:26.035Z")
@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.services.ecs.*;
 ServiceConnectService serviceConnectService = ServiceConnectService.builder()
         .portMappingName("portMappingName")
         // the properties below are optional
         .discoveryName("discoveryName")
         .dnsName("dnsName")
         .ingressPortOverride(123)
         .port(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ServiceConnectService.Builder	A builder for ServiceConnectService
static final class	ServiceConnectService.Jsii$Proxy	An implementation for ServiceConnectService

Method Summary

Modifier and Type	Method	Description
static ServiceConnectService.Builder	builder()
default String	getDiscoveryName()	Optionally specifies an intermediate dns name to register in the CloudMap namespace.
default String	getDnsName()	The terse DNS alias to use for this port mapping in the service connect mesh.
default Number	getIngressPortOverride()	Optional.
default Number	getPort()	The port for clients to use to communicate with this service via Service Connect.
String	getPortMappingName()	portMappingName specifies which port and protocol combination should be used for this service connect service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

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

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.

builder

@Stability(Stable)
static ServiceConnectService.Builder builder()

Returns:

a ServiceConnectService.Builder of ServiceConnectService