Amazon CodeDeploy · JSON Structure

Amazon Codedeploy Minimum Healthy Hosts Structure

Information about minimum healthy instance.

Type: object Properties: 2
AmazonDeploymentDevOpsCI/CDRelease ManagementBlue/Green Deployment

MinimumHealthyHosts is a JSON Structure definition published by Amazon CodeDeploy, describing 2 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

type value

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codedeploy/refs/heads/main/json-structure/amazon-codedeploy-minimum-healthy-hosts-structure.json",
  "name": "MinimumHealthyHosts",
  "description": "Information about minimum healthy instance.",
  "type": "object",
  "properties": {
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MinimumHealthyHostsType"
        },
        {
          "description": "<p>The minimum healthy instance type:</p> <ul> <li> <p> <code>HOST_COUNT</code>: The minimum number of healthy instances as an absolute value.</p> </li> <li> <p> <code>FLEET_PERCENT</code>: The minimum number of healthy instances as a percentage of the total number of instances in the deployment.</p> </li> </ul> <p>In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is 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 instances at a time. The deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.</p> <note> <p>In a call to the <code>GetDeploymentConfig</code>, CodeDeployDefault.OneAtATime returns 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, CodeDeploy attempts 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 is still successful.</p> </note> <p>For more information, see <a href=\"https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html\">CodeDeploy Instance Health</a> in the <i>CodeDeploy User Guide</i>.</p>"
        }
      ]
    },
    "value": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MinimumHealthyHostsValue"
        },
        {
          "description": "The minimum healthy instance value."
        }
      ]
    }
  }
}