libZSservicesZSamazonka-codedeployZSamazonka-codedeploy
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CodeDeploy.Types.MinimumHealthyHosts

Description

 
Synopsis

Documentation

data MinimumHealthyHosts Source #

Information about minimum healthy instance.

See: newMinimumHealthyHosts smart constructor.

Constructors

MinimumHealthyHosts' 

Fields

  • value :: Maybe Int

    The minimum healthy instance value.

  • type' :: Maybe MinimumHealthyHostsType

    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.

Instances

Instances details
Eq MinimumHealthyHosts Source # 
Instance details

Defined in Amazonka.CodeDeploy.Types.MinimumHealthyHosts

Read MinimumHealthyHosts Source # 
Instance details

Defined in Amazonka.CodeDeploy.Types.MinimumHealthyHosts

Show MinimumHealthyHosts Source # 
Instance details

Defined in Amazonka.CodeDeploy.Types.MinimumHealthyHosts

Generic MinimumHealthyHosts Source # 
Instance details

Defined in Amazonka.CodeDeploy.Types.MinimumHealthyHosts

Associated Types

type Rep MinimumHealthyHosts :: Type -> Type #

NFData MinimumHealthyHosts Source # 
Instance details

Defined in Amazonka.CodeDeploy.Types.MinimumHealthyHosts

Methods

rnf :: MinimumHealthyHosts -> () #

Hashable MinimumHealthyHosts Source # 
Instance details

Defined in Amazonka.CodeDeploy.Types.MinimumHealthyHosts

ToJSON MinimumHealthyHosts Source # 
Instance details

Defined in Amazonka.CodeDeploy.Types.MinimumHealthyHosts

FromJSON MinimumHealthyHosts Source # 
Instance details

Defined in Amazonka.CodeDeploy.Types.MinimumHealthyHosts

type Rep MinimumHealthyHosts Source # 
Instance details

Defined in Amazonka.CodeDeploy.Types.MinimumHealthyHosts

type Rep MinimumHealthyHosts = D1 ('MetaData "MinimumHealthyHosts" "Amazonka.CodeDeploy.Types.MinimumHealthyHosts" "libZSservicesZSamazonka-codedeployZSamazonka-codedeploy" 'False) (C1 ('MetaCons "MinimumHealthyHosts'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MinimumHealthyHostsType))))

newMinimumHealthyHosts :: MinimumHealthyHosts Source #

Create a value of MinimumHealthyHosts with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:value:MinimumHealthyHosts', minimumHealthyHosts_value - The minimum healthy instance value.

$sel:type':MinimumHealthyHosts', minimumHealthyHosts_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.

minimumHealthyHosts_value :: Lens' MinimumHealthyHosts (Maybe Int) Source #

The minimum healthy instance value.

minimumHealthyHosts_type :: Lens' MinimumHealthyHosts (Maybe MinimumHealthyHostsType) Source #

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.