com.amazonaws.services.codedeploy.model.MinimumHealthyHosts Maven / Gradle / Ivy
Show all versions of aws-java-sdk-codedeploy Show documentation
/*
* Copyright 2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.codedeploy.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Information about minimum healthy instance.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class MinimumHealthyHosts implements Serializable, Cloneable, StructuredPojo {
/**
*
* 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, 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.
*
*/
private String type;
/**
*
* The minimum healthy instance value.
*
*/
private Integer value;
/**
*
* 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, 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.
*
*
* @param 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, 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 MinimumHealthyHostsType
*/
public void setType(String type) {
this.type = 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, 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.
*
*
* @return 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, 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 MinimumHealthyHostsType
*/
public String getType() {
return this.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, 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.
*
*
* @param 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, 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MinimumHealthyHostsType
*/
public MinimumHealthyHosts withType(String type) {
setType(type);
return this;
}
/**
*
* 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, 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.
*
*
* @param 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, 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 MinimumHealthyHostsType
*/
public void setType(MinimumHealthyHostsType type) {
withType(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, 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.
*
*
* @param 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, 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MinimumHealthyHostsType
*/
public MinimumHealthyHosts withType(MinimumHealthyHostsType type) {
this.type = type.toString();
return this;
}
/**
*
* The minimum healthy instance value.
*
*
* @param value
* The minimum healthy instance value.
*/
public void setValue(Integer value) {
this.value = value;
}
/**
*
* The minimum healthy instance value.
*
*
* @return The minimum healthy instance value.
*/
public Integer getValue() {
return this.value;
}
/**
*
* The minimum healthy instance value.
*
*
* @param value
* The minimum healthy instance value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MinimumHealthyHosts withValue(Integer value) {
setValue(value);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getValue() != null)
sb.append("Value: ").append(getValue());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof MinimumHealthyHosts == false)
return false;
MinimumHealthyHosts other = (MinimumHealthyHosts) obj;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getValue() == null ^ this.getValue() == null)
return false;
if (other.getValue() != null && other.getValue().equals(this.getValue()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode());
return hashCode;
}
@Override
public MinimumHealthyHosts clone() {
try {
return (MinimumHealthyHosts) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.codedeploy.model.transform.MinimumHealthyHostsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}