Table Of Contents

Feedback

User Guide

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

[ aws . deploy ]

get-deployment-config

Description

Gets information about a deployment configuration.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-deployment-config
--deployment-config-name <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--deployment-config-name (string)

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

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

--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 get information about a deployment configuration

This example displays information about a deployment configuration that is associated with the user's AWS account.

Command:

aws deploy get-deployment-config --deployment-config-name ThreeQuartersHealthy

Output:

{
    "deploymentConfigInfo": {
        "deploymentConfigId": "bf6b390b-61d3-4f24-8911-a1664EXAMPLE",
        "minimumHealthyHosts": {
            "type": "FLEET_PERCENT",
            "value": 75
        },
        "createTime": 1411081164.379,
        "deploymentConfigName": "ThreeQuartersHealthy"
    }
}

Output

deploymentConfigInfo -> (structure)

Information about the deployment configuration.

deploymentConfigId -> (string)

The deployment configuration ID.

deploymentConfigName -> (string)

The deployment configuration name.

minimumHealthyHosts -> (structure)

Information about the number or percentage of minimum healthy instance.

value -> (integer)

The minimum healthy instance value.

type -> (string)

The minimum healthy instance type:

  • HOST_COUNT: The minimum number of healthy instance as an absolute value.
  • FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment.

In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment will be successful if six or more instances are deployed to successfully; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment will be successful if four or more instance are deployed to successfully; otherwise, the deployment fails.

Note

In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime will return a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy will try to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment still succeeds.

For more information, see AWS CodeDeploy Instance Health in the AWS CodeDeploy User Guide .

createTime -> (timestamp)

The time at which the deployment configuration was created.

computePlatform -> (string)

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

trafficRoutingConfig -> (structure)

The configuration specifying how the deployment traffic will be routed. Only deployments with a Lambda compute platform can specify this.

type -> (string)

The type of traffic shifting (TimeBasedCanary or TimeBasedLinear ) used by a deployment configuration .

timeBasedCanary -> (structure)

A configuration that shifts traffic from one version of a Lambda function to another in two increments. The original and target Lambda function versions are specified in the deployment's AppSpec file.

canaryPercentage -> (integer)

The percentage of traffic to shift in the first increment of a TimeBasedCanary deployment.

canaryInterval -> (integer)

The number of minutes between the first and second traffic shifts of a TimeBasedCanary deployment.

timeBasedLinear -> (structure)

A configuration that shifts traffic from one version of a Lambda function to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions are specified in the deployment's AppSpec file.

linearPercentage -> (integer)

The percentage of traffic that is shifted at the start of each increment of a TimeBasedLinear deployment.

linearInterval -> (integer)

The number of minutes between each incremental traffic shift of a TimeBasedLinear deployment.