Create an EC2/On-Premises Compute Platform deployment (CLI) - AWS CodeDeploy
create-deployment command reference

Create an EC2/On-Premises Compute Platform deployment (CLI)

To use the AWS CLI to deploy a revision to the EC2/On-Premises compute platform:

  1. After you have prepared the instances, created the application, and pushed the revision, do one of the following:

  2. Call the create-deployment command, specifying:

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

    • --deployment-group-name: An Amazon EC2 deployment group name. To view a list of deployment group names, call the list-deployment-groups command.

    • --revision: Information about the revision to be deployed:

      For revisions stored in Amazon S3:

      • s3Location: The Amazon S3 bucket name that contains the revision.

      • s3Location --> key: The name of the uploaded revision.

      • s3Location --> bundleType: The file type of the uploaded revision.

        Note

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

      • s3Location --> version: (Optional) The Amazon S3 version identifier for the revision. (If the version identifier is not specified, CodeDeploy uses the most recent version.)

      • s3Location --> eTag: (Optional) The ETag for the revision. (If the ETag is not specified, CodeDeploy skips object validation.)

      For revisions stored in GitHub:

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

      • gitHubLocation --> commitId: The commit ID for the revision.

    • --deployment-config-name: (Optional) The name of a deployment configuration to use. To view a list of deployment configurations, call the list-deployment-configs command. (If not specified, CodeDeploy uses a specific default deployment configuration.)

    • --ignore-application-stop-failures | --no-ignore-application-stop-failures: (Optional) Whether you want the deployment to an instance to continue to the BeforeInstall deployment lifecycle event if the ApplicationStop deployment lifecycle event fails.

    • --description: (Optional) A description for the deployment.

    • --file-exists-behavior: (Optional) As part of the deployment process, the CodeDeploy agent removes from each instance all the files installed by the most recent deployment. Choose what happens when files that weren’t part of a previous deployment appear in target deployment locations.

    • --target-instances: For blue/green deployments, information about the instances that belong to the replacement environment in a blue/green deployment, including the names of one or more Amazon EC2 Auto Scaling groups, or the tag filter key, type, and value used to identify Amazon EC2 instances.

Note

Use this syntax as part of the create-deployment call to specify information about a revision in Amazon S3 directly on the command line. (The version and eTag are optional.)

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

Use this syntax as part of the create-deployment call to specify information about a revision in GitHub directly on the command line:

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

To get information about revisions that have been pushed already, call the list-application-revisions command.

To track the status of your deployment, see View CodeDeploy deployment details .

create-deployment command reference

Below is the command structure and options for the create-deployment command. For more information, see the create-deployment reference in the AWS CLI Command Reference.

create-deployment
--application-name <value>
[--deployment-group-name <value>]
[--revision <value>]
[--deployment-config-name <value>]
[--description <value>]
[--ignore-application-stop-failures | --no-ignore-application-stop-failures]
[--target-instances <value>]
[--auto-rollback-configuration <value>]
[--update-outdated-instances-only | --no-update-outdated-instances-only]
[--file-exists-behavior <value>]
[--s3-location <value>]
[--github-location <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]