Table Of Contents

Feedback

User Guide

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

[ aws . deploy ]

create-deployment-config

Description

Creates a deployment configuration.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-deployment-config
--deployment-config-name <value>
[--minimum-healthy-hosts <value>]
[--traffic-routing-config <value>]
[--compute-platform <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--deployment-config-name (string)

The name of the deployment configuration to create.

--minimum-healthy-hosts (structure)

The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.

The type parameter takes either of the following values:

  • HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.
  • FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances.

The value parameter takes an integer.

For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.

Shorthand Syntax:

value=integer,type=string

JSON Syntax:

{
  "value": integer,
  "type": "HOST_COUNT"|"FLEET_PERCENT"
}

--traffic-routing-config (structure)

The configuration that specifies how the deployment traffic will be routed.

Shorthand Syntax:

type=string,timeBasedCanary={canaryPercentage=integer,canaryInterval=integer},timeBasedLinear={linearPercentage=integer,linearInterval=integer}

JSON Syntax:

{
  "type": "TimeBasedCanary"|"TimeBasedLinear"|"AllAtOnce",
  "timeBasedCanary": {
    "canaryPercentage": integer,
    "canaryInterval": integer
  },
  "timeBasedLinear": {
    "linearPercentage": integer,
    "linearInterval": integer
  }
}

--compute-platform (string)

The destination platform type for the deployment (Lambda or Server ).

Possible values:

  • Server
  • Lambda

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

To create a custom deployment configuration

This example creates a custom deployment configuration and associates it with the user's AWS account.

Command:

aws deploy create-deployment-config --deployment-config-name ThreeQuartersHealthy --minimum-healthy-hosts type=FLEET_PERCENT,value=75

Output:

{
    "deploymentConfigId": "bf6b390b-61d3-4f24-8911-a1664EXAMPLE"
}

Output

deploymentConfigId -> (string)

A unique deployment configuration ID.