Amazon CodeDeploy · JSON Structure

Amazon Codedeploy Deployment Ready Option Structure

Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.

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

DeploymentReadyOption 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

actionOnTimeout waitTimeInMinutes

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-deployment-ready-option-structure.json",
  "name": "DeploymentReadyOption",
  "description": "Information about how traffic is rerouted to instances in a replacement environment in a blue/green deployment.",
  "type": "object",
  "properties": {
    "actionOnTimeout": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeploymentReadyAction"
        },
        {
          "description": "<p>Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.</p> <ul> <li> <p>CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.</p> </li> <li> <p>STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using <a>ContinueDeployment</a>. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.</p> </li> </ul>"
        }
      ]
    },
    "waitTimeInMinutes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Duration"
        },
        {
          "description": "The number of minutes to wait before the status of a blue/green deployment is changed to Stopped if rerouting is not started manually. Applies only to the <code>STOP_DEPLOYMENT</code> option for <code>actionOnTimeout</code>."
        }
      ]
    }
  }
}