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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieve information about a deployment strategy. 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 GetDeploymentStrategy = GetDeploymentStrategy' {
- deploymentStrategyId :: Text
}
newGetDeploymentStrategy :: Text -> GetDeploymentStrategy
getDeploymentStrategy_deploymentStrategyId :: Lens' GetDeploymentStrategy Text
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 GetDeploymentStrategy Source #

See: newGetDeploymentStrategy smart constructor.

Constructors

GetDeploymentStrategy'
Fields deploymentStrategyId :: Text The ID of the deployment strategy to get.

Instances

Instances details

Eq GetDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.GetDeploymentStrategy Methods (==) :: GetDeploymentStrategy -> GetDeploymentStrategy -> Bool # (/=) :: GetDeploymentStrategy -> GetDeploymentStrategy -> Bool #
Read GetDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.GetDeploymentStrategy Methods readsPrec :: Int -> ReadS GetDeploymentStrategy # readList :: ReadS [GetDeploymentStrategy] # readPrec :: ReadPrec GetDeploymentStrategy # readListPrec :: ReadPrec [GetDeploymentStrategy] #
Show GetDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.GetDeploymentStrategy Methods showsPrec :: Int -> GetDeploymentStrategy -> ShowS # show :: GetDeploymentStrategy -> String # showList :: [GetDeploymentStrategy] -> ShowS #
Generic GetDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.GetDeploymentStrategy Associated Types type Rep GetDeploymentStrategy :: Type -> Type # Methods from :: GetDeploymentStrategy -> Rep GetDeploymentStrategy x # to :: Rep GetDeploymentStrategy x -> GetDeploymentStrategy #
NFData GetDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.GetDeploymentStrategy Methods rnf :: GetDeploymentStrategy -> () #
Hashable GetDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.GetDeploymentStrategy Methods hashWithSalt :: Int -> GetDeploymentStrategy -> Int # hash :: GetDeploymentStrategy -> Int #
AWSRequest GetDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.GetDeploymentStrategy Associated Types type AWSResponse GetDeploymentStrategy # Methods request :: GetDeploymentStrategy -> Request GetDeploymentStrategy # response :: MonadResource m => Logger -> Service -> Proxy GetDeploymentStrategy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDeploymentStrategy))) #
ToHeaders GetDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.GetDeploymentStrategy Methods toHeaders :: GetDeploymentStrategy -> [Header] #
ToPath GetDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.GetDeploymentStrategy Methods toPath :: GetDeploymentStrategy -> ByteString #
ToQuery GetDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.GetDeploymentStrategy Methods toQuery :: GetDeploymentStrategy -> QueryString #
type Rep GetDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.GetDeploymentStrategy type Rep GetDeploymentStrategy = D1 ('MetaData "GetDeploymentStrategy" "Amazonka.AppConfig.GetDeploymentStrategy" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "GetDeploymentStrategy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deploymentStrategyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetDeploymentStrategy Source #
Instance details Defined in Amazonka.AppConfig.GetDeploymentStrategy type AWSResponse GetDeploymentStrategy = DeploymentStrategy

newGetDeploymentStrategy Source #

Arguments

:: Text	`$sel:deploymentStrategyId:GetDeploymentStrategy'`
-> GetDeploymentStrategy

Create a value of GetDeploymentStrategy 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:deploymentStrategyId:GetDeploymentStrategy', getDeploymentStrategy_deploymentStrategyId - The ID of the deployment strategy to get.

Request Lenses

getDeploymentStrategy_deploymentStrategyId :: Lens' GetDeploymentStrategy Text Source #

The ID of the deployment strategy to get.

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.