Using the AWS CodeDeploy Deployment Group task in Bamboo

You can use the AWS CodeDeploy Deployment Group task to create, update or delete an AWS CodeDeploy deployment group (see Deploying to AWS CodeDeploy for an overview of the CodeDeploy component lifecycle and deployment workflow).

On this page:

1 Configuration
- 1.1 Create Deployment Group
- 1.2 Update Deployment Group
- 1.3 Delete Deployment Group
2 Variables
- 2.1 Create Deployment Group
- 2.2 Update Deployment Group
- 2.3 Delete Deployment Group
3 How-to Articles

Related Pages:

Deploying to AWS CodeDeploy
- Using the AWS CodeDeploy Deployment task in Bamboo
- Using the AWS CodeDeploy Application task in Bamboo

Configuration

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

3. Complete the following settings:

a. Common to all tasks

Click here to expand...

Common (Bamboo)
Task Description	(Optional) Identify the purpose of the task.
Disable this task	Check, or clear, to selectively run this task.
...	Configure task/action specific parameters, see below ...
Bamboo Variables
Namespace	Provide the namespace for generated variables – defaults to `custom.aws` for backward compatibility.
Scope	Select the scope for generated variables – can be either Local (Variables will only be available in this job), or Result (Variables will be available in subsequent plan stages and deployment releases).
Common (AWS)
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.

b. Actions supported by this task:

Create Deployment Group

Create Deployment Group
Application Name	Specify the application name.
Deployment Group Name	Specify a deployment group name.
Deployment Configuration Name	(Optional) Specify a deployment configuration name. Refer to Create a Deployment Configuration with AWS CodeDeploy for details on how to create custom deployment configurations.
Auto Scaling Groups	Specify Auto Scaling groups in JSON Format.
EC2 Tag Filters	Specify EC2 tag filters in JSON Format.
Service Role ARN	Specify a service role ARN.
Advanced Options
Notification Trigger Configuration	Specify notification trigger configurations in JSON Format.
Update Deployment Group
Application Name	Specify the application name.
Deployment Group Name	Specify the deployment group name.
Deployment Group Name	Specify the new deployment group name.
Deployment Configuration Name	see Create above
Auto Scaling Groups	see Create above
EC2 Tag Filters	see Create above
Service Role ARN	see Create above
Advanced Options
Notification Trigger Configuration	see Create above
Delete Deployment Group
Application Name	see Update above
Deployment Group Name	see Update above

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 Deployment Group

Creating common variables for deployment group 'TDG1-TAWS-IT260-CDDG-51' with id '56c9d6c0-747f-44d0-ac7d-ffaf82e7ff44':
... custom.aws.codedeploy.deploymentgroup.resources: 56c9d6c0-747f-44d0-ac7d-ffaf82e7ff44
... custom.aws.codedeploy.deploymentgroup.resources.56c9d6c0-747f-44d0-ac7d-ffaf82e7ff44.ApplicationName: TDGA-TAWS-IT260-CDDG-51
... custom.aws.codedeploy.deploymentgroup.resources.56c9d6c0-747f-44d0-ac7d-ffaf82e7ff44.DeploymentGroupName: TDG1-TAWS-IT260-CDDG-51
... custom.aws.codedeploy.deploymentgroup.resources.56c9d6c0-747f-44d0-ac7d-ffaf82e7ff44.DeploymentConfigName: CodeDeployDefault.AllAtOnce
... custom.aws.codedeploy.deploymentgroup.resources.56c9d6c0-747f-44d0-ac7d-ffaf82e7ff44.DeploymentGroupId: 56c9d6c0-747f-44d0-ac7d-ffaf82e7ff44
... custom.aws.codedeploy.deploymentgroup.resources.56c9d6c0-747f-44d0-ac7d-ffaf82e7ff44.ServiceRoleARN: arn:aws:iam::309600995652:role/CodeDeploy-IAM-resources-CodeDeployTrustRole-5SHJ7R4FVDP7
Creating common variables for first resource affected by task:
... custom.aws.codedeploy.deploymentgroup.first.ApplicationName: TDGA-TAWS-IT260-CDDG-51
... custom.aws.codedeploy.deploymentgroup.first.DeploymentGroupName: TDG1-TAWS-IT260-CDDG-51
... custom.aws.codedeploy.deploymentgroup.first.DeploymentConfigName: CodeDeployDefault.AllAtOnce
... custom.aws.codedeploy.deploymentgroup.first.DeploymentGroupId: 56c9d6c0-747f-44d0-ac7d-ffaf82e7ff44
... custom.aws.codedeploy.deploymentgroup.first.ServiceRoleARN: arn:aws:iam::309600995652:role/CodeDeploy-IAM-resources-CodeDeployTrustRole-5SHJ7R4FVDP7

Update Deployment Group

See Create above.

Delete Deployment Group

N/A

How-to Articles

Page:
How to provide temporary AWS credentials to the AWS Command Line Interface (AWS CLI) via Bamboo variables

Using the AWS CodeDeploy Deployment Group task in Bamboo

Configuration

Common (Bamboo)

Common (AWS)

Create Deployment Group

Create Deployment Group

Update Deployment Group

Delete Deployment Group

Variables

Create Deployment Group

Update Deployment Group

Delete Deployment Group

How-to Articles