Using the Amazon ECS Task Definition task in Bamboo

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:

Navigate to the Tasks configuration tab for the job (this will be the default job if creating a new plan).
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.

Complete the following settings:

Common to all tasks

Task Description	(Optional) Identify the purpose of the task.
Disable this task	Check, or clear, to selectively run this task.
Action	Each task supports one or more actions depending on the target AWS resource. Select the desired action and configure the action specific parameters below.
Region	Select the desired AWS Region. Alternatively, select [Use region variable ...] to supply the region dynamically via Bamboo variables (needs to be a region code such as `ap-southeast-2`) - refer to How to parametrize the AWS region via a Bamboo variable for details.
...	Configure task/action specific parameters, see below ...
AWS Security Credentials
Source	Select the source for the required AWS Security Credentials - can be either Inline, an IAM Role for EC2 or a shared Identity Federation for AWS Connector.
Connector	(Conditional) Select the shared Identity Federation for AWS Connector. Alternatively, select [Use connector variable ...] to supply the connector dynamically via Bamboo variables (needs to be a connector id such as `f24e81bc-7aff-42db-86a2-7cf82e24d871`) - refer to How to parametrize the AWS connector via a Bamboo variable for details.

Actions supported by this task:

Register
Family	Specify the family for a task definition, which allows you to track multiple versions of the same 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 that describe the different containers that make up your task.
Volumes	(Optional) A list of volume definitions in JSON format that containers in your task may use.
Deregister
Task Definition	Specify the family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition that you want to deregister.

Variables

All tasks support Bamboo Variable Substitution/Definition - this task's actions generate variables as follows:

A task's generated variables might get amended with respective AWS API additions over time - a live build log will always provide the most current variable shape accordingly

Register

Creating common variables for 1 resources affected by task:
... custom.aws.ecs.taskdefinition.resources: taws-it-270
Creating resource variables for task definition 'taws-it-270':
... custom.aws.ecs.taskdefinition.resources.taws-it-270.TaskDefinitionARN: arn:aws:ecs:us-east-1:309600995652:task-definition/taws-it-270:78
... custom.aws.ecs.taskdefinition.resources.taws-it-270.Family: taws-it-270
... custom.aws.ecs.taskdefinition.resources.taws-it-270.Revision: 78
Creating common variables for first resource affected by task:
Creating resource variables for task definition 'taws-it-270':
... custom.aws.ecs.taskdefinition.first.TaskDefinitionARN: arn:aws:ecs:us-east-1:309600995652:task-definition/taws-it-270:78
... custom.aws.ecs.taskdefinition.first.Family: taws-it-270
... custom.aws.ecs.taskdefinition.first.Revision: 78

Deregister

N/A

How-to Articles

Frequently Asked Questions (FAQ)