AWS::ECS::Service ServiceConnectConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::ECS::Service ServiceConnectConfiguration

The Service Connect configuration of your Amazon ECS service. The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Enabled" : Boolean,
  "LogConfiguration" : LogConfiguration,
  "Namespace" : String,
  "Services" : [ ServiceConnectService, ... ]
}

Properties

Enabled

Specifies whether to use Service Connect with this service.

Required: Yes

Type: Boolean

Update requires: No interruption

LogConfiguration

Property description not available.

Required: No

Type: LogConfiguration

Update requires: No interruption

Namespace

The namespace name or full Amazon Resource Name (ARN) of the Amazon Cloud Map namespace for use with Service Connect. The namespace must be in the same Amazon Region as the Amazon ECS service and cluster. The type of namespace doesn't affect Service Connect. For more information about Amazon Cloud Map, see Working with Services in the Amazon Cloud Map Developer Guide.

Required: No

Type: String

Update requires: No interruption

Services

The list of Service Connect service objects. These are names and aliases (also known as endpoints) that are used by other Amazon ECS services to connect to this service.

This field is not required for a "client" Amazon ECS service that's a member of a namespace only to connect to other services within the namespace. An example of this would be a frontend application that accepts incoming requests from either a load balancer that's attached to the service or by other means.

An object selects a port from the task definition, assigns a name for the Amazon Cloud Map service, and a list of aliases (endpoints) and ports for client applications to refer to this service.

Required: No

Type: List of ServiceConnectService

Update requires: No interruption