Using the AWS CodeDeploy Deployment 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:

   1. Common to all tasks
      

       Click here to expand...

      
      

      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.

   2. Actions supported by this task:

      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 do the Tasks for AWS (Bamboo) CodeDeploy tasks differ from the built-in Bamboo CodeDeploy task?

  • compatibility
  • fabric-editor
  • faq
  • tasks-for-aws
  • aws-codedeploy
• Questions:
  How do the Tasks for AWS CodeDeploy tasks differ from the built-in Bamboo CodeDeploy task?

  • tasks-for-aws
  • faq
  • aws-codedeploy
• Questions:
  How to increase the number of attempts during AWS CodeDeploy deployment?

  • tasks-for-aws
  • aws-codedeploy
  • support
• Page:
  How to provide temporary AWS credentials to the AWS Command Line Interface (AWS CLI) via Bamboo variables

  • tasks-for-aws
  • variables
  • aws-cli
  • kb-how-to-article
  • identity-federation-for-aws
  • usage
• Questions:
  Spin up instance from AMI?

  • aws-codedeploy

Frequently Asked Questions (FAQ)