Using the AWS CodeDeploy Deployment task in Bamboo

You can use the AWS CodeDeploy Deployment task to create, stop or prepare an AWS CodeDeploy deployment (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
- 1.2 Stop Deployment
- 1.3 Prepare Deployment
2 Variables
- 2.1 Create Deployment
- 2.2 Stop Deployment
- 2.3 Prepare Deployment
3 How-to Articles
4 Frequently Asked Questions (FAQ)

Related Pages:

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

Configuration

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

3. Complete the following settings:

a. Common to all tasks

b. Actions supported by this task:

Create Deployment

Create Deployment
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.
Description	(Optional) Describe the deployment for easier identification.
Ignore Application Stop Failures	Check to ignore ApplicationStop deployment lifecycle event failures for a specific instance and continue on to the BeforeInstall deployment lifecycle event.
Revision
Revision Location	Specify the revision to deploy.
Revision Location (S3)
Bucket	Specify the S3 bucket this revision is located in.
Key	Specify the revision's S3 object key.
Type	Select the revision's type (format).
ETag	(Optional) Specify the revision's ETag.
Version	(Optional) Specify the revision's S3 object key version.
Revision Location (GitHub)	GitHub Authentication To deploy a GitHub revision, you must use the AWS CodeDeploy console once per application to give AWS CodeDeploy permission to interact with GitHub on your behalf.
Repository	Specify the revision's repository as 'account/repository'.
Commit ID	Specify the revision's commit ID.
Stop Deployment	Caution Stopping a deployment may leave some or all of the instances in your deployment groups in an indeterminate deployment state. For more information, see Stopped and Failed Deployments.
Deployment ID	see Create above
Prepare Deployment	Application Revision Registration Registers an application revision without deploying it. Use this only if you want the revision to appear in the Revisions section of the application details page of the AWS CodeDeploy console or through the AWS CLI.
Application Name	see Create above
Description	(Optional) Describe the deployment for easier identification.
Revision
Revision Location	see Create above
Revision Location (S3)	see Create above
Bucket	see Create above
Key	see Create above
Type	see Create above
ETag	see Create above
Version	see Create above
Revision Location (GitHub)	see Create above
Repository	see Create above
Commit ID	see Create above

Variables

Create Deployment

Creating common variables for deployment 'd-3VH0Q6N8A':
... custom.aws.codedeploy.deployment.resources: d-3VH0Q6N8A
... custom.aws.codedeploy.deployment.resources.d-3VH0Q6N8A.ApplicationName: TDAS-TAWS-IT260-CDSCP-51
... custom.aws.codedeploy.deployment.resources.d-3VH0Q6N8A.Creator: user
... custom.aws.codedeploy.deployment.resources.d-3VH0Q6N8A.DeploymentConfigName: CodeDeployDefault.HalfAtATime
... custom.aws.codedeploy.deployment.resources.d-3VH0Q6N8A.DeploymentGroupName: TDDGS-TAWS-IT260-CDSCP-51
... custom.aws.codedeploy.deployment.resources.d-3VH0Q6N8A.DeploymentId: d-3VH0Q6N8A
... custom.aws.codedeploy.deployment.resources.d-3VH0Q6N8A.Description: null
... custom.aws.codedeploy.deployment.resources.d-3VH0Q6N8A.Status: Succeeded
... custom.aws.codedeploy.deployment.resources.d-3VH0Q6N8A.DeploymentOverview: Pending: 0, InProgress: 0, Succeeded: 2, Failed: 0, Skipped: 0
... custom.aws.codedeploy.deployment.resources.d-3VH0Q6N8A.CreateTime: Tue Jul 21 23:11:12 UTC 2015
... custom.aws.codedeploy.deployment.resources.d-3VH0Q6N8A.CompleteTime: Tue Jul 21 23:11:55 UTC 2015
Creating common variables for first resource affected by task:
... custom.aws.codedeploy.deployment.first.ApplicationName: TDAS-TAWS-IT260-CDSCP-51
... custom.aws.codedeploy.deployment.first.Creator: user
... custom.aws.codedeploy.deployment.first.DeploymentConfigName: CodeDeployDefault.HalfAtATime
... custom.aws.codedeploy.deployment.first.DeploymentGroupName: TDDGS-TAWS-IT260-CDSCP-51
... custom.aws.codedeploy.deployment.first.DeploymentId: d-3VH0Q6N8A
... custom.aws.codedeploy.deployment.first.Description: null
... custom.aws.codedeploy.deployment.first.Status: Succeeded
... custom.aws.codedeploy.deployment.first.DeploymentOverview: Pending: 0, InProgress: 0, Succeeded: 2, Failed: 0, Skipped: 0
... custom.aws.codedeploy.deployment.first.CreateTime: Tue Jul 21 23:11:12 UTC 2015
... custom.aws.codedeploy.deployment.first.CompleteTime: Tue Jul 21 23:11:55 UTC 2015

Stop Deployment

N/A

Prepare Deployment

N/A

How-to Articles

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

Frequently Asked Questions (FAQ)