Using the Amazon ECS Task task in Bamboo

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

On this page:

1 Configuration
- 1.1 Run Task
- 1.2 Start Task
- 1.3 Stop Task
2 Variables
- 2.1 Run Task
- 2.2 Start Task
- 2.3 Stop Task
3 How-to Articles
4 Frequently Asked Questions (FAQ)

Related Pages:

Deploying to Amazon ECS

Configuration

Naming Overlap

There is an entity naming overlap between Atlassian Bamboo Tasks and Amazon ECS Tasks - rather than adding to the confusion by introducing yet another name, this documentation will refer to an Amazon ECS Task task as needed.

To configure an Amazon ECS Task 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 Task task, or click Add Task and then Amazon ECS Task to create a new task.

3. Complete the following settings:

a. Common to all tasks

b. Actions supported by this task:

Run Task

Run Task
Launch Type	Select the launch type on which to run your task.
Task Definition	Specify the family and revision (family:revision) or Amazon Resource Name (ARN) of the task definition to use.
Cluster Name or ARN	(Optional) Specify the cluster name or Amazon Resource Name (ARN). If you do not specify a cluster, the default cluster is assumed.
Count	(Optional) Specify the number of task instances to run once.
Group	(Optional) Specify the name of the task group to associate with the task.
Network Configuration	(Optional) Specify an awsvpc network configuration (JSON – inline or via URL) – refer to Task Networking with the awsvpc Network Mode for details.
Started By	(Optional) Specify a tag to apply when the task is started.
Tags	Specify the tags to apply (JSON – inline or via URL).
EC2 Options
Placement Strategy	(Optional) Specify placement strategy objects (JSON – inline or via URL) – refer to Amazon ECS Task Placement Strategies for details.
Placement Constraints	(Optional) Specify placement constraint objects in (JSON – inline or via URL) – refer to Amazon ECS Task Placement Constraints for details.
Advanced Options
Overrides	(Optional) Specify one or more container overrides in JSON format to use.
Fargate Platform Version	(Optional) Specify the platform version on which to run your task. If none is specified, Fargate defaults to the latest version.
Desired Status	Select the desired status the task(s) should reach. _{Since 2.13.0: see below.}
Await Desired Status Timeout	Specify how long to await the task(s) reaching the desired status (seconds, 0 to skip). _{Since 2.13.0: select 'Running or Stopped' with a timeout longer than the Bamboo build timeout to replicate the previous behavior.}
Start Task
Task Definition	see Run Task above
Cluster Name or ARN	see Run Task above
Container Instances	Specify a JSON array of container instance UUIDs or Amazon Resource Name (ARN) entries for the container instances on which to place the task.
Group	see Run Task above
Network Configuration	see Run Task above
Started By	see Run Task above
Tags	see Run Task above
Advanced Options
Overrides	see Run Task above
Desired Status	see Run Task above
Await Desired Status Timeout	see Run Task above
Stop Task
Cluster Name or ARN	see Run Task above
Task UUID or ARN	Specify the task UUIDs or full Amazon Resource Name (ARN) entry of the task.
Reason	Specify the reason for the task being stopped.

Variables

Run Task

Creating common variables for 1 tasks:
... bamboo.custom.aws.ecs.task.resources: 20b85717-337a-4b64-839f-630517b0c7c0
Creating resource variables for task '20b85717-337a-4b64-839f-630517b0c7c0':
... bamboo.custom.aws.ecs.task.resources.20b85717-337a-4b64-839f-630517b0c7c0.ClusterArn: arn:aws:ecs:us-east-1:309600995652:cluster/taws-it-270-29
... bamboo.custom.aws.ecs.task.resources.20b85717-337a-4b64-839f-630517b0c7c0.ContainerInstanceArn: arn:aws:ecs:us-east-1:309600995652:container-instance/04e43cc4-2a6c-450e-bcee-35d076e010b4
... bamboo.custom.aws.ecs.task.resources.20b85717-337a-4b64-839f-630517b0c7c0.DesiredStatus: RUNNING
... bamboo.custom.aws.ecs.task.resources.20b85717-337a-4b64-839f-630517b0c7c0.LastStatus: RUNNING
... bamboo.custom.aws.ecs.task.resources.20b85717-337a-4b64-839f-630517b0c7c0.StartedBy: null
... bamboo.custom.aws.ecs.task.resources.20b85717-337a-4b64-839f-630517b0c7c0.StartedAt: 20151204T181331Z
... bamboo.custom.aws.ecs.task.resources.20b85717-337a-4b64-839f-630517b0c7c0.StoppedAt: null
... bamboo.custom.aws.ecs.task.resources.20b85717-337a-4b64-839f-630517b0c7c0.StoppedReason: null
... bamboo.custom.aws.ecs.task.resources.20b85717-337a-4b64-839f-630517b0c7c0.TaskArn: arn:aws:ecs:us-east-1:309600995652:task/20b85717-337a-4b64-839f-630517b0c7c0
... bamboo.custom.aws.ecs.task.resources.20b85717-337a-4b64-839f-630517b0c7c0.TaskDefinitionArn: arn:aws:ecs:us-east-1:309600995652:task-definition/taws-it-270-sleep:100
... bamboo.custom.aws.ecs.task.resources.20b85717-337a-4b64-839f-630517b0c7c0.Version: 3
Creating common variables for first resource affected by task:
Creating resource variables for task '20b85717-337a-4b64-839f-630517b0c7c0':
... bamboo.custom.aws.ecs.task.first.ClusterArn: arn:aws:ecs:us-east-1:309600995652:cluster/taws-it-270-29
... bamboo.custom.aws.ecs.task.first.ContainerInstanceArn: arn:aws:ecs:us-east-1:309600995652:container-instance/04e43cc4-2a6c-450e-bcee-35d076e010b4
... bamboo.custom.aws.ecs.task.first.DesiredStatus: RUNNING
... bamboo.custom.aws.ecs.task.first.LastStatus: RUNNING
... bamboo.custom.aws.ecs.task.first.StartedBy: null
... bamboo.custom.aws.ecs.task.first.StartedAt: 20151204T181331Z
... bamboo.custom.aws.ecs.task.first.StoppedAt: null
... bamboo.custom.aws.ecs.task.first.StoppedReason: null
... bamboo.custom.aws.ecs.task.first.TaskArn: arn:aws:ecs:us-east-1:309600995652:task/20b85717-337a-4b64-839f-630517b0c7c0
... bamboo.custom.aws.ecs.task.first.TaskDefinitionArn: arn:aws:ecs:us-east-1:309600995652:task-definition/taws-it-270-sleep:100

... bamboo.custom.aws.ecs.task.first.Version: 3

Start Task

See Run above.

Stop Task

See Run above.

How-to Articles

Frequently Asked Questions (FAQ)