Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Version published after converting to the new editor

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).


Panel
borderColor#bbb
bgColor#eeeeee

On this page:

Table of Contents
exclude(Common.*|Popular.*|Recent.*)


Panel
borderColor#bbb
bgColor#eeeeee

Related Pages:


Configuration

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

Complete the following settings:

Common to all tasks

Include Page
_CommonTaskParametersTable
_CommonTaskParametersTable

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.

Description

(Optional) Describe the deployment for easier identification.

Ignore Application Stop FailuresCheck to ignore ApplicationStop deployment lifecycle event failures for a specific instance and continue on to the BeforeInstall deployment lifecycle event.
Revision
Revision LocationSpecify the revision to deploy.
Revision Location (S3)
BucketSpecify the S3 bucket this revision is located in.
KeySpecify the revision's S3 object key.
TypeSelect 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)


Note
titleGitHub 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.


RepositorySpecify the revision's repository as 'account/repository'.
Commit IDSpecify the revision's commit ID.

Stop Deployment


Note
titleCaution

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


Info
titleApplication 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
Repositorysee Create above
Commit IDsee Create above


Variables

Include Page
_VariablesNote
_VariablesNote

Create Deployment

Code Block
languagetext
linenumberstrue
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

Filter by label (Content by label)
max8
showSpacefalse
sorttitle
excerptTypesimple
cqllabel in ( "aws-cli" , "aws-codedeploy" ) and label in ( "kb-how-to-article" , "kb-troubleshooting-article" )

Frequently Asked Questions (FAQ)

Questionslist macro
filterpopular
asktrue
limit8
topicaws-codedeploy