libZSservicesZSamazonka-appconfigZSamazonka-appconfig
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.AppConfig.UpdateDeploymentStrategy

Description

Updates a deployment strategy.

Synopsis

Creating a Request

data UpdateDeploymentStrategy Source #

See: newUpdateDeploymentStrategy smart constructor.

Constructors

UpdateDeploymentStrategy' 

Fields

  • growthFactor :: Maybe Double

    The percentage of targets to receive a deployed configuration during each interval.

  • deploymentDurationInMinutes :: Maybe Natural

    Total amount of time for a deployment to last.

  • finalBakeTimeInMinutes :: Maybe Natural

    The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

  • description :: Maybe Text

    A description of the deployment strategy.

  • growthType :: Maybe GrowthType

    The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:

    Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.

    Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

    2*(2^0)
    2*(2^1)
    2*(2^2)

    Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

  • deploymentStrategyId :: Text

    The deployment strategy ID.

Instances

Instances details
Eq UpdateDeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.UpdateDeploymentStrategy

Read UpdateDeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.UpdateDeploymentStrategy

Show UpdateDeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.UpdateDeploymentStrategy

Generic UpdateDeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.UpdateDeploymentStrategy

Associated Types

type Rep UpdateDeploymentStrategy :: Type -> Type #

NFData UpdateDeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.UpdateDeploymentStrategy

Hashable UpdateDeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.UpdateDeploymentStrategy

ToJSON UpdateDeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.UpdateDeploymentStrategy

AWSRequest UpdateDeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.UpdateDeploymentStrategy

ToHeaders UpdateDeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.UpdateDeploymentStrategy

ToPath UpdateDeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.UpdateDeploymentStrategy

ToQuery UpdateDeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.UpdateDeploymentStrategy

type Rep UpdateDeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.UpdateDeploymentStrategy

type Rep UpdateDeploymentStrategy = D1 ('MetaData "UpdateDeploymentStrategy" "Amazonka.AppConfig.UpdateDeploymentStrategy" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "UpdateDeploymentStrategy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "growthFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: (S1 ('MetaSel ('Just "deploymentDurationInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "finalBakeTimeInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "growthType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GrowthType)) :*: S1 ('MetaSel ('Just "deploymentStrategyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateDeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.UpdateDeploymentStrategy

newUpdateDeploymentStrategy Source #

Create a value of UpdateDeploymentStrategy 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:growthFactor:UpdateDeploymentStrategy', updateDeploymentStrategy_growthFactor - The percentage of targets to receive a deployed configuration during each interval.

$sel:deploymentDurationInMinutes:UpdateDeploymentStrategy', updateDeploymentStrategy_deploymentDurationInMinutes - Total amount of time for a deployment to last.

$sel:finalBakeTimeInMinutes:UpdateDeploymentStrategy', updateDeploymentStrategy_finalBakeTimeInMinutes - The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

$sel:description:UpdateDeploymentStrategy', updateDeploymentStrategy_description - A description of the deployment strategy.

$sel:growthType:UpdateDeploymentStrategy', updateDeploymentStrategy_growthType - The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.

Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)
2*(2^1)
2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

$sel:deploymentStrategyId:UpdateDeploymentStrategy', updateDeploymentStrategy_deploymentStrategyId - The deployment strategy ID.

Request Lenses

updateDeploymentStrategy_growthFactor :: Lens' UpdateDeploymentStrategy (Maybe Double) Source #

The percentage of targets to receive a deployed configuration during each interval.

updateDeploymentStrategy_finalBakeTimeInMinutes :: Lens' UpdateDeploymentStrategy (Maybe Natural) Source #

The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

updateDeploymentStrategy_growthType :: Lens' UpdateDeploymentStrategy (Maybe GrowthType) Source #

The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.

Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)
2*(2^1)
2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

Destructuring the Response

data DeploymentStrategy Source #

See: newDeploymentStrategy smart constructor.

Constructors

DeploymentStrategy' 

Fields

Instances

Instances details
Eq DeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.Types.DeploymentStrategy

Read DeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.Types.DeploymentStrategy

Show DeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.Types.DeploymentStrategy

Generic DeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.Types.DeploymentStrategy

Associated Types

type Rep DeploymentStrategy :: Type -> Type #

NFData DeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.Types.DeploymentStrategy

Methods

rnf :: DeploymentStrategy -> () #

Hashable DeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.Types.DeploymentStrategy

FromJSON DeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.Types.DeploymentStrategy

type Rep DeploymentStrategy Source # 
Instance details

Defined in Amazonka.AppConfig.Types.DeploymentStrategy

type Rep DeploymentStrategy = D1 ('MetaData "DeploymentStrategy" "Amazonka.AppConfig.Types.DeploymentStrategy" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "DeploymentStrategy'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "growthFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "replicateTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicateTo))) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "deploymentDurationInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "finalBakeTimeInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "growthType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GrowthType))))))

newDeploymentStrategy :: DeploymentStrategy Source #

Create a value of DeploymentStrategy 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:growthFactor:DeploymentStrategy', deploymentStrategy_growthFactor - The percentage of targets that received a deployed configuration during each interval.

$sel:replicateTo:DeploymentStrategy', deploymentStrategy_replicateTo - Save the deployment strategy to a Systems Manager (SSM) document.

$sel:name:DeploymentStrategy', deploymentStrategy_name - The name of the deployment strategy.

$sel:id:DeploymentStrategy', deploymentStrategy_id - The deployment strategy ID.

$sel:deploymentDurationInMinutes:DeploymentStrategy', deploymentStrategy_deploymentDurationInMinutes - Total amount of time the deployment lasted.

$sel:finalBakeTimeInMinutes:DeploymentStrategy', deploymentStrategy_finalBakeTimeInMinutes - The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

$sel:description:DeploymentStrategy', deploymentStrategy_description - The description of the deployment strategy.

$sel:growthType:DeploymentStrategy', deploymentStrategy_growthType - The algorithm used to define how percentage grew over time.

Response Lenses

deploymentStrategy_growthFactor :: Lens' DeploymentStrategy (Maybe Double) Source #

The percentage of targets that received a deployed configuration during each interval.

deploymentStrategy_replicateTo :: Lens' DeploymentStrategy (Maybe ReplicateTo) Source #

Save the deployment strategy to a Systems Manager (SSM) document.

deploymentStrategy_name :: Lens' DeploymentStrategy (Maybe Text) Source #

The name of the deployment strategy.

deploymentStrategy_finalBakeTimeInMinutes :: Lens' DeploymentStrategy (Maybe Natural) Source #

The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

deploymentStrategy_description :: Lens' DeploymentStrategy (Maybe Text) Source #

The description of the deployment strategy.

deploymentStrategy_growthType :: Lens' DeploymentStrategy (Maybe GrowthType) Source #

The algorithm used to define how percentage grew over time.