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

Inherits:
Struct
  • Object
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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#typeString

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.

Returns:

  • (String)


4683
4684
4685
4686
4687
4688
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 4683

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

#valueInteger

The minimum healthy instance value.

Returns:

  • (Integer)


4683
4684
4685
4686
4687
4688
# File 'gems/aws-sdk-codedeploy/lib/aws-sdk-codedeploy/types.rb', line 4683

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