Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Updates a deployment strategy.
Synopsis
- data UpdateDeploymentStrategy = UpdateDeploymentStrategy' {}
- newUpdateDeploymentStrategy :: Text -> UpdateDeploymentStrategy
- updateDeploymentStrategy_growthFactor :: Lens' UpdateDeploymentStrategy (Maybe Double)
- updateDeploymentStrategy_deploymentDurationInMinutes :: Lens' UpdateDeploymentStrategy (Maybe Natural)
- updateDeploymentStrategy_finalBakeTimeInMinutes :: Lens' UpdateDeploymentStrategy (Maybe Natural)
- updateDeploymentStrategy_description :: Lens' UpdateDeploymentStrategy (Maybe Text)
- updateDeploymentStrategy_growthType :: Lens' UpdateDeploymentStrategy (Maybe GrowthType)
- updateDeploymentStrategy_deploymentStrategyId :: Lens' UpdateDeploymentStrategy Text
- data DeploymentStrategy = DeploymentStrategy' {}
- newDeploymentStrategy :: DeploymentStrategy
- deploymentStrategy_growthFactor :: Lens' DeploymentStrategy (Maybe Double)
- deploymentStrategy_replicateTo :: Lens' DeploymentStrategy (Maybe ReplicateTo)
- deploymentStrategy_name :: Lens' DeploymentStrategy (Maybe Text)
- deploymentStrategy_id :: Lens' DeploymentStrategy (Maybe Text)
- deploymentStrategy_deploymentDurationInMinutes :: Lens' DeploymentStrategy (Maybe Natural)
- deploymentStrategy_finalBakeTimeInMinutes :: Lens' DeploymentStrategy (Maybe Natural)
- deploymentStrategy_description :: Lens' DeploymentStrategy (Maybe Text)
- deploymentStrategy_growthType :: Lens' DeploymentStrategy (Maybe GrowthType)
Creating a Request
data UpdateDeploymentStrategy Source #
See: newUpdateDeploymentStrategy
smart constructor.
UpdateDeploymentStrategy' | |
|
Instances
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_deploymentDurationInMinutes :: Lens' UpdateDeploymentStrategy (Maybe Natural) Source #
Total amount of time for a deployment to last.
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_description :: Lens' UpdateDeploymentStrategy (Maybe Text) Source #
A description of the deployment strategy.
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.
updateDeploymentStrategy_deploymentStrategyId :: Lens' UpdateDeploymentStrategy Text Source #
The deployment strategy ID.
Destructuring the Response
data DeploymentStrategy Source #
See: newDeploymentStrategy
smart constructor.
DeploymentStrategy' | |
|
Instances
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_id :: Lens' DeploymentStrategy (Maybe Text) Source #
The deployment strategy ID.
deploymentStrategy_deploymentDurationInMinutes :: Lens' DeploymentStrategy (Maybe Natural) Source #
Total amount of time the deployment lasted.
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.