Package software.amazon.awscdk.services.codedeploy

Interface CfnDeploymentConfig.MinimumHealthyHostsProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDeploymentConfig.MinimumHealthyHostsProperty.Jsii$Proxy
Enclosing class:
CfnDeploymentConfig
@Stability(Stable) public static interface CfnDeploymentConfig.MinimumHealthyHostsProperty extends software.amazon.jsii.JsiiSerializable
MinimumHealthyHosts is a property of the DeploymentConfig resource that defines how many instances must remain healthy during an AWS CodeDeploy deployment.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.codedeploy.*;
 MinimumHealthyHostsProperty minimumHealthyHostsProperty = MinimumHealthyHostsProperty.builder()
         .type("type")
         .value(123)
         .build();

  • Method Details

    • getType

      @Stability(Stable) @NotNull String getType()
      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 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 instance at a time. The deployment is successful if four or more instance are deployed to successfully. Otherwise, the deployment fails.

      In a call to GetDeploymentConfig , 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, AWS 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.

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

    • getValue

      @Stability(Stable) @NotNull Number getValue()
      The minimum healthy instance value.

    • builder

      @Stability(Stable) static CfnDeploymentConfig.MinimumHealthyHostsProperty.Builder builder()
      Returns:
      a CfnDeploymentConfig.MinimumHealthyHostsProperty.Builder of CfnDeploymentConfig.MinimumHealthyHostsProperty