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

Description

Starts a deployment.

Synopsis

Creating a Request

data StartDeployment Source #

See: newStartDeployment smart constructor.

Constructors

StartDeployment' 

Fields

Instances

Instances details
Eq StartDeployment Source # 
Instance details

Defined in Amazonka.AppConfig.StartDeployment

Read StartDeployment Source # 
Instance details

Defined in Amazonka.AppConfig.StartDeployment

Show StartDeployment Source # 
Instance details

Defined in Amazonka.AppConfig.StartDeployment

Generic StartDeployment Source # 
Instance details

Defined in Amazonka.AppConfig.StartDeployment

Associated Types

type Rep StartDeployment :: Type -> Type #

NFData StartDeployment Source # 
Instance details

Defined in Amazonka.AppConfig.StartDeployment

Methods

rnf :: StartDeployment -> () #

Hashable StartDeployment Source # 
Instance details

Defined in Amazonka.AppConfig.StartDeployment

ToJSON StartDeployment Source # 
Instance details

Defined in Amazonka.AppConfig.StartDeployment

AWSRequest StartDeployment Source # 
Instance details

Defined in Amazonka.AppConfig.StartDeployment

Associated Types

type AWSResponse StartDeployment #

ToHeaders StartDeployment Source # 
Instance details

Defined in Amazonka.AppConfig.StartDeployment

ToPath StartDeployment Source # 
Instance details

Defined in Amazonka.AppConfig.StartDeployment

ToQuery StartDeployment Source # 
Instance details

Defined in Amazonka.AppConfig.StartDeployment

type Rep StartDeployment Source # 
Instance details

Defined in Amazonka.AppConfig.StartDeployment

type Rep StartDeployment = D1 ('MetaData "StartDeployment" "Amazonka.AppConfig.StartDeployment" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "StartDeployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deploymentStrategyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "configurationProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "configurationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse StartDeployment Source # 
Instance details

Defined in Amazonka.AppConfig.StartDeployment

newStartDeployment Source #

Create a value of StartDeployment 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:description:StartDeployment', startDeployment_description - A description of the deployment.

$sel:tags:StartDeployment', startDeployment_tags - Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

$sel:applicationId:StartDeployment', startDeployment_applicationId - The application ID.

$sel:environmentId:StartDeployment', startDeployment_environmentId - The environment ID.

$sel:deploymentStrategyId:StartDeployment', startDeployment_deploymentStrategyId - The deployment strategy ID.

$sel:configurationProfileId:StartDeployment', startDeployment_configurationProfileId - The configuration profile ID.

$sel:configurationVersion:StartDeployment', startDeployment_configurationVersion - The configuration version to deploy.

Request Lenses

startDeployment_description :: Lens' StartDeployment (Maybe Text) Source #

A description of the deployment.

startDeployment_tags :: Lens' StartDeployment (Maybe (HashMap Text Text)) Source #

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

Destructuring the Response

data Deployment Source #

See: newDeployment smart constructor.

Constructors

Deployment' 

Fields

Instances

Instances details
Eq Deployment Source # 
Instance details

Defined in Amazonka.AppConfig.Types.Deployment

Read Deployment Source # 
Instance details

Defined in Amazonka.AppConfig.Types.Deployment

Show Deployment Source # 
Instance details

Defined in Amazonka.AppConfig.Types.Deployment

Generic Deployment Source # 
Instance details

Defined in Amazonka.AppConfig.Types.Deployment

Associated Types

type Rep Deployment :: Type -> Type #

NFData Deployment Source # 
Instance details

Defined in Amazonka.AppConfig.Types.Deployment

Methods

rnf :: Deployment -> () #

Hashable Deployment Source # 
Instance details

Defined in Amazonka.AppConfig.Types.Deployment

FromJSON Deployment Source # 
Instance details

Defined in Amazonka.AppConfig.Types.Deployment

type Rep Deployment Source # 
Instance details

Defined in Amazonka.AppConfig.Types.Deployment

type Rep Deployment = D1 ('MetaData "Deployment" "Amazonka.AppConfig.Types.Deployment" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "Deployment'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "growthFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "configurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentState)) :*: S1 ('MetaSel ('Just "deploymentStrategyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "deploymentNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "configurationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "eventLog") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DeploymentEvent])) :*: (S1 ('MetaSel ('Just "percentageComplete") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))))) :*: (((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "deploymentDurationInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "completedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :*: ((S1 ('MetaSel ('Just "configurationLocationUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "finalBakeTimeInMinutes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "configurationProfileId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "growthType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GrowthType))))))))

newDeployment :: Deployment Source #

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

$sel:configurationName:Deployment', deployment_configurationName - The name of the configuration.

$sel:state:Deployment', deployment_state - The state of the deployment.

$sel:deploymentStrategyId:Deployment', deployment_deploymentStrategyId - The ID of the deployment strategy that was deployed.

$sel:deploymentNumber:Deployment', deployment_deploymentNumber - The sequence number of the deployment.

$sel:configurationVersion:Deployment', deployment_configurationVersion - The configuration version that was deployed.

$sel:eventLog:Deployment', deployment_eventLog - A list containing all events related to a deployment. The most recent events are displayed first.

$sel:percentageComplete:Deployment', deployment_percentageComplete - The percentage of targets for which the deployment is available.

$sel:startedAt:Deployment', deployment_startedAt - The time the deployment started.

$sel:applicationId:Deployment', deployment_applicationId - The ID of the application that was deployed.

$sel:deploymentDurationInMinutes:Deployment', deployment_deploymentDurationInMinutes - Total amount of time the deployment lasted.

$sel:environmentId:Deployment', deployment_environmentId - The ID of the environment that was deployed.

$sel:completedAt:Deployment', deployment_completedAt - The time the deployment completed.

$sel:configurationLocationUri:Deployment', deployment_configurationLocationUri - Information about the source location of the configuration.

$sel:finalBakeTimeInMinutes:Deployment', deployment_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:Deployment', deployment_description - The description of the deployment.

$sel:configurationProfileId:Deployment', deployment_configurationProfileId - The ID of the configuration profile that was deployed.

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

Response Lenses

deployment_growthFactor :: Lens' Deployment (Maybe Double) Source #

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

deployment_configurationName :: Lens' Deployment (Maybe Text) Source #

The name of the configuration.

deployment_state :: Lens' Deployment (Maybe DeploymentState) Source #

The state of the deployment.

deployment_deploymentStrategyId :: Lens' Deployment (Maybe Text) Source #

The ID of the deployment strategy that was deployed.

deployment_deploymentNumber :: Lens' Deployment (Maybe Int) Source #

The sequence number of the deployment.

deployment_configurationVersion :: Lens' Deployment (Maybe Text) Source #

The configuration version that was deployed.

deployment_eventLog :: Lens' Deployment (Maybe [DeploymentEvent]) Source #

A list containing all events related to a deployment. The most recent events are displayed first.

deployment_percentageComplete :: Lens' Deployment (Maybe Double) Source #

The percentage of targets for which the deployment is available.

deployment_startedAt :: Lens' Deployment (Maybe UTCTime) Source #

The time the deployment started.

deployment_applicationId :: Lens' Deployment (Maybe Text) Source #

The ID of the application that was deployed.

deployment_deploymentDurationInMinutes :: Lens' Deployment (Maybe Natural) Source #

Total amount of time the deployment lasted.

deployment_environmentId :: Lens' Deployment (Maybe Text) Source #

The ID of the environment that was deployed.

deployment_completedAt :: Lens' Deployment (Maybe UTCTime) Source #

The time the deployment completed.

deployment_configurationLocationUri :: Lens' Deployment (Maybe Text) Source #

Information about the source location of the configuration.

deployment_finalBakeTimeInMinutes :: Lens' Deployment (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.

deployment_description :: Lens' Deployment (Maybe Text) Source #

The description of the deployment.

deployment_configurationProfileId :: Lens' Deployment (Maybe Text) Source #

The ID of the configuration profile that was deployed.

deployment_growthType :: Lens' Deployment (Maybe GrowthType) Source #

The algorithm used to define how percentage grew over time.