Class: AWSCDK::CodeDeploy::CfnDeploymentConfig::MinimumHealthyHostsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::CodeDeploy::CfnDeploymentConfig::MinimumHealthyHostsProperty

Defined in:

code_deploy/cfn_deployment_config.rb

Overview

MinimumHealthyHosts is a property of the DeploymentConfig resource that defines how many instances must remain healthy during an AWS CodeDeploy deployment.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html

Instance Attribute Summary

• #type ⇒ String readonly

  The minimum healthy instance type:.

• #value ⇒ Numeric readonly

  The minimum healthy instance value.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(type:, value:) ⇒ MinimumHealthyHostsProperty constructor

  A new instance of MinimumHealthyHostsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(type:, value:) ⇒ MinimumHealthyHostsProperty

Returns a new instance of MinimumHealthyHostsProperty.

Parameters:

• type (String) —

  The minimum healthy instance type:.

• value (Numeric) —

  The minimum healthy instance value.

# File 'code_deploy/cfn_deployment_config.rb', line 593

def initialize(type:, value:)
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type")
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "value")
end

Instance Attribute Details

#type ⇒ String (readonly)

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 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)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts-type

# File 'code_deploy/cfn_deployment_config.rb', line 613

def type
  @type
end

#value ⇒ Numeric (readonly)

The minimum healthy instance value.

Returns:

• (Numeric)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codedeploy-deploymentconfig-minimumhealthyhosts.html#cfn-codedeploy-deploymentconfig-minimumhealthyhosts-value

# File 'code_deploy/cfn_deployment_config.rb', line 618

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object

# File 'code_deploy/cfn_deployment_config.rb', line 620

def self.jsii_properties
  {
    :type => "type",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'code_deploy/cfn_deployment_config.rb', line 627

def to_jsii
  result = {}
  result.merge!({
    "type" => @type,
    "value" => @value,
  })
  result.compact
end