Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . deploy ]

create-deployment

Description

Deploys an application revision through the specified deployment group.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  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>]

Options

--application-name (string)

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

--deployment-group-name (string)

The name of the deployment group.

--revision (structure)

The type and location of the revision to deploy.

Shorthand Syntax:

revisionType=string,s3Location={bucket=string,key=string,bundleType=string,version=string,eTag=string},gitHubLocation={repository=string,commitId=string},string={content=string,sha256=string},appSpecContent={content=string,sha256=string}

JSON Syntax:

{
  "revisionType": "S3"|"GitHub"|"String"|"AppSpecContent",
  "s3Location": {
    "bucket": "string",
    "key": "string",
    "bundleType": "tar"|"tgz"|"zip"|"YAML"|"JSON",
    "version": "string",
    "eTag": "string"
  },
  "gitHubLocation": {
    "repository": "string",
    "commitId": "string"
  },
  "string": {
    "content": "string",
    "sha256": "string"
  },
  "appSpecContent": {
    "content": "string",
    "sha256": "string"
  }
}

--deployment-config-name (string)

The name of a deployment configuration associated with the IAM user or AWS account.

If not specified, the value configured in the deployment group is used as the default. If the deployment group does not have a deployment configuration associated with it, CodeDeployDefault.OneAtATime is used by default.

--description (string)

A comment about the deployment.

--ignore-application-stop-failures | --no-ignore-application-stop-failures (boolean)

If true, then if an ApplicationStop, BeforeBlockTraffic, or AfterBlockTraffic deployment lifecycle event to an instance fails, then the deployment continues to the next deployment lifecycle event. For example, if ApplicationStop fails, the deployment continues with DownloadBundle. If BeforeBlockTraffic fails, the deployment continues with BlockTraffic. If AfterBlockTraffic fails, the deployment continues with ApplicationStop.

If false or not specified, then if a lifecycle event fails during a deployment to an instance, that deployment fails. If deployment to that instance is part of an overall deployment and the number of healthy hosts is not less than the minimum number of healthy hosts, then a deployment to the next instance is attempted.

During a deployment, the AWS CodeDeploy agent runs the scripts specified for ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic in the AppSpec file from the previous successful deployment. (All other scripts are run from the AppSpec file in the current deployment.) If one of these scripts contains an error and does not run successfully, the deployment can fail.

If the cause of the failure is a script from the last successful deployment that will never run successfully, create a new deployment and use ignoreApplicationStopFailures to specify that the ApplicationStop, BeforeBlockTraffic, and AfterBlockTraffic failures should be ignored.

--target-instances (structure)

Information about the instances that belong to the replacement environment in a blue/green deployment.

JSON Syntax:

{
  "tagFilters": [
    {
      "Key": "string",
      "Value": "string",
      "Type": "KEY_ONLY"|"VALUE_ONLY"|"KEY_AND_VALUE"
    }
    ...
  ],
  "autoScalingGroups": ["string", ...],
  "ec2TagSet": {
    "ec2TagSetList": [
      [
        {
          "Key": "string",
          "Value": "string",
          "Type": "KEY_ONLY"|"VALUE_ONLY"|"KEY_AND_VALUE"
        }
        ...
      ]
      ...
    ]
  }
}

--auto-rollback-configuration (structure)

Configuration information for an automatic rollback that is added when a deployment is created.

Shorthand Syntax:

enabled=boolean,events=string,string

JSON Syntax:

{
  "enabled": true|false,
  "events": ["DEPLOYMENT_FAILURE"|"DEPLOYMENT_STOP_ON_ALARM"|"DEPLOYMENT_STOP_ON_REQUEST", ...]
}

--update-outdated-instances-only | --no-update-outdated-instances-only (boolean)

Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.

--file-exists-behavior (string)

Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.

The fileExistsBehavior parameter takes any of the following values:

  • DISALLOW: The deployment fails. This is also the default behavior if no option is specified.
  • OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.
  • RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.

Possible values:

  • DISALLOW
  • OVERWRITE
  • RETAIN

--s3-location (structure) Information about the location of the application revision in Amazon S3. You must specify the bucket, the key, and bundleType. Optionally, you can also specify an eTag and version.

Shorthand Syntax:

bundleType=string,eTag=string,bucket=string,version=string,key=string

JSON Syntax:

{
  "bundleType": "tar"|"tgz"|"zip",
  "eTag": "string",
  "bucket": "string",
  "version": "string",
  "key": "string"
}

--github-location (structure) Information about the location of the application revision in GitHub. You must specify the repository and commit ID that references the application revision. For the repository, use the format GitHub-account/repository-name or GitHub-org/repository-name. For the commit ID, use the SHA1 Git commit reference.

Shorthand Syntax:

commitId=string,repository=string

JSON Syntax:

{
  "commitId": "string",
  "repository": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

Example 1: To create a CodeDeploy deployment using the EC2/On-premises compute platform

The following create-deployment example creates a deployment and associates it with the user's AWS account.

aws deploy create-deployment \
    --application-name WordPress_App \
    --deployment-config-name CodeDeployDefault.OneAtATime \
    --deployment-group-name WordPress_DG \
    --description "My demo deployment" \
    --s3-location bucket=CodeDeployDemoBucket,bundleType=zip,eTag=dd56cfdEXAMPLE8e768f9d77fEXAMPLE,key=WordPressApp.zip

Output:

{
    "deploymentId": "d-A1B2C3111"
}

Example 2: To create a CodeDeploy deployment using the Amazon ECS compute platform

The following create-deployment example uses the following two files to deploy an Amazon ECS service.

Contents of create-deployment.json file:

{
    "applicationName": "ecs-deployment",
    "deploymentGroupName": "ecs-deployment-dg",
    "revision": {
        "revisionType": "S3",
        "s3Location": {
            "bucket": "ecs-deployment-bucket",
            "key": "appspec.yaml",
            "bundleType": "YAML"
        }
    }
}

That file, in turn, retrieves the following file appspec.yaml from an S3 bucket called ecs-deployment-bucket.

version: 0.0
Resources:
  - TargetService:
      Type: AWS::ECS::Service
      Properties:
        TaskDefinition: "arn:aws:ecs:region:123456789012:task-definition/ecs-task-def:2"
        LoadBalancerInfo:
          ContainerName: "sample-app"
          ContainerPort: 80
        PlatformVersion: "LATEST"

Command:

aws deploy create-deployment \
    --cli-input-json file://create-deployment.json \
    --region us-east-1

Output:

{
    "deploymentId": "d-1234ABCDE"
}

For more information, see CreateDeployment in the AWS CodeDeploy API Reference.

Output

deploymentId -> (string)

The unique ID of a deployment.