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

Amazonka.AppConfig.CreateDeploymentStrategy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

Synopsis

data CreateDeploymentStrategy = CreateDeploymentStrategy' {
- finalBakeTimeInMinutes :: Maybe Natural
- description :: Maybe Text
- growthType :: Maybe GrowthType
- tags :: Maybe (HashMap Text Text)
- name :: Text
- deploymentDurationInMinutes :: Natural
- growthFactor :: Double
- replicateTo :: ReplicateTo
}
newCreateDeploymentStrategy :: Text -> Natural -> Double -> ReplicateTo -> CreateDeploymentStrategy
createDeploymentStrategy_finalBakeTimeInMinutes :: Lens' CreateDeploymentStrategy (Maybe Natural)
createDeploymentStrategy_description :: Lens' CreateDeploymentStrategy (Maybe Text)
createDeploymentStrategy_growthType :: Lens' CreateDeploymentStrategy (Maybe GrowthType)
createDeploymentStrategy_tags :: Lens' CreateDeploymentStrategy (Maybe (HashMap Text Text))
createDeploymentStrategy_name :: Lens' CreateDeploymentStrategy Text
createDeploymentStrategy_deploymentDurationInMinutes :: Lens' CreateDeploymentStrategy Natural
createDeploymentStrategy_growthFactor :: Lens' CreateDeploymentStrategy Double
createDeploymentStrategy_replicateTo :: Lens' CreateDeploymentStrategy ReplicateTo
data DeploymentStrategy = DeploymentStrategy' {
- growthFactor :: Maybe Double
- replicateTo :: Maybe ReplicateTo
- name :: Maybe Text
- id :: Maybe Text
- deploymentDurationInMinutes :: Maybe Natural
- finalBakeTimeInMinutes :: Maybe Natural
- description :: Maybe Text
- growthType :: Maybe GrowthType
}
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 CreateDeploymentStrategy Source #

See: newCreateDeploymentStrategy smart constructor.

Constructors

CreateDeploymentStrategy'

Fields

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 dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the 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.
tags :: Maybe (HashMap Text Text)
Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
name :: Text
A name for the deployment strategy.
deploymentDurationInMinutes :: Natural
Total amount of time for a deployment to last.
growthFactor :: Double
The percentage of targets to receive a deployed configuration during each interval.
replicateTo :: ReplicateTo
Save the deployment strategy to a Systems Manager (SSM) document.

Instances

Instances details

Eq CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Methods (==) :: CreateDeploymentStrategy -> CreateDeploymentStrategy -> Bool # (/=) :: CreateDeploymentStrategy -> CreateDeploymentStrategy -> Bool #
Read CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Methods readsPrec :: Int -> ReadS CreateDeploymentStrategy # readList :: ReadS [CreateDeploymentStrategy] # readPrec :: ReadPrec CreateDeploymentStrategy # readListPrec :: ReadPrec [CreateDeploymentStrategy] #
Show CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Methods showsPrec :: Int -> CreateDeploymentStrategy -> ShowS # show :: CreateDeploymentStrategy -> String # showList :: [CreateDeploymentStrategy] -> ShowS #
Generic CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Associated Types type Rep CreateDeploymentStrategy :: Type -> Type # Methods from :: CreateDeploymentStrategy -> Rep CreateDeploymentStrategy x # to :: Rep CreateDeploymentStrategy x -> CreateDeploymentStrategy #
NFData CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Methods rnf :: CreateDeploymentStrategy -> () #
Hashable CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Methods hashWithSalt :: Int -> CreateDeploymentStrategy -> Int # hash :: CreateDeploymentStrategy -> Int #
ToJSON CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Methods toJSON :: CreateDeploymentStrategy -> Value # toEncoding :: CreateDeploymentStrategy -> Encoding # toJSONList :: [CreateDeploymentStrategy] -> Value # toEncodingList :: [CreateDeploymentStrategy] -> Encoding #
AWSRequest CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Associated Types type AWSResponse CreateDeploymentStrategy # Methods request :: CreateDeploymentStrategy -> Request CreateDeploymentStrategy # response :: MonadResource m => Logger -> Service -> Proxy CreateDeploymentStrategy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDeploymentStrategy))) #
ToHeaders CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Methods toHeaders :: CreateDeploymentStrategy -> [Header] #
ToPath CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Methods toPath :: CreateDeploymentStrategy -> ByteString #
ToQuery CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Methods toQuery :: CreateDeploymentStrategy -> QueryString #
type Rep CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy type Rep CreateDeploymentStrategy = D1 ('MetaData "CreateDeploymentStrategy" "Amazonka.AppConfig.CreateDeploymentStrategy" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "CreateDeploymentStrategy'" 'PrefixI 'True) (((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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "deploymentDurationInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)) :: (S1 ('MetaSel ('Just "growthFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "replicateTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ReplicateTo)))))
type AWSResponse CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy type AWSResponse CreateDeploymentStrategy = DeploymentStrategy

newCreateDeploymentStrategy Source #

Arguments

:: Text	`$sel:name:CreateDeploymentStrategy'`
-> Natural	`$sel:deploymentDurationInMinutes:CreateDeploymentStrategy'`
-> Double	`$sel:growthFactor:CreateDeploymentStrategy'`
-> ReplicateTo	`$sel:replicateTo:CreateDeploymentStrategy'`
-> CreateDeploymentStrategy

Create a value of CreateDeploymentStrategy 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:finalBakeTimeInMinutes:CreateDeploymentStrategy', createDeploymentStrategy_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:CreateDeploymentStrategy', createDeploymentStrategy_description - A description of the deployment strategy.

$sel:growthType:CreateDeploymentStrategy', createDeploymentStrategy_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 dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the 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:tags:CreateDeploymentStrategy', createDeploymentStrategy_tags - Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

$sel:name:CreateDeploymentStrategy', createDeploymentStrategy_name - A name for the deployment strategy.

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

$sel:growthFactor:CreateDeploymentStrategy', createDeploymentStrategy_growthFactor - The percentage of targets to receive a deployed configuration during each interval.

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

Request Lenses

createDeploymentStrategy_finalBakeTimeInMinutes :: Lens' CreateDeploymentStrategy (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.

createDeploymentStrategy_description :: Lens' CreateDeploymentStrategy (Maybe Text) Source #

A description of the deployment strategy.

createDeploymentStrategy_growthType :: Lens' CreateDeploymentStrategy (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 dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the 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.

createDeploymentStrategy_tags :: Lens' CreateDeploymentStrategy (Maybe (HashMap Text Text)) Source #

Metadata to assign to the deployment strategy. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

createDeploymentStrategy_name :: Lens' CreateDeploymentStrategy Text Source #

A name for the deployment strategy.

createDeploymentStrategy_deploymentDurationInMinutes :: Lens' CreateDeploymentStrategy Natural Source #

Total amount of time for a deployment to last.

createDeploymentStrategy_growthFactor :: Lens' CreateDeploymentStrategy Double Source #

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

createDeploymentStrategy_replicateTo :: Lens' CreateDeploymentStrategy ReplicateTo Source #

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

Destructuring the Response

data DeploymentStrategy Source #

See: newDeploymentStrategy smart constructor.

Constructors

DeploymentStrategy'

Fields

growthFactor :: Maybe Double
The percentage of targets that received a deployed configuration during each interval.
replicateTo :: Maybe ReplicateTo
Save the deployment strategy to a Systems Manager (SSM) document.
name :: Maybe Text
The name of the deployment strategy.
id :: Maybe Text
The deployment strategy ID.
deploymentDurationInMinutes :: Maybe Natural
Total amount of time the deployment lasted.
finalBakeTimeInMinutes :: Maybe Natural
The amount of time AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.
description :: Maybe Text
The description of the deployment strategy.
growthType :: Maybe GrowthType
The algorithm used to define how percentage grew over time.

Instances

Instances details

Eq DeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.Types.DeploymentStrategy Methods (==) :: DeploymentStrategy -> DeploymentStrategy -> Bool # (/=) :: DeploymentStrategy -> DeploymentStrategy -> Bool #
Read DeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.Types.DeploymentStrategy Methods readsPrec :: Int -> ReadS DeploymentStrategy # readList :: ReadS [DeploymentStrategy] # readPrec :: ReadPrec DeploymentStrategy # readListPrec :: ReadPrec [DeploymentStrategy] #
Show DeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.Types.DeploymentStrategy Methods showsPrec :: Int -> DeploymentStrategy -> ShowS # show :: DeploymentStrategy -> String # showList :: [DeploymentStrategy] -> ShowS #
Generic DeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.Types.DeploymentStrategy Associated Types type Rep DeploymentStrategy :: Type -> Type # Methods from :: DeploymentStrategy -> Rep DeploymentStrategy x # to :: Rep DeploymentStrategy x -> DeploymentStrategy #
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 Methods hashWithSalt :: Int -> DeploymentStrategy -> Int # hash :: DeploymentStrategy -> Int #
FromJSON DeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.Types.DeploymentStrategy Methods parseJSON :: Value -> Parser DeploymentStrategy # parseJSONList :: Value -> Parser [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_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.