Skip to content

DeploymentReadyOption

Source code in docs_src/capo_codedeploy/types/deployment_ready_option.py
class DeploymentReadyOption(TypedDict, closed=True):
    action_on_timeout: NotRequired[
        "capo_codedeploy.types.deployment_ready_action.DeploymentReadyAction"
    ]
    """<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>"""
    wait_time_in_minutes: "capo_codedeploy.types.duration.Duration"
    """<p>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>.</p>"""

action_on_timeout instance-attribute

action_on_timeout: NotRequired[DeploymentReadyAction]

Information about when to reroute traffic from an original environment to a replacement environment in a blue/green deployment.

  • CONTINUE_DEPLOYMENT: Register new instances with the load balancer immediately after the new application revision is installed on the instances in the replacement environment.

  • STOP_DEPLOYMENT: Do not register new instances with a load balancer unless traffic rerouting is started using ContinueDeployment. If traffic rerouting is not started before the end of the specified wait period, the deployment status is changed to Stopped.

wait_time_in_minutes instance-attribute

wait_time_in_minutes: Duration

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 STOP_DEPLOYMENT option for actionOnTimeout.