Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated to release 2.8.0.

You can use the Amazon ECS Service task to create, update or delete an Amazon EC2 Container Service (ECS) service (see Deploying to Amazon ECS for an overview of the ECS component lifecycle and deployment workflow).

 

Panel
borderColor#bbb
bgColor#eeeeee

On this page:

Table of Contents
exclude(Popular.*|Recent.*)

Panel
borderColor#bbb
bgColor#eeeeee

Related Pages:

Configuration

To configure an Amazon ECS Service task:

  1. Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).
  2. Click the name of an existing Amazon ECS Service task, or click Add Task and then Amazon ECS Service to create a new task.
  3. Complete the following settings:

    1. Common to all tasks

      Include Page
      _CommonTaskParametersTable
      _CommonTaskParametersTable

    2. Actions supported by this task:

       

      Create Service

       
      Cluster Name or ARN

      (Optional) Specify the short name or full Amazon Resource Name (ARN) of the cluster that you want to run your service on.

      •  (warning) If you do not specify a cluster, the default cluster is assumed. 
      ServiceSpecify the name of the service you want to create.
      Task Definition(Optional) Specify the family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to run in your service.
      Desired Count(Optional) Specify the  number of instantiations of the specified task definition that you would like to place and keep running on your cluster.
      Load Balancers(Optional) Specify one or more load balancer objects in JSON format, containing the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer.
      Role

      (Conditional) Specify the name or full Amazon Resource Name (ARN) of the IAM role that allows your Amazon ECS container agent to make calls to your load balancer on your behalf.

      •  (info)  This parameter is only required if you are using a load balancer with your service.
      Advanced Options 
      Await Steady State TimeoutSpecify how long to await the service reaching a steady state (seconds, 0 to skip).
      Verify Steady State Period Specify how long to verify the service's state staying steady (seconds, 0 to skip).

      Update Service

       
      Cluster Name or ARNsee Create above
      ServiceSpecify the name of the service you want to update.
      Task Definitionsee Create above
      Desired Countsee Create above
      Advanced Options 
      Await Steady State Timeoutsee Create above
      Verify Steady State Period see Create above

      Delete Service

       
      Cluster Name or ARNsee Create above
      ServiceSpecify the name of the service you want to delete.Generated Variables

Variables

Include Page
_VariablesNote
_VariablesNote

Create Service

Code Block
languagetext
linenumberstrue
Creating common variables for 1 services:
... custom.aws.ecs.service.resources: taws-it-270-nginx
Creating resource variables for service 'taws-it-270-nginx':
... custom.aws.ecs.service.resources.taws-it-270-nginx.ClusterArn: arn:aws:ecs:us-east-1:309600995652:cluster/taws-it-270-29
... custom.aws.ecs.service.resources.taws-it-270-nginx.RoleArn: arn:aws:iam::309600995652:role/amazon-ecs-service
... custom.aws.ecs.service.resources.taws-it-270-nginx.ServiceArn: arn:aws:ecs:us-east-1:309600995652:service/taws-it-270-nginx
... custom.aws.ecs.service.resources.taws-it-270-nginx.ServiceName: taws-it-270-nginx
... custom.aws.ecs.service.resources.taws-it-270-nginx.Status: ACTIVE
... custom.aws.ecs.service.resources.taws-it-270-nginx.TaskDefinition: arn:aws:ecs:us-east-1:309600995652:task-definition/taws-it-270-nginx:59
Creating common variables for first resource affected by task:
Creating resource variables for service 'taws-it-270-nginx':
... custom.aws.ecs.service.first.ClusterArn: arn:aws:ecs:us-east-1:309600995652:cluster/taws-it-270-29
... custom.aws.ecs.service.first.RoleArn: arn:aws:iam::309600995652:role/amazon-ecs-service
... custom.aws.ecs.service.first.ServiceArn: arn:aws:ecs:us-east-1:309600995652:service/taws-it-270-nginx
... custom.aws.ecs.service.first.ServiceName: taws-it-270-nginx
... custom.aws.ecs.service.first.Status: ACTIVE
... custom.aws.ecs.service.first.TaskDefinition: arn:aws:ecs:us-east-1:309600995652:task-definition/taws-it-270-nginx:59	

Update

 Cluster Name or ARNsee Create aboveServiceSpecify the name of the service you want to update.Task Definitionsee Create aboveDesired Countsee Create aboveGenerated Variablessee Create above

Delete

 Cluster Name or ARNsee Create aboveServiceSpecify the name of the service you want to delete.Generated Variablessee Create above

Variables

Include Page_VariablesNote_VariablesNote

Service

See Create above.

Delete Service

See Create above.

How-to Articles

Filter by label (Content by label)
max8
showSpacefalse
sorttitle
excerptTypesimple
cqllabel in ("aws-cli","amazon-ecs")

Frequently Asked Questions (FAQ)

Questionslist macro
filterpopular
asktrue
limit8
topicamazon-ecs