Class MinimumHealthyHosts
- java.lang.Object
-
- software.amazon.awssdk.services.codedeploy.model.MinimumHealthyHosts
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<MinimumHealthyHosts.Builder,MinimumHealthyHosts>
@Generated("software.amazon.awssdk:codegen") public final class MinimumHealthyHosts extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MinimumHealthyHosts.Builder,MinimumHealthyHosts>
Information about the minimum number of healthy instances.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceMinimumHealthyHosts.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MinimumHealthyHosts.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends MinimumHealthyHosts.Builder>serializableBuilderClass()MinimumHealthyHosts.BuildertoBuilder()StringtoString()Returns a string representation of this object.MinimumHealthyHostsTypetype()The minimum healthy instance type:StringtypeAsString()The minimum healthy instance type:Integervalue()The minimum healthy instance value.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
type
public final MinimumHealthyHostsType type()
The minimum healthy instance type:
-
HOST_COUNT: The minimum number of healthy instances as an absolute value. -
FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number of instances in the deployment.
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.
In a call to the
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, 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 CodeDeploy Instance Health in the CodeDeploy User Guide.
If the service returns an enum value that is not available in the current SDK version,
typewill returnMinimumHealthyHostsType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The minimum healthy instance type:
-
HOST_COUNT: The minimum number of healthy instances as an absolute value. -
FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number of instances in the deployment.
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.
In a call to the
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, 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 CodeDeploy Instance Health in the CodeDeploy User Guide.
-
- See Also:
MinimumHealthyHostsType
-
-
typeAsString
public final String typeAsString()
The minimum healthy instance type:
-
HOST_COUNT: The minimum number of healthy instances as an absolute value. -
FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number of instances in the deployment.
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.
In a call to the
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, 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 CodeDeploy Instance Health in the CodeDeploy User Guide.
If the service returns an enum value that is not available in the current SDK version,
typewill returnMinimumHealthyHostsType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtypeAsString().- Returns:
- The minimum healthy instance type:
-
HOST_COUNT: The minimum number of healthy instances as an absolute value. -
FLEET_PERCENT: The minimum number of healthy instances as a percentage of the total number of instances in the deployment.
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.
In a call to the
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, 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 CodeDeploy Instance Health in the CodeDeploy User Guide.
-
- See Also:
MinimumHealthyHostsType
-
-
value
public final Integer value()
The minimum healthy instance value.
- Returns:
- The minimum healthy instance value.
-
toBuilder
public MinimumHealthyHosts.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<MinimumHealthyHosts.Builder,MinimumHealthyHosts>
-
builder
public static MinimumHealthyHosts.Builder builder()
-
serializableBuilderClass
public static Class<? extends MinimumHealthyHosts.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-