You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodeDeploy::Types::MinimumHealthyHosts

Inherits:

Struct

Object
Struct
Aws::CodeDeploy::Types::MinimumHealthyHosts

show all

Defined in:: gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb

Overview

Note:

When making an API call, you may pass MinimumHealthyHosts data as a hash:

{
  value: 1,
  type: "HOST_COUNT", # accepts HOST_COUNT, FLEET_PERCENT
}

Information about minimum healthy instance.

Instance Attribute Summary collapse

#type ⇒ String
The minimum healthy instance type:.
#value ⇒ Integer
The minimum healthy instance value.

Instance Attribute Details

#type ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 3801

class MinimumHealthyHosts < Struct.new(
  :value,
  :type)
  include Aws::Structure
end

#value ⇒ `Integer`

The minimum healthy instance value.