ServiceConnectService

class aws_cdk.aws_ecs.ServiceConnectService(*, port_mapping_name, discovery_name=None, dns_name=None, ingress_port_override=None, port=None)

Bases: object

Interface for service connect Service props.

Parameters:
  • port_mapping_name (str) – portMappingName specifies which port and protocol combination should be used for this service connect service.

  • discovery_name (Optional[str]) – 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

  • dns_name (Optional[str]) – 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.

  • ingress_port_override (Union[int, float, None]) – Optional. The port on the Service Connect agent container to use for traffic ingress to this service. Default: - none

  • port (Union[int, float, None]) – 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.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_ecs as ecs

service_connect_service = ecs.ServiceConnectService(
    port_mapping_name="portMappingName",

    # the properties below are optional
    discovery_name="discoveryName",
    dns_name="dnsName",
    ingress_port_override=123,
    port=123
)

Attributes

discovery_name

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

dns_name

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.

ingress_port_override

Optional.

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

Default:
  • none

port

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.

port_mapping_name

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