Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppConfig.CreateDeploymentStrategy

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a deployment strategy that 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' {
- description :: Maybe Text
- finalBakeTimeInMinutes :: Maybe Natural
- growthType :: Maybe GrowthType
- replicateTo :: Maybe ReplicateTo
- tags :: Maybe (HashMap Text Text)
- name :: Text
- deploymentDurationInMinutes :: Natural
- growthFactor :: Double
}
newCreateDeploymentStrategy :: Text -> Natural -> Double -> CreateDeploymentStrategy
createDeploymentStrategy_description :: Lens' CreateDeploymentStrategy (Maybe Text)
createDeploymentStrategy_finalBakeTimeInMinutes :: Lens' CreateDeploymentStrategy (Maybe Natural)
createDeploymentStrategy_growthType :: Lens' CreateDeploymentStrategy (Maybe GrowthType)
createDeploymentStrategy_replicateTo :: Lens' CreateDeploymentStrategy (Maybe ReplicateTo)
createDeploymentStrategy_tags :: Lens' CreateDeploymentStrategy (Maybe (HashMap Text Text))
createDeploymentStrategy_name :: Lens' CreateDeploymentStrategy Text
createDeploymentStrategy_deploymentDurationInMinutes :: Lens' CreateDeploymentStrategy Natural
createDeploymentStrategy_growthFactor :: Lens' CreateDeploymentStrategy Double
data DeploymentStrategy = DeploymentStrategy' {
- deploymentDurationInMinutes :: Maybe Natural
- description :: Maybe Text
- finalBakeTimeInMinutes :: Maybe Natural
- growthFactor :: Maybe Double
- growthType :: Maybe GrowthType
- id :: Maybe Text
- name :: Maybe Text
- replicateTo :: Maybe ReplicateTo
}
newDeploymentStrategy :: DeploymentStrategy
deploymentStrategy_deploymentDurationInMinutes :: Lens' DeploymentStrategy (Maybe Natural)
deploymentStrategy_description :: Lens' DeploymentStrategy (Maybe Text)
deploymentStrategy_finalBakeTimeInMinutes :: Lens' DeploymentStrategy (Maybe Natural)
deploymentStrategy_growthFactor :: Lens' DeploymentStrategy (Maybe Double)
deploymentStrategy_growthType :: Lens' DeploymentStrategy (Maybe GrowthType)
deploymentStrategy_id :: Lens' DeploymentStrategy (Maybe Text)
deploymentStrategy_name :: Lens' DeploymentStrategy (Maybe Text)
deploymentStrategy_replicateTo :: Lens' DeploymentStrategy (Maybe ReplicateTo)

Creating a Request

data CreateDeploymentStrategy Source #

See: newCreateDeploymentStrategy smart constructor.

Constructors

CreateDeploymentStrategy'

Fields

description :: Maybe Text
A description of the deployment strategy.
finalBakeTimeInMinutes :: Maybe Natural
Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.
growthType :: Maybe GrowthType
The algorithm used to define how percentage grows over time. 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.
replicateTo :: Maybe ReplicateTo
Save the deployment strategy to a Systems Manager (SSM) document.
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.

Instances

Instances details

ToJSON CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Methods toJSON :: CreateDeploymentStrategy -> Value # toEncoding :: CreateDeploymentStrategy -> Encoding # toJSONList :: [CreateDeploymentStrategy] -> Value # toEncodingList :: [CreateDeploymentStrategy] -> Encoding #
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 #
AWSRequest CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Associated Types type AWSResponse CreateDeploymentStrategy # Methods request :: (Service -> Service) -> CreateDeploymentStrategy -> Request CreateDeploymentStrategy # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDeploymentStrategy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDeploymentStrategy))) #
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 #
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 #
NFData CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Methods rnf :: CreateDeploymentStrategy -> () #
Eq CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Methods (==) :: CreateDeploymentStrategy -> CreateDeploymentStrategy -> Bool # (/=) :: CreateDeploymentStrategy -> CreateDeploymentStrategy -> Bool #
Hashable CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy Methods hashWithSalt :: Int -> CreateDeploymentStrategy -> Int # hash :: CreateDeploymentStrategy -> Int #
type AWSResponse CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy type AWSResponse CreateDeploymentStrategy = DeploymentStrategy
type Rep CreateDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.CreateDeploymentStrategy type Rep CreateDeploymentStrategy = D1 ('MetaData "CreateDeploymentStrategy" "Amazonka.AppConfig.CreateDeploymentStrategy" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "CreateDeploymentStrategy'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "finalBakeTimeInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :: (S1 ('MetaSel ('Just "growthType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GrowthType)) :: S1 ('MetaSel ('Just "replicateTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicateTo)))) :: ((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)))))

newCreateDeploymentStrategy Source #

Arguments

:: Text	`CreateDeploymentStrategy`
-> Natural	`CreateDeploymentStrategy`
-> Double	`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:

CreateDeploymentStrategy, createDeploymentStrategy_description - A description of the deployment strategy.

CreateDeploymentStrategy, createDeploymentStrategy_finalBakeTimeInMinutes - Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

CreateDeploymentStrategy, createDeploymentStrategy_growthType - The algorithm used to define how percentage grows over time. 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, createDeploymentStrategy_replicateTo - Save the deployment strategy to a Systems Manager (SSM) document.

$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.

CreateDeploymentStrategy, createDeploymentStrategy_name - A name for the deployment strategy.

CreateDeploymentStrategy, createDeploymentStrategy_deploymentDurationInMinutes - Total amount of time for a deployment to last.

CreateDeploymentStrategy, createDeploymentStrategy_growthFactor - The percentage of targets to receive a deployed configuration during each interval.

Request Lenses

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

A description of the deployment strategy.

createDeploymentStrategy_finalBakeTimeInMinutes :: Lens' CreateDeploymentStrategy (Maybe Natural) Source #

Specifies the amount of time AppConfig monitors for Amazon CloudWatch alarms after the configuration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AppConfig rolls back the deployment. You must configure permissions for AppConfig to roll back based on CloudWatch alarms. For more information, see Configuring permissions for rollback based on Amazon CloudWatch alarms in the AppConfig User Guide.

createDeploymentStrategy_growthType :: Lens' CreateDeploymentStrategy (Maybe GrowthType) Source #

The algorithm used to define how percentage grows over time. 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_replicateTo :: Lens' CreateDeploymentStrategy (Maybe ReplicateTo) Source #

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

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.

Destructuring the Response

data DeploymentStrategy Source #

See: newDeploymentStrategy smart constructor.

Constructors

DeploymentStrategy'

Fields

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

Instances

Instances details

FromJSON DeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.Types.DeploymentStrategy Methods parseJSON :: Value -> Parser DeploymentStrategy # parseJSONList :: Value -> Parser [DeploymentStrategy] #
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 #
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 #
NFData DeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.Types.DeploymentStrategy Methods rnf :: DeploymentStrategy -> () #
Eq DeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.Types.DeploymentStrategy Methods (==) :: DeploymentStrategy -> DeploymentStrategy -> Bool # (/=) :: DeploymentStrategy -> DeploymentStrategy -> Bool #
Hashable DeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.Types.DeploymentStrategy Methods hashWithSalt :: Int -> DeploymentStrategy -> Int # hash :: DeploymentStrategy -> Int #
type Rep DeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.Types.DeploymentStrategy type Rep DeploymentStrategy = D1 ('MetaData "DeploymentStrategy" "Amazonka.AppConfig.Types.DeploymentStrategy" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "DeploymentStrategy'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "deploymentDurationInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "finalBakeTimeInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "growthFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)))) :: ((S1 ('MetaSel ('Just "growthType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GrowthType)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "replicateTo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ReplicateTo))))))

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:deploymentDurationInMinutes:DeploymentStrategy', deploymentStrategy_deploymentDurationInMinutes - Total amount of time the deployment lasted.

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

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

$sel:growthFactor:DeploymentStrategy', deploymentStrategy_growthFactor - The percentage of targets that received a deployed configuration during each interval.

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

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

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

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

Response Lenses

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

Total amount of time the deployment lasted.

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

The description of the deployment strategy.

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

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

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

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

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

The algorithm used to define how percentage grew over time.

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

The deployment strategy ID.

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

The name of the deployment strategy.

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

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