AWS::ECS::PrimaryTaskSet - Amazon CloudFormation
SyntaxPropertiesReturn values
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).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::ECS::PrimaryTaskSet

Modifies which task set in a service is the primary task set. Any parameters that are updated on the primary task set in a service will transition to the service. This is used when a service uses the EXTERNAL deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.

Syntax

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

JSON

{
  "Type" : "AWS::ECS::PrimaryTaskSet",
  "Properties" : {
      "Cluster" : String,
      "Service" : String,
      "TaskSetId" : String
    }
}

YAML

Type: AWS::ECS::PrimaryTaskSet
Properties:
  Cluster: String
  Service: String
  TaskSetId: String

Properties

Cluster

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task set exists in.

Required: Yes

Type: String

Update requires: Replacement

Service

The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.

Required: Yes

Type: String

Update requires: Replacement

TaskSetId

The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the deployment.

Required: Yes

Type: String

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name.

For more information about using the Ref function, see Ref.