Class CfnDeploymentConfig.MinimumHealthyHostsProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDeploymentConfig.MinimumHealthyHostsProperty>
- Enclosing interface:
CfnDeploymentConfig.MinimumHealthyHostsProperty
CfnDeploymentConfig.MinimumHealthyHostsProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.Sets the value ofCfnDeploymentConfig.MinimumHealthyHostsProperty.getType()
Sets the value ofCfnDeploymentConfig.MinimumHealthyHostsProperty.getValue()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
type
Sets the value ofCfnDeploymentConfig.MinimumHealthyHostsProperty.getType()
- Parameters:
type
- The minimum healthy instance type:. This parameter is required.- 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 .
- Returns:
this
-
value
@Stability(Stable) public CfnDeploymentConfig.MinimumHealthyHostsProperty.Builder value(Number value) Sets the value ofCfnDeploymentConfig.MinimumHealthyHostsProperty.getValue()
- Parameters:
value
- The minimum healthy instance value. This parameter is required.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDeploymentConfig.MinimumHealthyHostsProperty>
- Returns:
- a new instance of
CfnDeploymentConfig.MinimumHealthyHostsProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-