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:

  • Method Details

    • 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, type will return MinimumHealthyHostsType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      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:

    • 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, type will return MinimumHealthyHostsType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      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:

    • value

      public final Integer value()

      The minimum healthy instance value.

      Returns:
      The minimum healthy instance value.

    • toBuilder

      public MinimumHealthyHosts.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<MinimumHealthyHosts.Builder,MinimumHealthyHosts>
      Returns:
      a builder for type T

    • builder

      public static MinimumHealthyHosts.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MinimumHealthyHosts.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.