Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS CodeDeploy Resource Types Reference » AWS::CodeDeploy::DeploymentConfig

AWS::CodeDeploy::DeploymentConfig

The AWS::CodeDeploy::DeploymentConfig resource creates a set of deployment rules, deployment success conditions, and deployment failure conditions that AWS CodeDeploy uses during a deployment. The deployment configuration specifies, through the use of a MinimumHealthyHosts value, the number or percentage of instances that must remain available at any time during a deployment.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::CodeDeploy::DeploymentConfig",
  "Properties" : {
    "DeploymentConfigName" : String,
    "MinimumHealthyHosts" : MinimumHealthyHosts
  }
}

YAML

Type: AWS::CodeDeploy::DeploymentConfig
Properties:
  DeploymentConfigName: String
  MinimumHealthyHosts:
    MinimumHealthyHosts

Properties

DeploymentConfigName

A name for the deployment configuration. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the deployment configuration name. For more information, see Name Type.

Important

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

Required: No

Type: String

Update requires: Replacement

MinimumHealthyHosts

The minimum number of healthy instances that must be available at any time during an AWS CodeDeploy deployment. For example, for a fleet of nine instances, if you specify a minimum of six healthy instances, AWS CodeDeploy deploys your application up to three instances at a time so that you always have six healthy instances. The deployment succeeds if your application successfully deploys to six or more instances; otherwise, the deployment fails.

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

Required: Yes

Type: AWS CodeDeploy DeploymentConfig MinimumHealthyHosts

Update requires: Replacement

Return Value

Ref

When you pass the logical ID of an AWS::CodeDeploy::DeploymentConfig resource to the intrinsic Ref function, the function returns the deployment configuration name, such as mydeploymentconfig-a123d0d1.

For more information about using the Ref function, see Ref.

Example

The following example requires at least 75% of the fleet to be healthy. For example, if you had a fleet of four instances, the deployment proceeds one instance at a time.

JSON

"TwentyFivePercentAtATime" : {
  "Type" : "AWS::CodeDeploy::DeploymentConfig",
  "Properties" : {
    "MinimumHealthyHosts" : {
      "Type" : "FLEET_PERCENT",
      "Value" : "75"
    }
  }
}

YAML

TwentyFivePercentAtATime: 
  Type: AWS::CodeDeploy::DeploymentConfig
  Properties: 
    MinimumHealthyHosts: 
      Type: "FLEET_PERCENT"
      Value: 75