Using the Amazon ECS Task Definition task in Bamboo

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

On this page:

1 Configuration
- 1.1 Register Task Definition
- 1.2 Deregister Task Definition
2 Variables
- 2.1 Register Task Definition
- 2.2 Deregister Task Definition
3 How-to Articles
4 Frequently Asked Questions (FAQ)

Related Pages:

Deploying to Amazon ECS
- Using the Amazon ECS Service task in Bamboo
- Using the Amazon ECS Task task in Bamboo
AWS
- Migrating Your Amazon ECS Containers to AWS Fargate

Configuration

Naming Overlap

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

3. Complete the following settings:

a. Common to all tasks

b. Actions supported by this task:

Register Task Definition

Register Task Definition
Family	Specify the task definition family, which allows to track multiple versions of a task definition. You can think of the family as a name for your task definition.
Container Definitions	Specify a list of container definitions in JSON format – refer to Amazon ECS Task Definitions for an overview, and section Container Definitions within Task Definition Parameters for details.
Volumes	(Optional) Specify a list of volume definitions in JSON format – refer to Amazon ECS Task Definitions for an overview, and Using Data Volumes in Tasks for details.
Task Role ARN	(Optional) Specify the Amazon Resource Name (ARN) of the IAM role that containers in this task will assume.
Requires Compatibilities	(Optional) Specify the launch type required by the task. If no value is specified, it defaults to EC2.
Network Mode	Specify the Docker networking mode to use for the containers in the task.
Execution Role ARN	(Optional) Specify the Amazon Resource Name (ARN) of the IAM role that the Amazon ECS container agent and the Docker daemon can assume.
CPU	Specify the number of cpu units used by the task.
Memory	Specify amount (in MiB) of memory used by the task.
Tags	Specify the tags to apply (JSON – inline or via URL).
EC2 Options
Placement Constraints	(Optional) Specify placement constraint objects in JSON format – refer to Amazon ECS Task Placement Constraints for details.
Deregister Task Definition
Task Definition	Specify the family and revision (family:revision) or Amazon Resource Name (ARN) of the task definition.

Variables

Register Task Definition

Creating common variables for 1 resources affected by task:
... bamboo.custom.aws.ecs.taskdefinition.resources: TAWS-IT270
Creating resource variables for task definition 'TAWS-IT270':
... bamboo.custom.aws.ecs.taskdefinition.resources.TAWS-IT270.TaskDefinitionARN: arn:aws:ecs:us-east-1:309600995652:task-definition/TAWS-IT270:78
... bamboo.custom.aws.ecs.taskdefinition.resources.TAWS-IT270.Family: TAWS-IT270
... bamboo.custom.aws.ecs.taskdefinition.resources.TAWS-IT270.Revision: 78
... bamboo.custom.aws.ecs.taskdefinition.resources.TAWS-IT270.Status: ACTIVE
Creating common variables for first resource affected by task:
Creating resource variables for task definition 'TAWS-IT270':
... bamboo.custom.aws.ecs.taskdefinition.first.TaskDefinitionARN: arn:aws:ecs:us-east-1:309600995652:task-definition/TAWS-IT270:78
... bamboo.custom.aws.ecs.taskdefinition.first.Family: TAWS-IT270
... bamboo.custom.aws.ecs.taskdefinition.first.Revision: 78

... bamboo.custom.aws.ecs.taskdefinition.first.Status: ACTIVE

Deregister Task Definition

N/A

How-to Articles

Frequently Asked Questions (FAQ)