Using the Amazon ECS Cluster task in Bamboo

Configuration

Cluster Management

While useful for end to end automation and test scenarios, it is quite common to create ECS Clusters e.g. via the AWS Management Console upfront and only manage ECS Task Definitions, Tasks and Services from your build and deployment projects.

To configure an Amazon ECS Cluster 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 Cluster task, or click Add Task and then Amazon ECS Cluster 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:

Create
Cluster Name	(Optional) Specify a cluster name. If you do not specify a name for your cluster, you will create a cluster named default. This name must be unique within your account. If the specified name already exists, the task will fail.
Delete
Cluster Name or ARN	Specify a cluster name or ARN.

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

Create

Creating common variables for 1 resources affected by task:
... custom.aws.ecs.cluster.resources: TC-TAWS-IT270-ECSC-29
Creating resource variables for cluster 'TC-TAWS-IT270-ECSC-29':
... custom.aws.ecs.cluster.resources.TC-TAWS-IT270-ECSC-29.ClusterName: TC-TAWS-IT270-ECSC-29
... custom.aws.ecs.cluster.resources.TC-TAWS-IT270-ECSC-29.ClusterARN: arn:aws:ecs:us-east-1:309600995652:cluster/TC-TAWS-IT270-ECSC-29
... custom.aws.ecs.cluster.resources.TC-TAWS-IT270-ECSC-29.Status: ACTIVE
Creating common variables for first resource affected by task:
Creating resource variables for cluster 'TC-TAWS-IT270-ECSC-29':
... custom.aws.ecs.cluster.first.ClusterName: TC-TAWS-IT270-ECSC-29
... custom.aws.ecs.cluster.first.ClusterARN: arn:aws:ecs:us-east-1:309600995652:cluster/TC-TAWS-IT270-ECSC-29
... custom.aws.ecs.cluster.first.Status: ACTIVE

Delete

N/A

How-to Articles

Frequently Asked Questions (FAQ)

All documented Task actions support Bamboo Variable Substitution/Definition - this task generates the following variables:

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.