MinimumHealthyHosts (AWS Java SDK :: Services :: AWS CodeDeploy 2.10.27 API)

java.lang.Object
- software.amazon.awssdk.services.codedeploy.model.MinimumHealthyHosts

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<MinimumHealthyHosts.Builder,MinimumHealthyHosts>

@Generated(value="software.amazon.awssdk:codegen")
public final class MinimumHealthyHosts
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MinimumHealthyHosts.Builder,MinimumHealthyHosts>

Information about minimum healthy instance.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MinimumHealthyHosts.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MinimumHealthyHosts.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MinimumHealthyHosts.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MinimumHealthyHosts.Builder>`	`serializableBuilderClass()`
`MinimumHealthyHosts.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`MinimumHealthyHostsType`	`type()` The minimum healthy instance type:
`String`	`typeAsString()` The minimum healthy instance type:
`Integer`	`value()` 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
  - value
```
public Integer value()
```
    The minimum healthy instance value.
    
    Returns:
    
    The minimum healthy instance value.
  - type
```
public MinimumHealthyHostsType type()
```
    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 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, 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.
    
    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 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 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, 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.
    See Also:
    
    MinimumHealthyHostsType
  - typeAsString
```
public String typeAsString()
```
    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 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, 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.
    
    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 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 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, 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.
    See Also:
    
    MinimumHealthyHostsType
  - toBuilder
```
public MinimumHealthyHosts.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MinimumHealthyHosts.Builder,MinimumHealthyHosts>
  - builder
```
public static MinimumHealthyHosts.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MinimumHealthyHosts.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class MinimumHealthyHosts

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

value

type

typeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields