Menu
AWS CodeDeploy
User Guide (API Version 2014-10-06)

Register an Application Revision in Amazon S3 with AWS CodeDeploy

If you've already called the push command to push an application revision to Amazon S3, you don't need to register the revision. However, if you upload a revision to Amazon S3 through other means and want the revision to appear in the AWS CodeDeploy console or through the AWS CLI, follow these steps to register the revision first.

If you've pushed an application revision to a GitHub repository and want the revision to appear in the AWS CodeDeploy console or through the AWS CLI, you must also follow these steps.

You can use only the AWS CLI or the AWS CodeDeploy APIs to register application revisions in Amazon S3 or GitHub.

Register a revision in Amazon S3 with AWS CodeDeploy (CLI)

  1. Upload the revision to Amazon S3.

  2. Call the register-application-revision command, specifying:

    • The application name. To view a list of application names, call the list-applications command.

    • Information about the revision to be registered:

      • The name of the Amazon S3 bucket that contains the revision.

      • The name and file type of the uploaded revision. For AWS Lambda deployments, the revision is an AppSpec file written in JSON or YAML. For EC2/On-Premises deployments, the revision contains a version of the source files that AWS CodeDeploy will deploy to your instances or scripts that AWS CodeDeploy will run on your instances.

        Note

        The tar and compressed tar archive file formats (.tar and .tar.gz) are not supported for Windows Server instances.

      • (Optional) The revision's Amazon S3 version identifier. (If the version identifier is not specified, AWS CodeDeploy will use the most recent version.)

      • (Optional) The revision's ETag. (If the ETag is not specified, AWS CodeDeploy will skip object validation.)

    • (Optional) Any description you want to associate with the revision.

Information about a revision in Amazon S3 can be specified on the command line, using this syntax as part of the register-application-revision call. (version and eTag are optional.)

For a revision file for an EC2/On-Premises deployment:

Copy
--s3-location bucket=string,key=string,bundleType=tar|tgz|zip,version=string,eTag=string

For a revision file for an AWS Lambda deployment:

Copy
--s3-location bucket=string,key=string,bundleType=JSON|YAML,version=string,eTag=string

Register a revision in GitHub with AWS CodeDeploy (CLI)

Note

AWS Lambda deployments do not work with GitHub.

  1. Upload the revision to your GitHub repository.

  2. Call the register-application-revision command, specifying:

    • The application name. To view a list of application names, call the list-applications command.

    • Information about the revision to be registered:

      • The GitHub user or group name assigned to the repository that contains the revision, followed by a forward slash (/), followed by the repository name.

      • The ID of the commit that references the revision in the repository.

    • (Optional) Any description you want to associate with the revision.

Information about a revision in GitHub can be specified on the command line, using this syntax as part of the register-application-revision call:

Copy
--github-location repository=string,commitId=string