| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- ListEnvironments
- UpdateEnvironment
- DeleteEnvironment
- GetDeploymentStrategy
- CreateConfigurationProfile
- GetDeployment
- UpdateConfigurationProfile
- DeleteConfigurationProfile
- ListTagsForResource
- ListHostedConfigurationVersions
- GetConfigurationProfile
- DeleteApplication
- UpdateApplication
- UpdateDeploymentStrategy
- DeleteDeploymentStrategy
- CreateApplication
- ValidateConfiguration
- StopDeployment
- GetApplication
- CreateHostedConfigurationVersion
- ListConfigurationProfiles
- DeleteHostedConfigurationVersion
- GetHostedConfigurationVersion
- ListDeployments
- TagResource
- GetEnvironment
- ListApplications
- UntagResource
- ListDeploymentStrategies
- GetConfiguration
- CreateDeploymentStrategy
- StartDeployment
- CreateEnvironment
- Types
Description
Derived from API version 2019-10-09 of the AWS service descriptions, licensed under Apache 2.0.
AWS AppConfig
Use AWS AppConfig, a capability of AWS Systems Manager, to create, manage, and quickly deploy application configurations. AppConfig supports controlled deployments to applications of any size and includes built-in validation checks and monitoring. You can use AppConfig with applications hosted on Amazon EC2 instances, AWS Lambda, containers, mobile applications, or IoT devices.
To prevent errors when deploying application configurations, especially for production systems where a simple typo could cause an unexpected outage, AppConfig includes validators. A validator provides a syntactic or semantic check to ensure that the configuration you want to deploy works as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.
During a configuration deployment, AppConfig monitors the application to ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can configure a deployment strategy for each application or environment that includes deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back to the previous version.
AppConfig supports multiple use cases. Here are some examples.
- Application tuning: Use AppConfig to carefully introduce changes to your application that can only be tested with production traffic.
- Feature toggle: Use AppConfig to turn on new features that require a timely deployment, such as a product launch or announcement.
- Allow list: Use AppConfig to allow premium subscribers to access paid content.
- Operational issues: Use AppConfig to reduce stress on your application when a dependency or other external factor impacts the system.
This reference is intended to be used with the AWS AppConfig User Guide.
Synopsis
- defaultService :: Service
- _PayloadTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- data ListEnvironments = ListEnvironments' (Maybe Text) (Maybe Natural) Text
- newListEnvironments :: Text -> ListEnvironments
- data ListEnvironmentsResponse = ListEnvironmentsResponse' (Maybe [Environment]) (Maybe Text) Int
- newListEnvironmentsResponse :: Int -> ListEnvironmentsResponse
- data UpdateEnvironment = UpdateEnvironment' (Maybe [Monitor]) (Maybe Text) (Maybe Text) Text Text
- newUpdateEnvironment :: Text -> Text -> UpdateEnvironment
- data Environment = Environment' (Maybe EnvironmentState) (Maybe [Monitor]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newEnvironment :: Environment
- data DeleteEnvironment = DeleteEnvironment' Text Text
- newDeleteEnvironment :: Text -> Text -> DeleteEnvironment
- data DeleteEnvironmentResponse = DeleteEnvironmentResponse' {
- newDeleteEnvironmentResponse :: DeleteEnvironmentResponse
- data GetDeploymentStrategy = GetDeploymentStrategy' Text
- newGetDeploymentStrategy :: Text -> GetDeploymentStrategy
- data DeploymentStrategy = DeploymentStrategy' (Maybe Double) (Maybe ReplicateTo) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe GrowthType)
- newDeploymentStrategy :: DeploymentStrategy
- data CreateConfigurationProfile = CreateConfigurationProfile' (Maybe Text) (Maybe [Validator]) (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text
- newCreateConfigurationProfile :: Text -> Text -> Text -> CreateConfigurationProfile
- data ConfigurationProfile = ConfigurationProfile' (Maybe Text) (Maybe [Validator]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newConfigurationProfile :: ConfigurationProfile
- data GetDeployment = GetDeployment' Text Text Int
- newGetDeployment :: Text -> Text -> Int -> GetDeployment
- data Deployment = Deployment' (Maybe Double) (Maybe Text) (Maybe DeploymentState) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Double) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe GrowthType)
- newDeployment :: Deployment
- data UpdateConfigurationProfile = UpdateConfigurationProfile' (Maybe Text) (Maybe [Validator]) (Maybe Text) (Maybe Text) Text Text
- newUpdateConfigurationProfile :: Text -> Text -> UpdateConfigurationProfile
- data ConfigurationProfile = ConfigurationProfile' (Maybe Text) (Maybe [Validator]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newConfigurationProfile :: ConfigurationProfile
- data DeleteConfigurationProfile = DeleteConfigurationProfile' Text Text
- newDeleteConfigurationProfile :: Text -> Text -> DeleteConfigurationProfile
- data DeleteConfigurationProfileResponse = DeleteConfigurationProfileResponse' {
- newDeleteConfigurationProfileResponse :: DeleteConfigurationProfileResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListHostedConfigurationVersions = ListHostedConfigurationVersions' (Maybe Text) (Maybe Natural) Text Text
- newListHostedConfigurationVersions :: Text -> Text -> ListHostedConfigurationVersions
- data ListHostedConfigurationVersionsResponse = ListHostedConfigurationVersionsResponse' (Maybe [HostedConfigurationVersionSummary]) (Maybe Text) Int
- newListHostedConfigurationVersionsResponse :: Int -> ListHostedConfigurationVersionsResponse
- data GetConfigurationProfile = GetConfigurationProfile' Text Text
- newGetConfigurationProfile :: Text -> Text -> GetConfigurationProfile
- data ConfigurationProfile = ConfigurationProfile' (Maybe Text) (Maybe [Validator]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newConfigurationProfile :: ConfigurationProfile
- data DeleteApplication = DeleteApplication' Text
- newDeleteApplication :: Text -> DeleteApplication
- data DeleteApplicationResponse = DeleteApplicationResponse' {
- newDeleteApplicationResponse :: DeleteApplicationResponse
- data UpdateApplication = UpdateApplication' (Maybe Text) (Maybe Text) Text
- newUpdateApplication :: Text -> UpdateApplication
- data Application = Application' (Maybe Text) (Maybe Text) (Maybe Text)
- newApplication :: Application
- data UpdateDeploymentStrategy = UpdateDeploymentStrategy' (Maybe Double) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe GrowthType) Text
- newUpdateDeploymentStrategy :: Text -> UpdateDeploymentStrategy
- data DeploymentStrategy = DeploymentStrategy' (Maybe Double) (Maybe ReplicateTo) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe GrowthType)
- newDeploymentStrategy :: DeploymentStrategy
- data DeleteDeploymentStrategy = DeleteDeploymentStrategy' Text
- newDeleteDeploymentStrategy :: Text -> DeleteDeploymentStrategy
- data DeleteDeploymentStrategyResponse = DeleteDeploymentStrategyResponse' {
- newDeleteDeploymentStrategyResponse :: DeleteDeploymentStrategyResponse
- data CreateApplication = CreateApplication' (Maybe Text) (Maybe (HashMap Text Text)) Text
- newCreateApplication :: Text -> CreateApplication
- data Application = Application' (Maybe Text) (Maybe Text) (Maybe Text)
- newApplication :: Application
- data ValidateConfiguration = ValidateConfiguration' Text Text Text
- newValidateConfiguration :: Text -> Text -> Text -> ValidateConfiguration
- data ValidateConfigurationResponse = ValidateConfigurationResponse' {
- newValidateConfigurationResponse :: ValidateConfigurationResponse
- data StopDeployment = StopDeployment' Text Text Int
- newStopDeployment :: Text -> Text -> Int -> StopDeployment
- data Deployment = Deployment' (Maybe Double) (Maybe Text) (Maybe DeploymentState) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Double) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe GrowthType)
- newDeployment :: Deployment
- data GetApplication = GetApplication' Text
- newGetApplication :: Text -> GetApplication
- data Application = Application' (Maybe Text) (Maybe Text) (Maybe Text)
- newApplication :: Application
- data CreateHostedConfigurationVersion = CreateHostedConfigurationVersion' (Maybe Int) (Maybe Text) Text Text (Sensitive ByteString) Text
- newCreateHostedConfigurationVersion :: Text -> Text -> ByteString -> Text -> CreateHostedConfigurationVersion
- data HostedConfigurationVersion = HostedConfigurationVersion' (Maybe (Sensitive ByteString)) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newHostedConfigurationVersion :: HostedConfigurationVersion
- data ListConfigurationProfiles = ListConfigurationProfiles' (Maybe Text) (Maybe Natural) Text
- newListConfigurationProfiles :: Text -> ListConfigurationProfiles
- data ListConfigurationProfilesResponse = ListConfigurationProfilesResponse' (Maybe [ConfigurationProfileSummary]) (Maybe Text) Int
- newListConfigurationProfilesResponse :: Int -> ListConfigurationProfilesResponse
- data DeleteHostedConfigurationVersion = DeleteHostedConfigurationVersion' Text Text Int
- newDeleteHostedConfigurationVersion :: Text -> Text -> Int -> DeleteHostedConfigurationVersion
- data DeleteHostedConfigurationVersionResponse = DeleteHostedConfigurationVersionResponse' {
- newDeleteHostedConfigurationVersionResponse :: DeleteHostedConfigurationVersionResponse
- data GetHostedConfigurationVersion = GetHostedConfigurationVersion' Text Text Int
- newGetHostedConfigurationVersion :: Text -> Text -> Int -> GetHostedConfigurationVersion
- data HostedConfigurationVersion = HostedConfigurationVersion' (Maybe (Sensitive ByteString)) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newHostedConfigurationVersion :: HostedConfigurationVersion
- data ListDeployments = ListDeployments' (Maybe Text) (Maybe Natural) Text Text
- newListDeployments :: Text -> Text -> ListDeployments
- data ListDeploymentsResponse = ListDeploymentsResponse' (Maybe [DeploymentSummary]) (Maybe Text) Int
- newListDeploymentsResponse :: Int -> ListDeploymentsResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data GetEnvironment = GetEnvironment' Text Text
- newGetEnvironment :: Text -> Text -> GetEnvironment
- data Environment = Environment' (Maybe EnvironmentState) (Maybe [Monitor]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newEnvironment :: Environment
- data ListApplications = ListApplications' (Maybe Text) (Maybe Natural)
- newListApplications :: ListApplications
- data ListApplicationsResponse = ListApplicationsResponse' (Maybe [Application]) (Maybe Text) Int
- newListApplicationsResponse :: Int -> ListApplicationsResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data ListDeploymentStrategies = ListDeploymentStrategies' (Maybe Text) (Maybe Natural)
- newListDeploymentStrategies :: ListDeploymentStrategies
- data ListDeploymentStrategiesResponse = ListDeploymentStrategiesResponse' (Maybe [DeploymentStrategy]) (Maybe Text) Int
- newListDeploymentStrategiesResponse :: Int -> ListDeploymentStrategiesResponse
- data GetConfiguration = GetConfiguration' (Maybe Text) Text Text Text Text
- newGetConfiguration :: Text -> Text -> Text -> Text -> GetConfiguration
- data GetConfigurationResponse = GetConfigurationResponse' (Maybe Text) (Maybe (Sensitive ByteString)) (Maybe Text) Int
- newGetConfigurationResponse :: Int -> GetConfigurationResponse
- data CreateDeploymentStrategy = CreateDeploymentStrategy' (Maybe Natural) (Maybe Text) (Maybe GrowthType) (Maybe (HashMap Text Text)) Text Natural Double ReplicateTo
- newCreateDeploymentStrategy :: Text -> Natural -> Double -> ReplicateTo -> CreateDeploymentStrategy
- data DeploymentStrategy = DeploymentStrategy' (Maybe Double) (Maybe ReplicateTo) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe GrowthType)
- newDeploymentStrategy :: DeploymentStrategy
- data StartDeployment = StartDeployment' (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text Text Text
- newStartDeployment :: Text -> Text -> Text -> Text -> Text -> StartDeployment
- data Deployment = Deployment' (Maybe Double) (Maybe Text) (Maybe DeploymentState) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Double) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe GrowthType)
- newDeployment :: Deployment
- data CreateEnvironment = CreateEnvironment' (Maybe [Monitor]) (Maybe Text) (Maybe (HashMap Text Text)) Text Text
- newCreateEnvironment :: Text -> Text -> CreateEnvironment
- data Environment = Environment' (Maybe EnvironmentState) (Maybe [Monitor]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newEnvironment :: Environment
- newtype DeploymentEventType where
- DeploymentEventType' { }
- pattern DeploymentEventType_BAKE_TIME_STARTED :: DeploymentEventType
- pattern DeploymentEventType_DEPLOYMENT_COMPLETED :: DeploymentEventType
- pattern DeploymentEventType_DEPLOYMENT_STARTED :: DeploymentEventType
- pattern DeploymentEventType_PERCENTAGE_UPDATED :: DeploymentEventType
- pattern DeploymentEventType_ROLLBACK_COMPLETED :: DeploymentEventType
- pattern DeploymentEventType_ROLLBACK_STARTED :: DeploymentEventType
- newtype DeploymentState where
- DeploymentState' { }
- pattern DeploymentState_BAKING :: DeploymentState
- pattern DeploymentState_COMPLETE :: DeploymentState
- pattern DeploymentState_DEPLOYING :: DeploymentState
- pattern DeploymentState_ROLLED_BACK :: DeploymentState
- pattern DeploymentState_ROLLING_BACK :: DeploymentState
- pattern DeploymentState_VALIDATING :: DeploymentState
- newtype EnvironmentState where
- EnvironmentState' { }
- pattern EnvironmentState_DEPLOYING :: EnvironmentState
- pattern EnvironmentState_READY_FOR_DEPLOYMENT :: EnvironmentState
- pattern EnvironmentState_ROLLED_BACK :: EnvironmentState
- pattern EnvironmentState_ROLLING_BACK :: EnvironmentState
- newtype GrowthType where
- GrowthType' { }
- pattern GrowthType_EXPONENTIAL :: GrowthType
- pattern GrowthType_LINEAR :: GrowthType
- newtype ReplicateTo where
- ReplicateTo' { }
- pattern ReplicateTo_NONE :: ReplicateTo
- pattern ReplicateTo_SSM_DOCUMENT :: ReplicateTo
- newtype TriggeredBy where
- TriggeredBy' { }
- pattern TriggeredBy_APPCONFIG :: TriggeredBy
- pattern TriggeredBy_CLOUDWATCH_ALARM :: TriggeredBy
- pattern TriggeredBy_INTERNAL_ERROR :: TriggeredBy
- pattern TriggeredBy_USER :: TriggeredBy
- newtype ValidatorType where
- ValidatorType' { }
- pattern ValidatorType_JSON_SCHEMA :: ValidatorType
- pattern ValidatorType_LAMBDA :: ValidatorType
- data Application = Application' (Maybe Text) (Maybe Text) (Maybe Text)
- newApplication :: Application
- data ConfigurationProfile = ConfigurationProfile' (Maybe Text) (Maybe [Validator]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newConfigurationProfile :: ConfigurationProfile
- data ConfigurationProfileSummary = ConfigurationProfileSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ValidatorType])
- newConfigurationProfileSummary :: ConfigurationProfileSummary
- data Deployment = Deployment' (Maybe Double) (Maybe Text) (Maybe DeploymentState) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Double) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe GrowthType)
- newDeployment :: Deployment
- data DeploymentEvent = DeploymentEvent' (Maybe TriggeredBy) (Maybe POSIX) (Maybe DeploymentEventType) (Maybe Text)
- newDeploymentEvent :: DeploymentEvent
- data DeploymentStrategy = DeploymentStrategy' (Maybe Double) (Maybe ReplicateTo) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe GrowthType)
- newDeploymentStrategy :: DeploymentStrategy
- data DeploymentSummary = DeploymentSummary' (Maybe Double) (Maybe Text) (Maybe DeploymentState) (Maybe Int) (Maybe Text) (Maybe Double) (Maybe POSIX) (Maybe Natural) (Maybe POSIX) (Maybe Natural) (Maybe GrowthType)
- newDeploymentSummary :: DeploymentSummary
- data Environment = Environment' (Maybe EnvironmentState) (Maybe [Monitor]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newEnvironment :: Environment
- data HostedConfigurationVersion = HostedConfigurationVersion' (Maybe (Sensitive ByteString)) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newHostedConfigurationVersion :: HostedConfigurationVersion
- data HostedConfigurationVersionSummary = HostedConfigurationVersionSummary' (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newHostedConfigurationVersionSummary :: HostedConfigurationVersionSummary
- data Monitor = Monitor' (Maybe Text) (Maybe Text)
- newMonitor :: Monitor
- data Validator = Validator' ValidatorType (Sensitive Text)
- newValidator :: ValidatorType -> Text -> Validator
Service Configuration
defaultService :: Service Source #
API version 2019-10-09 of the Amazon AppConfig SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by AppConfig.
PayloadTooLargeException
_PayloadTooLargeException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The configuration size is too large.
ConflictException
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request could not be processed because of conflict in the current state of the resource.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The number of hosted configuration versions exceeds the limit for the AppConfig configuration store. Delete one or more versions and try again.
InternalServerException
_InternalServerException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There was an internal failure in the AppConfig service.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested resource could not be found.
BadRequestException
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input fails to satisfy the constraints specified by an AWS service.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListEnvironments
data ListEnvironments Source #
See: newListEnvironments smart constructor.
Instances
Arguments
| :: Text | |
| -> ListEnvironments |
Create a value of ListEnvironments 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:nextToken:ListEnvironments', listEnvironments_nextToken - A token to start the list. Use this token to get the next set of
results.
$sel:maxResults:ListEnvironments', listEnvironments_maxResults - The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the
next set of results.
$sel:applicationId:ListEnvironments', listEnvironments_applicationId - The application ID.
data ListEnvironmentsResponse Source #
See: newListEnvironmentsResponse smart constructor.
Constructors
| ListEnvironmentsResponse' (Maybe [Environment]) (Maybe Text) Int |
Instances
newListEnvironmentsResponse Source #
Create a value of ListEnvironmentsResponse 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:items:ListEnvironmentsResponse', listEnvironmentsResponse_items - The elements from this collection.
$sel:nextToken:ListEnvironments', listEnvironmentsResponse_nextToken - The token for the next set of items to return. Use this token to get the
next set of results.
$sel:httpStatus:ListEnvironmentsResponse', listEnvironmentsResponse_httpStatus - The response's http status code.
UpdateEnvironment
data UpdateEnvironment Source #
See: newUpdateEnvironment smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateEnvironment |
Create a value of UpdateEnvironment 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:monitors:UpdateEnvironment', updateEnvironment_monitors - Amazon CloudWatch alarms to monitor during the deployment process.
$sel:name:UpdateEnvironment', updateEnvironment_name - The name of the environment.
$sel:description:UpdateEnvironment', updateEnvironment_description - A description of the environment.
$sel:applicationId:UpdateEnvironment', updateEnvironment_applicationId - The application ID.
$sel:environmentId:UpdateEnvironment', updateEnvironment_environmentId - The environment ID.
data Environment Source #
See: newEnvironment smart constructor.
Constructors
| Environment' (Maybe EnvironmentState) (Maybe [Monitor]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newEnvironment :: Environment Source #
Create a value of Environment 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:state:Environment', environment_state - The state of the environment. An environment can be in one of the
following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK,
or ROLLED_BACK
$sel:monitors:Environment', environment_monitors - Amazon CloudWatch alarms monitored during the deployment.
$sel:applicationId:Environment', environment_applicationId - The application ID.
$sel:name:Environment', environment_name - The name of the environment.
$sel:id:Environment', environment_id - The environment ID.
$sel:description:Environment', environment_description - The description of the environment.
DeleteEnvironment
data DeleteEnvironment Source #
See: newDeleteEnvironment smart constructor.
Constructors
| DeleteEnvironment' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeleteEnvironment |
Create a value of DeleteEnvironment 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:applicationId:DeleteEnvironment', deleteEnvironment_applicationId - The application ID that includes the environment you want to delete.
$sel:environmentId:DeleteEnvironment', deleteEnvironment_environmentId - The ID of the environment you want to delete.
data DeleteEnvironmentResponse Source #
See: newDeleteEnvironmentResponse smart constructor.
Constructors
| DeleteEnvironmentResponse' | |
Instances
newDeleteEnvironmentResponse :: DeleteEnvironmentResponse Source #
Create a value of DeleteEnvironmentResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetDeploymentStrategy
data GetDeploymentStrategy Source #
See: newGetDeploymentStrategy smart constructor.
Constructors
| GetDeploymentStrategy' Text |
Instances
newGetDeploymentStrategy Source #
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.
data DeploymentStrategy Source #
See: newDeploymentStrategy smart constructor.
Constructors
| DeploymentStrategy' (Maybe Double) (Maybe ReplicateTo) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe GrowthType) |
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.
CreateConfigurationProfile
data CreateConfigurationProfile Source #
See: newCreateConfigurationProfile smart constructor.
Constructors
| CreateConfigurationProfile' (Maybe Text) (Maybe [Validator]) (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text |
Instances
newCreateConfigurationProfile Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> CreateConfigurationProfile |
Create a value of CreateConfigurationProfile 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:retrievalRoleArn:CreateConfigurationProfile', createConfigurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
$sel:validators:CreateConfigurationProfile', createConfigurationProfile_validators - A list of methods for validating the configuration.
$sel:description:CreateConfigurationProfile', createConfigurationProfile_description - A description of the configuration profile.
$sel:tags:CreateConfigurationProfile', createConfigurationProfile_tags - Metadata to assign to the configuration profile. 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:CreateConfigurationProfile', createConfigurationProfile_applicationId - The application ID.
$sel:name:CreateConfigurationProfile', createConfigurationProfile_name - A name for the configuration profile.
$sel:locationUri:CreateConfigurationProfile', createConfigurationProfile_locationUri - A URI to locate the configuration. You can specify a Systems Manager
(SSM) document, an SSM Parameter Store parameter, or an Amazon S3
object. For an SSM document, specify either the document name in the
format ssm-document://<Document_name> or the Amazon Resource Name
(ARN). For a parameter, specify either the parameter name in the format
ssm-parameter://<Parameter_name> or the ARN. For an Amazon S3
object, specify the URI in the following format:
s3://<bucket>/<objectKey> . Here is an example:
s3://my-bucket/my-app/us-east-1/my-config.json
data ConfigurationProfile Source #
See: newConfigurationProfile smart constructor.
Constructors
| ConfigurationProfile' (Maybe Text) (Maybe [Validator]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newConfigurationProfile :: ConfigurationProfile Source #
Create a value of ConfigurationProfile 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:retrievalRoleArn:ConfigurationProfile', configurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
$sel:validators:ConfigurationProfile', configurationProfile_validators - A list of methods for validating the configuration.
$sel:locationUri:ConfigurationProfile', configurationProfile_locationUri - The URI location of the configuration.
$sel:applicationId:ConfigurationProfile', configurationProfile_applicationId - The application ID.
$sel:name:ConfigurationProfile', configurationProfile_name - The name of the configuration profile.
$sel:id:ConfigurationProfile', configurationProfile_id - The configuration profile ID.
$sel:description:ConfigurationProfile', configurationProfile_description - The configuration profile description.
GetDeployment
data GetDeployment Source #
See: newGetDeployment smart constructor.
Constructors
| GetDeployment' Text Text Int |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Int | |
| -> GetDeployment |
Create a value of GetDeployment 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:applicationId:GetDeployment', getDeployment_applicationId - The ID of the application that includes the deployment you want to get.
$sel:environmentId:GetDeployment', getDeployment_environmentId - The ID of the environment that includes the deployment you want to get.
$sel:deploymentNumber:GetDeployment', getDeployment_deploymentNumber - The sequence number of the deployment.
data Deployment Source #
See: newDeployment smart constructor.
Constructors
| Deployment' (Maybe Double) (Maybe Text) (Maybe DeploymentState) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Double) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe GrowthType) |
Instances
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.
UpdateConfigurationProfile
data UpdateConfigurationProfile Source #
See: newUpdateConfigurationProfile smart constructor.
Constructors
| UpdateConfigurationProfile' (Maybe Text) (Maybe [Validator]) (Maybe Text) (Maybe Text) Text Text |
Instances
newUpdateConfigurationProfile Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateConfigurationProfile |
Create a value of UpdateConfigurationProfile 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:retrievalRoleArn:UpdateConfigurationProfile', updateConfigurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
$sel:validators:UpdateConfigurationProfile', updateConfigurationProfile_validators - A list of methods for validating the configuration.
$sel:name:UpdateConfigurationProfile', updateConfigurationProfile_name - The name of the configuration profile.
$sel:description:UpdateConfigurationProfile', updateConfigurationProfile_description - A description of the configuration profile.
$sel:applicationId:UpdateConfigurationProfile', updateConfigurationProfile_applicationId - The application ID.
$sel:configurationProfileId:UpdateConfigurationProfile', updateConfigurationProfile_configurationProfileId - The ID of the configuration profile.
data ConfigurationProfile Source #
See: newConfigurationProfile smart constructor.
Constructors
| ConfigurationProfile' (Maybe Text) (Maybe [Validator]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newConfigurationProfile :: ConfigurationProfile Source #
Create a value of ConfigurationProfile 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:retrievalRoleArn:ConfigurationProfile', configurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
$sel:validators:ConfigurationProfile', configurationProfile_validators - A list of methods for validating the configuration.
$sel:locationUri:ConfigurationProfile', configurationProfile_locationUri - The URI location of the configuration.
$sel:applicationId:ConfigurationProfile', configurationProfile_applicationId - The application ID.
$sel:name:ConfigurationProfile', configurationProfile_name - The name of the configuration profile.
$sel:id:ConfigurationProfile', configurationProfile_id - The configuration profile ID.
$sel:description:ConfigurationProfile', configurationProfile_description - The configuration profile description.
DeleteConfigurationProfile
data DeleteConfigurationProfile Source #
See: newDeleteConfigurationProfile smart constructor.
Constructors
| DeleteConfigurationProfile' Text Text |
Instances
newDeleteConfigurationProfile Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeleteConfigurationProfile |
Create a value of DeleteConfigurationProfile 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:applicationId:DeleteConfigurationProfile', deleteConfigurationProfile_applicationId - The application ID that includes the configuration profile you want to
delete.
$sel:configurationProfileId:DeleteConfigurationProfile', deleteConfigurationProfile_configurationProfileId - The ID of the configuration profile you want to delete.
data DeleteConfigurationProfileResponse Source #
See: newDeleteConfigurationProfileResponse smart constructor.
Constructors
| DeleteConfigurationProfileResponse' | |
Instances
newDeleteConfigurationProfileResponse :: DeleteConfigurationProfileResponse Source #
Create a value of DeleteConfigurationProfileResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceArn:ListTagsForResource', listTagsForResource_resourceArn - The resource ARN.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - Metadata to assign to AppConfig resources. Tags help organize and
categorize your AppConfig resources. Each tag consists of a key and an
optional value, both of which you define.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
ListHostedConfigurationVersions
data ListHostedConfigurationVersions Source #
See: newListHostedConfigurationVersions smart constructor.
Instances
newListHostedConfigurationVersions Source #
Arguments
| :: Text | |
| -> Text |
|
| -> ListHostedConfigurationVersions |
Create a value of ListHostedConfigurationVersions 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:nextToken:ListHostedConfigurationVersions', listHostedConfigurationVersions_nextToken - A token to start the list. Use this token to get the next set of
results.
$sel:maxResults:ListHostedConfigurationVersions', listHostedConfigurationVersions_maxResults - The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the
next set of results.
$sel:applicationId:ListHostedConfigurationVersions', listHostedConfigurationVersions_applicationId - The application ID.
$sel:configurationProfileId:ListHostedConfigurationVersions', listHostedConfigurationVersions_configurationProfileId - The configuration profile ID.
data ListHostedConfigurationVersionsResponse Source #
See: newListHostedConfigurationVersionsResponse smart constructor.
Constructors
| ListHostedConfigurationVersionsResponse' (Maybe [HostedConfigurationVersionSummary]) (Maybe Text) Int |
Instances
newListHostedConfigurationVersionsResponse Source #
Arguments
| :: Int | |
| -> ListHostedConfigurationVersionsResponse |
Create a value of ListHostedConfigurationVersionsResponse 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:items:ListHostedConfigurationVersionsResponse', listHostedConfigurationVersionsResponse_items - The elements from this collection.
$sel:nextToken:ListHostedConfigurationVersions', listHostedConfigurationVersionsResponse_nextToken - The token for the next set of items to return. Use this token to get the
next set of results.
$sel:httpStatus:ListHostedConfigurationVersionsResponse', listHostedConfigurationVersionsResponse_httpStatus - The response's http status code.
GetConfigurationProfile
data GetConfigurationProfile Source #
See: newGetConfigurationProfile smart constructor.
Constructors
| GetConfigurationProfile' Text Text |
Instances
newGetConfigurationProfile Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetConfigurationProfile |
Create a value of GetConfigurationProfile 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:applicationId:GetConfigurationProfile', getConfigurationProfile_applicationId - The ID of the application that includes the configuration profile you
want to get.
$sel:configurationProfileId:GetConfigurationProfile', getConfigurationProfile_configurationProfileId - The ID of the configuration profile you want to get.
data ConfigurationProfile Source #
See: newConfigurationProfile smart constructor.
Constructors
| ConfigurationProfile' (Maybe Text) (Maybe [Validator]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newConfigurationProfile :: ConfigurationProfile Source #
Create a value of ConfigurationProfile 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:retrievalRoleArn:ConfigurationProfile', configurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
$sel:validators:ConfigurationProfile', configurationProfile_validators - A list of methods for validating the configuration.
$sel:locationUri:ConfigurationProfile', configurationProfile_locationUri - The URI location of the configuration.
$sel:applicationId:ConfigurationProfile', configurationProfile_applicationId - The application ID.
$sel:name:ConfigurationProfile', configurationProfile_name - The name of the configuration profile.
$sel:id:ConfigurationProfile', configurationProfile_id - The configuration profile ID.
$sel:description:ConfigurationProfile', configurationProfile_description - The configuration profile description.
DeleteApplication
data DeleteApplication Source #
See: newDeleteApplication smart constructor.
Constructors
| DeleteApplication' Text |
Instances
Arguments
| :: Text | |
| -> DeleteApplication |
Create a value of DeleteApplication 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:applicationId:DeleteApplication', deleteApplication_applicationId - The ID of the application to delete.
data DeleteApplicationResponse Source #
See: newDeleteApplicationResponse smart constructor.
Constructors
| DeleteApplicationResponse' | |
Instances
newDeleteApplicationResponse :: DeleteApplicationResponse Source #
Create a value of DeleteApplicationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateApplication
data UpdateApplication Source #
See: newUpdateApplication smart constructor.
Instances
Arguments
| :: Text | |
| -> UpdateApplication |
Create a value of UpdateApplication 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:name:UpdateApplication', updateApplication_name - The name of the application.
$sel:description:UpdateApplication', updateApplication_description - A description of the application.
$sel:applicationId:UpdateApplication', updateApplication_applicationId - The application ID.
data Application Source #
See: newApplication smart constructor.
Instances
newApplication :: Application Source #
Create a value of Application 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:name:Application', application_name - The application name.
$sel:id:Application', application_id - The application ID.
$sel:description:Application', application_description - The description of the application.
UpdateDeploymentStrategy
data UpdateDeploymentStrategy Source #
See: newUpdateDeploymentStrategy smart constructor.
Constructors
| UpdateDeploymentStrategy' (Maybe Double) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe GrowthType) Text |
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.
data DeploymentStrategy Source #
See: newDeploymentStrategy smart constructor.
Constructors
| DeploymentStrategy' (Maybe Double) (Maybe ReplicateTo) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe GrowthType) |
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.
DeleteDeploymentStrategy
data DeleteDeploymentStrategy Source #
See: newDeleteDeploymentStrategy smart constructor.
Constructors
| DeleteDeploymentStrategy' Text |
Instances
newDeleteDeploymentStrategy Source #
Create a value of DeleteDeploymentStrategy 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:DeleteDeploymentStrategy', deleteDeploymentStrategy_deploymentStrategyId - The ID of the deployment strategy you want to delete.
data DeleteDeploymentStrategyResponse Source #
See: newDeleteDeploymentStrategyResponse smart constructor.
Constructors
| DeleteDeploymentStrategyResponse' | |
Instances
| Eq DeleteDeploymentStrategyResponse Source # | |
| Read DeleteDeploymentStrategyResponse Source # | |
| Show DeleteDeploymentStrategyResponse Source # | |
Defined in Amazonka.AppConfig.DeleteDeploymentStrategy Methods showsPrec :: Int -> DeleteDeploymentStrategyResponse -> ShowS # | |
| Generic DeleteDeploymentStrategyResponse Source # | |
Defined in Amazonka.AppConfig.DeleteDeploymentStrategy Associated Types type Rep DeleteDeploymentStrategyResponse :: Type -> Type # | |
| NFData DeleteDeploymentStrategyResponse Source # | |
Defined in Amazonka.AppConfig.DeleteDeploymentStrategy Methods rnf :: DeleteDeploymentStrategyResponse -> () # | |
| type Rep DeleteDeploymentStrategyResponse Source # | |
Defined in Amazonka.AppConfig.DeleteDeploymentStrategy | |
newDeleteDeploymentStrategyResponse :: DeleteDeploymentStrategyResponse Source #
Create a value of DeleteDeploymentStrategyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CreateApplication
data CreateApplication Source #
See: newCreateApplication smart constructor.
Instances
Arguments
| :: Text | |
| -> CreateApplication |
Create a value of CreateApplication 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:CreateApplication', createApplication_description - A description of the application.
$sel:tags:CreateApplication', createApplication_tags - Metadata to assign to the application. 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:CreateApplication', createApplication_name - A name for the application.
data Application Source #
See: newApplication smart constructor.
Instances
newApplication :: Application Source #
Create a value of Application 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:name:Application', application_name - The application name.
$sel:id:Application', application_id - The application ID.
$sel:description:Application', application_description - The description of the application.
ValidateConfiguration
data ValidateConfiguration Source #
See: newValidateConfiguration smart constructor.
Constructors
| ValidateConfiguration' Text Text Text |
Instances
newValidateConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ValidateConfiguration |
Create a value of ValidateConfiguration 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:applicationId:ValidateConfiguration', validateConfiguration_applicationId - The application ID.
$sel:configurationProfileId:ValidateConfiguration', validateConfiguration_configurationProfileId - The configuration profile ID.
$sel:configurationVersion:ValidateConfiguration', validateConfiguration_configurationVersion - The version of the configuration to validate.
data ValidateConfigurationResponse Source #
See: newValidateConfigurationResponse smart constructor.
Constructors
| ValidateConfigurationResponse' | |
Instances
| Eq ValidateConfigurationResponse Source # | |
Defined in Amazonka.AppConfig.ValidateConfiguration | |
| Read ValidateConfigurationResponse Source # | |
| Show ValidateConfigurationResponse Source # | |
Defined in Amazonka.AppConfig.ValidateConfiguration Methods showsPrec :: Int -> ValidateConfigurationResponse -> ShowS # show :: ValidateConfigurationResponse -> String # showList :: [ValidateConfigurationResponse] -> ShowS # | |
| Generic ValidateConfigurationResponse Source # | |
Defined in Amazonka.AppConfig.ValidateConfiguration Associated Types type Rep ValidateConfigurationResponse :: Type -> Type # | |
| NFData ValidateConfigurationResponse Source # | |
Defined in Amazonka.AppConfig.ValidateConfiguration Methods rnf :: ValidateConfigurationResponse -> () # | |
| type Rep ValidateConfigurationResponse Source # | |
Defined in Amazonka.AppConfig.ValidateConfiguration | |
newValidateConfigurationResponse :: ValidateConfigurationResponse Source #
Create a value of ValidateConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StopDeployment
data StopDeployment Source #
See: newStopDeployment smart constructor.
Constructors
| StopDeployment' Text Text Int |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Int | |
| -> StopDeployment |
Create a value of StopDeployment 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:applicationId:StopDeployment', stopDeployment_applicationId - The application ID.
$sel:environmentId:StopDeployment', stopDeployment_environmentId - The environment ID.
$sel:deploymentNumber:StopDeployment', stopDeployment_deploymentNumber - The sequence number of the deployment.
data Deployment Source #
See: newDeployment smart constructor.
Constructors
| Deployment' (Maybe Double) (Maybe Text) (Maybe DeploymentState) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Double) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe GrowthType) |
Instances
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.
GetApplication
data GetApplication Source #
See: newGetApplication smart constructor.
Constructors
| GetApplication' Text |
Instances
Arguments
| :: Text | |
| -> GetApplication |
Create a value of GetApplication 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:applicationId:GetApplication', getApplication_applicationId - The ID of the application you want to get.
data Application Source #
See: newApplication smart constructor.
Instances
newApplication :: Application Source #
Create a value of Application 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:name:Application', application_name - The application name.
$sel:id:Application', application_id - The application ID.
$sel:description:Application', application_description - The description of the application.
CreateHostedConfigurationVersion
data CreateHostedConfigurationVersion Source #
See: newCreateHostedConfigurationVersion smart constructor.
Constructors
| CreateHostedConfigurationVersion' (Maybe Int) (Maybe Text) Text Text (Sensitive ByteString) Text |
Instances
newCreateHostedConfigurationVersion Source #
Arguments
| :: Text | |
| -> Text |
|
| -> ByteString | |
| -> Text | |
| -> CreateHostedConfigurationVersion |
Create a value of CreateHostedConfigurationVersion 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:latestVersionNumber:CreateHostedConfigurationVersion', createHostedConfigurationVersion_latestVersionNumber - An optional locking token used to prevent race conditions from
overwriting configuration updates when creating a new version. To ensure
your data is not overwritten when creating multiple hosted configuration
versions in rapid succession, specify the version of the latest hosted
configuration version.
$sel:description:CreateHostedConfigurationVersion', createHostedConfigurationVersion_description - A description of the configuration.
$sel:applicationId:CreateHostedConfigurationVersion', createHostedConfigurationVersion_applicationId - The application ID.
$sel:configurationProfileId:CreateHostedConfigurationVersion', createHostedConfigurationVersion_configurationProfileId - The configuration profile ID.
$sel:content:CreateHostedConfigurationVersion', createHostedConfigurationVersion_content - The content of the configuration or the configuration data.
$sel:contentType:CreateHostedConfigurationVersion', createHostedConfigurationVersion_contentType - A standard MIME type describing the format of the configuration content.
For more information, see
Content-Type.
data HostedConfigurationVersion Source #
See: newHostedConfigurationVersion smart constructor.
Constructors
| HostedConfigurationVersion' (Maybe (Sensitive ByteString)) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newHostedConfigurationVersion :: HostedConfigurationVersion Source #
Create a value of HostedConfigurationVersion 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:content:HostedConfigurationVersion', hostedConfigurationVersion_content - The content of the configuration or the configuration data.
$sel:versionNumber:HostedConfigurationVersion', hostedConfigurationVersion_versionNumber - The configuration version.
$sel:applicationId:HostedConfigurationVersion', hostedConfigurationVersion_applicationId - The application ID.
$sel:description:HostedConfigurationVersion', hostedConfigurationVersion_description - A description of the configuration.
$sel:configurationProfileId:HostedConfigurationVersion', hostedConfigurationVersion_configurationProfileId - The configuration profile ID.
$sel:contentType:HostedConfigurationVersion', hostedConfigurationVersion_contentType - A standard MIME type describing the format of the configuration content.
For more information, see
Content-Type.
ListConfigurationProfiles
data ListConfigurationProfiles Source #
See: newListConfigurationProfiles smart constructor.
Instances
newListConfigurationProfiles Source #
Create a value of ListConfigurationProfiles 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:nextToken:ListConfigurationProfiles', listConfigurationProfiles_nextToken - A token to start the list. Use this token to get the next set of
results.
$sel:maxResults:ListConfigurationProfiles', listConfigurationProfiles_maxResults - The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the
next set of results.
$sel:applicationId:ListConfigurationProfiles', listConfigurationProfiles_applicationId - The application ID.
data ListConfigurationProfilesResponse Source #
See: newListConfigurationProfilesResponse smart constructor.
Constructors
| ListConfigurationProfilesResponse' (Maybe [ConfigurationProfileSummary]) (Maybe Text) Int |
Instances
newListConfigurationProfilesResponse Source #
Arguments
| :: Int | |
| -> ListConfigurationProfilesResponse |
Create a value of ListConfigurationProfilesResponse 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:items:ListConfigurationProfilesResponse', listConfigurationProfilesResponse_items - The elements from this collection.
$sel:nextToken:ListConfigurationProfiles', listConfigurationProfilesResponse_nextToken - The token for the next set of items to return. Use this token to get the
next set of results.
$sel:httpStatus:ListConfigurationProfilesResponse', listConfigurationProfilesResponse_httpStatus - The response's http status code.
DeleteHostedConfigurationVersion
data DeleteHostedConfigurationVersion Source #
See: newDeleteHostedConfigurationVersion smart constructor.
Constructors
| DeleteHostedConfigurationVersion' Text Text Int |
Instances
newDeleteHostedConfigurationVersion Source #
Arguments
| :: Text | |
| -> Text |
|
| -> Int | |
| -> DeleteHostedConfigurationVersion |
Create a value of DeleteHostedConfigurationVersion 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:applicationId:DeleteHostedConfigurationVersion', deleteHostedConfigurationVersion_applicationId - The application ID.
$sel:configurationProfileId:DeleteHostedConfigurationVersion', deleteHostedConfigurationVersion_configurationProfileId - The configuration profile ID.
$sel:versionNumber:DeleteHostedConfigurationVersion', deleteHostedConfigurationVersion_versionNumber - The versions number to delete.
data DeleteHostedConfigurationVersionResponse Source #
See: newDeleteHostedConfigurationVersionResponse smart constructor.
Constructors
| DeleteHostedConfigurationVersionResponse' | |
Instances
| Eq DeleteHostedConfigurationVersionResponse Source # | |
| Read DeleteHostedConfigurationVersionResponse Source # | |
| Show DeleteHostedConfigurationVersionResponse Source # | |
| Generic DeleteHostedConfigurationVersionResponse Source # | |
Defined in Amazonka.AppConfig.DeleteHostedConfigurationVersion Associated Types type Rep DeleteHostedConfigurationVersionResponse :: Type -> Type # | |
| NFData DeleteHostedConfigurationVersionResponse Source # | |
Defined in Amazonka.AppConfig.DeleteHostedConfigurationVersion Methods rnf :: DeleteHostedConfigurationVersionResponse -> () # | |
| type Rep DeleteHostedConfigurationVersionResponse Source # | |
Defined in Amazonka.AppConfig.DeleteHostedConfigurationVersion type Rep DeleteHostedConfigurationVersionResponse = D1 ('MetaData "DeleteHostedConfigurationVersionResponse" "Amazonka.AppConfig.DeleteHostedConfigurationVersion" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "DeleteHostedConfigurationVersionResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) | |
newDeleteHostedConfigurationVersionResponse :: DeleteHostedConfigurationVersionResponse Source #
Create a value of DeleteHostedConfigurationVersionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetHostedConfigurationVersion
data GetHostedConfigurationVersion Source #
See: newGetHostedConfigurationVersion smart constructor.
Constructors
| GetHostedConfigurationVersion' Text Text Int |
Instances
newGetHostedConfigurationVersion Source #
Arguments
| :: Text | |
| -> Text | |
| -> Int | |
| -> GetHostedConfigurationVersion |
Create a value of GetHostedConfigurationVersion 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:applicationId:GetHostedConfigurationVersion', getHostedConfigurationVersion_applicationId - The application ID.
$sel:configurationProfileId:GetHostedConfigurationVersion', getHostedConfigurationVersion_configurationProfileId - The configuration profile ID.
$sel:versionNumber:GetHostedConfigurationVersion', getHostedConfigurationVersion_versionNumber - The version.
data HostedConfigurationVersion Source #
See: newHostedConfigurationVersion smart constructor.
Constructors
| HostedConfigurationVersion' (Maybe (Sensitive ByteString)) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newHostedConfigurationVersion :: HostedConfigurationVersion Source #
Create a value of HostedConfigurationVersion 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:content:HostedConfigurationVersion', hostedConfigurationVersion_content - The content of the configuration or the configuration data.
$sel:versionNumber:HostedConfigurationVersion', hostedConfigurationVersion_versionNumber - The configuration version.
$sel:applicationId:HostedConfigurationVersion', hostedConfigurationVersion_applicationId - The application ID.
$sel:description:HostedConfigurationVersion', hostedConfigurationVersion_description - A description of the configuration.
$sel:configurationProfileId:HostedConfigurationVersion', hostedConfigurationVersion_configurationProfileId - The configuration profile ID.
$sel:contentType:HostedConfigurationVersion', hostedConfigurationVersion_contentType - A standard MIME type describing the format of the configuration content.
For more information, see
Content-Type.
ListDeployments
data ListDeployments Source #
See: newListDeployments smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> ListDeployments |
Create a value of ListDeployments 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:nextToken:ListDeployments', listDeployments_nextToken - A token to start the list. Use this token to get the next set of
results.
$sel:maxResults:ListDeployments', listDeployments_maxResults - The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the
next set of results.
$sel:applicationId:ListDeployments', listDeployments_applicationId - The application ID.
$sel:environmentId:ListDeployments', listDeployments_environmentId - The environment ID.
data ListDeploymentsResponse Source #
See: newListDeploymentsResponse smart constructor.
Constructors
| ListDeploymentsResponse' (Maybe [DeploymentSummary]) (Maybe Text) Int |
Instances
newListDeploymentsResponse Source #
Create a value of ListDeploymentsResponse 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:items:ListDeploymentsResponse', listDeploymentsResponse_items - The elements from this collection.
$sel:nextToken:ListDeployments', listDeploymentsResponse_nextToken - The token for the next set of items to return. Use this token to get the
next set of results.
$sel:httpStatus:ListDeploymentsResponse', listDeploymentsResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text (HashMap Text Text) |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceArn:TagResource', tagResource_resourceArn - The ARN of the resource for which to retrieve tags.
$sel:tags:TagResource', tagResource_tags - The key-value string map. The valid character set is [a-zA-Z+-=._:/].
The tag key can be up to 128 characters and must not start with aws:.
The tag value can be up to 256 characters.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' | |
Instances
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetEnvironment
data GetEnvironment Source #
See: newGetEnvironment smart constructor.
Constructors
| GetEnvironment' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetEnvironment |
Create a value of GetEnvironment 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:applicationId:GetEnvironment', getEnvironment_applicationId - The ID of the application that includes the environment you want to get.
$sel:environmentId:GetEnvironment', getEnvironment_environmentId - The ID of the environment you wnat to get.
data Environment Source #
See: newEnvironment smart constructor.
Constructors
| Environment' (Maybe EnvironmentState) (Maybe [Monitor]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newEnvironment :: Environment Source #
Create a value of Environment 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:state:Environment', environment_state - The state of the environment. An environment can be in one of the
following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK,
or ROLLED_BACK
$sel:monitors:Environment', environment_monitors - Amazon CloudWatch alarms monitored during the deployment.
$sel:applicationId:Environment', environment_applicationId - The application ID.
$sel:name:Environment', environment_name - The name of the environment.
$sel:id:Environment', environment_id - The environment ID.
$sel:description:Environment', environment_description - The description of the environment.
ListApplications
data ListApplications Source #
See: newListApplications smart constructor.
Constructors
| ListApplications' (Maybe Text) (Maybe Natural) |
Instances
newListApplications :: ListApplications Source #
Create a value of ListApplications 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:nextToken:ListApplications', listApplications_nextToken - A token to start the list. Use this token to get the next set of
results.
$sel:maxResults:ListApplications', listApplications_maxResults - The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the
next set of results.
data ListApplicationsResponse Source #
See: newListApplicationsResponse smart constructor.
Constructors
| ListApplicationsResponse' (Maybe [Application]) (Maybe Text) Int |
Instances
newListApplicationsResponse Source #
Create a value of ListApplicationsResponse 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:items:ListApplicationsResponse', listApplicationsResponse_items - The elements from this collection.
$sel:nextToken:ListApplications', listApplicationsResponse_nextToken - The token for the next set of items to return. Use this token to get the
next set of results.
$sel:httpStatus:ListApplicationsResponse', listApplicationsResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceArn:UntagResource', untagResource_resourceArn - The ARN of the resource for which to remove tags.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The tag keys to delete.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' | |
Instances
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
ListDeploymentStrategies
data ListDeploymentStrategies Source #
See: newListDeploymentStrategies smart constructor.
Constructors
| ListDeploymentStrategies' (Maybe Text) (Maybe Natural) |
Instances
newListDeploymentStrategies :: ListDeploymentStrategies Source #
Create a value of ListDeploymentStrategies 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:nextToken:ListDeploymentStrategies', listDeploymentStrategies_nextToken - A token to start the list. Use this token to get the next set of
results.
$sel:maxResults:ListDeploymentStrategies', listDeploymentStrategies_maxResults - The maximum number of items to return for this call. The call also
returns a token that you can specify in a subsequent call to get the
next set of results.
data ListDeploymentStrategiesResponse Source #
See: newListDeploymentStrategiesResponse smart constructor.
Constructors
| ListDeploymentStrategiesResponse' (Maybe [DeploymentStrategy]) (Maybe Text) Int |
Instances
newListDeploymentStrategiesResponse Source #
Create a value of ListDeploymentStrategiesResponse 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:items:ListDeploymentStrategiesResponse', listDeploymentStrategiesResponse_items - The elements from this collection.
$sel:nextToken:ListDeploymentStrategies', listDeploymentStrategiesResponse_nextToken - The token for the next set of items to return. Use this token to get the
next set of results.
$sel:httpStatus:ListDeploymentStrategiesResponse', listDeploymentStrategiesResponse_httpStatus - The response's http status code.
GetConfiguration
data GetConfiguration Source #
See: newGetConfiguration smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> GetConfiguration |
Create a value of GetConfiguration 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:clientConfigurationVersion:GetConfiguration', getConfiguration_clientConfigurationVersion - The configuration version returned in the most recent GetConfiguration
response.
AWS AppConfig uses the value of the ClientConfigurationVersion
parameter to identify the configuration version on your clients. If you
don’t send ClientConfigurationVersion with each call to
GetConfiguration, your clients receive the current configuration. You
are charged each time your clients receive a configuration.
To avoid excess charges, we recommend that you include the
ClientConfigurationVersion value with every call to
GetConfiguration. This value must be saved on your client. Subsequent
calls to GetConfiguration must pass this value by using the
ClientConfigurationVersion parameter.
For more information about working with configurations, see Retrieving the Configuration in the AWS AppConfig User Guide.
$sel:application:GetConfiguration', getConfiguration_application - The application to get. Specify either the application name or the
application ID.
$sel:environment:GetConfiguration', getConfiguration_environment - The environment to get. Specify either the environment name or the
environment ID.
$sel:configuration:GetConfiguration', getConfiguration_configuration - The configuration to get. Specify either the configuration name or the
configuration ID.
$sel:clientId:GetConfiguration', getConfiguration_clientId - A unique ID to identify the client for the configuration. This ID
enables AppConfig to deploy the configuration in intervals, as defined
in the deployment strategy.
data GetConfigurationResponse Source #
See: newGetConfigurationResponse smart constructor.
Constructors
| GetConfigurationResponse' (Maybe Text) (Maybe (Sensitive ByteString)) (Maybe Text) Int |
Instances
newGetConfigurationResponse Source #
Create a value of GetConfigurationResponse 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:configurationVersion:GetConfigurationResponse', getConfigurationResponse_configurationVersion - The configuration version.
$sel:content:GetConfigurationResponse', getConfigurationResponse_content - The content of the configuration or the configuration data.
$sel:contentType:GetConfigurationResponse', getConfigurationResponse_contentType - A standard MIME type describing the format of the configuration content.
For more information, see
Content-Type.
$sel:httpStatus:GetConfigurationResponse', getConfigurationResponse_httpStatus - The response's http status code.
CreateDeploymentStrategy
data CreateDeploymentStrategy Source #
See: newCreateDeploymentStrategy smart constructor.
Constructors
| CreateDeploymentStrategy' (Maybe Natural) (Maybe Text) (Maybe GrowthType) (Maybe (HashMap Text Text)) Text Natural Double ReplicateTo |
Instances
newCreateDeploymentStrategy Source #
Arguments
| :: Text | |
| -> Natural | |
| -> Double | |
| -> ReplicateTo | |
| -> 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.
data DeploymentStrategy Source #
See: newDeploymentStrategy smart constructor.
Constructors
| DeploymentStrategy' (Maybe Double) (Maybe ReplicateTo) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe GrowthType) |
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.
StartDeployment
data StartDeployment Source #
See: newStartDeployment smart constructor.
Instances
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.
data Deployment Source #
See: newDeployment smart constructor.
Constructors
| Deployment' (Maybe Double) (Maybe Text) (Maybe DeploymentState) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Double) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe GrowthType) |
Instances
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.
CreateEnvironment
data CreateEnvironment Source #
See: newCreateEnvironment smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CreateEnvironment |
Create a value of CreateEnvironment 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:monitors:CreateEnvironment', createEnvironment_monitors - Amazon CloudWatch alarms to monitor during the deployment process.
$sel:description:CreateEnvironment', createEnvironment_description - A description of the environment.
$sel:tags:CreateEnvironment', createEnvironment_tags - Metadata to assign to the environment. 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:CreateEnvironment', createEnvironment_applicationId - The application ID.
$sel:name:CreateEnvironment', createEnvironment_name - A name for the environment.
data Environment Source #
See: newEnvironment smart constructor.
Constructors
| Environment' (Maybe EnvironmentState) (Maybe [Monitor]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newEnvironment :: Environment Source #
Create a value of Environment 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:state:Environment', environment_state - The state of the environment. An environment can be in one of the
following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK,
or ROLLED_BACK
$sel:monitors:Environment', environment_monitors - Amazon CloudWatch alarms monitored during the deployment.
$sel:applicationId:Environment', environment_applicationId - The application ID.
$sel:name:Environment', environment_name - The name of the environment.
$sel:id:Environment', environment_id - The environment ID.
$sel:description:Environment', environment_description - The description of the environment.
Types
DeploymentEventType
newtype DeploymentEventType Source #
Constructors
| DeploymentEventType' | |
Fields | |
Bundled Patterns
Instances
DeploymentState
newtype DeploymentState Source #
Constructors
| DeploymentState' | |
Fields | |
Bundled Patterns
| pattern DeploymentState_BAKING :: DeploymentState | |
| pattern DeploymentState_COMPLETE :: DeploymentState | |
| pattern DeploymentState_DEPLOYING :: DeploymentState | |
| pattern DeploymentState_ROLLED_BACK :: DeploymentState | |
| pattern DeploymentState_ROLLING_BACK :: DeploymentState | |
| pattern DeploymentState_VALIDATING :: DeploymentState |
Instances
EnvironmentState
newtype EnvironmentState Source #
Constructors
| EnvironmentState' | |
Fields | |
Bundled Patterns
| pattern EnvironmentState_DEPLOYING :: EnvironmentState | |
| pattern EnvironmentState_READY_FOR_DEPLOYMENT :: EnvironmentState | |
| pattern EnvironmentState_ROLLED_BACK :: EnvironmentState | |
| pattern EnvironmentState_ROLLING_BACK :: EnvironmentState |
Instances
GrowthType
newtype GrowthType Source #
Constructors
| GrowthType' | |
Fields | |
Bundled Patterns
| pattern GrowthType_EXPONENTIAL :: GrowthType | |
| pattern GrowthType_LINEAR :: GrowthType |
Instances
ReplicateTo
newtype ReplicateTo Source #
Constructors
| ReplicateTo' | |
Fields | |
Bundled Patterns
| pattern ReplicateTo_NONE :: ReplicateTo | |
| pattern ReplicateTo_SSM_DOCUMENT :: ReplicateTo |
Instances
TriggeredBy
newtype TriggeredBy Source #
Constructors
| TriggeredBy' | |
Fields | |
Bundled Patterns
| pattern TriggeredBy_APPCONFIG :: TriggeredBy | |
| pattern TriggeredBy_CLOUDWATCH_ALARM :: TriggeredBy | |
| pattern TriggeredBy_INTERNAL_ERROR :: TriggeredBy | |
| pattern TriggeredBy_USER :: TriggeredBy |
Instances
ValidatorType
newtype ValidatorType Source #
Constructors
| ValidatorType' | |
Fields | |
Bundled Patterns
| pattern ValidatorType_JSON_SCHEMA :: ValidatorType | |
| pattern ValidatorType_LAMBDA :: ValidatorType |
Instances
Application
data Application Source #
See: newApplication smart constructor.
Instances
newApplication :: Application Source #
Create a value of Application 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:name:Application', application_name - The application name.
$sel:id:Application', application_id - The application ID.
$sel:description:Application', application_description - The description of the application.
ConfigurationProfile
data ConfigurationProfile Source #
See: newConfigurationProfile smart constructor.
Constructors
| ConfigurationProfile' (Maybe Text) (Maybe [Validator]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newConfigurationProfile :: ConfigurationProfile Source #
Create a value of ConfigurationProfile 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:retrievalRoleArn:ConfigurationProfile', configurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
$sel:validators:ConfigurationProfile', configurationProfile_validators - A list of methods for validating the configuration.
$sel:locationUri:ConfigurationProfile', configurationProfile_locationUri - The URI location of the configuration.
$sel:applicationId:ConfigurationProfile', configurationProfile_applicationId - The application ID.
$sel:name:ConfigurationProfile', configurationProfile_name - The name of the configuration profile.
$sel:id:ConfigurationProfile', configurationProfile_id - The configuration profile ID.
$sel:description:ConfigurationProfile', configurationProfile_description - The configuration profile description.
ConfigurationProfileSummary
data ConfigurationProfileSummary Source #
A summary of a configuration profile.
See: newConfigurationProfileSummary smart constructor.
Constructors
| ConfigurationProfileSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ValidatorType]) |
Instances
newConfigurationProfileSummary :: ConfigurationProfileSummary Source #
Create a value of ConfigurationProfileSummary 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:locationUri:ConfigurationProfileSummary', configurationProfileSummary_locationUri - The URI location of the configuration.
$sel:applicationId:ConfigurationProfileSummary', configurationProfileSummary_applicationId - The application ID.
$sel:name:ConfigurationProfileSummary', configurationProfileSummary_name - The name of the configuration profile.
$sel:id:ConfigurationProfileSummary', configurationProfileSummary_id - The ID of the configuration profile.
$sel:validatorTypes:ConfigurationProfileSummary', configurationProfileSummary_validatorTypes - The types of validators in the configuration profile.
Deployment
data Deployment Source #
See: newDeployment smart constructor.
Constructors
| Deployment' (Maybe Double) (Maybe Text) (Maybe DeploymentState) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Double) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Text) (Maybe GrowthType) |
Instances
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.
DeploymentEvent
data DeploymentEvent Source #
An object that describes a deployment event.
See: newDeploymentEvent smart constructor.
Constructors
| DeploymentEvent' (Maybe TriggeredBy) (Maybe POSIX) (Maybe DeploymentEventType) (Maybe Text) |
Instances
newDeploymentEvent :: DeploymentEvent Source #
Create a value of DeploymentEvent 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:triggeredBy:DeploymentEvent', deploymentEvent_triggeredBy - The entity that triggered the deployment event. Events can be triggered
by a user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal
error.
$sel:occurredAt:DeploymentEvent', deploymentEvent_occurredAt - The date and time the event occurred.
$sel:eventType:DeploymentEvent', deploymentEvent_eventType - The type of deployment event. Deployment event types include the start,
stop, or completion of a deployment; a percentage update; the start or
stop of a bake period; the start or completion of a rollback.
$sel:description:DeploymentEvent', deploymentEvent_description - A description of the deployment event. Descriptions include, but are not
limited to, the user account or the CloudWatch alarm ARN that initiated
a rollback, the percentage of hosts that received the deployment, or in
the case of an internal error, a recommendation to attempt a new
deployment.
DeploymentStrategy
data DeploymentStrategy Source #
See: newDeploymentStrategy smart constructor.
Constructors
| DeploymentStrategy' (Maybe Double) (Maybe ReplicateTo) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Natural) (Maybe Text) (Maybe GrowthType) |
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.
DeploymentSummary
data DeploymentSummary Source #
Information about the deployment.
See: newDeploymentSummary smart constructor.
Constructors
| DeploymentSummary' (Maybe Double) (Maybe Text) (Maybe DeploymentState) (Maybe Int) (Maybe Text) (Maybe Double) (Maybe POSIX) (Maybe Natural) (Maybe POSIX) (Maybe Natural) (Maybe GrowthType) |
Instances
newDeploymentSummary :: DeploymentSummary Source #
Create a value of DeploymentSummary 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:DeploymentSummary', deploymentSummary_growthFactor - The percentage of targets to receive a deployed configuration during
each interval.
$sel:configurationName:DeploymentSummary', deploymentSummary_configurationName - The name of the configuration.
$sel:state:DeploymentSummary', deploymentSummary_state - The state of the deployment.
$sel:deploymentNumber:DeploymentSummary', deploymentSummary_deploymentNumber - The sequence number of the deployment.
$sel:configurationVersion:DeploymentSummary', deploymentSummary_configurationVersion - The version of the configuration.
$sel:percentageComplete:DeploymentSummary', deploymentSummary_percentageComplete - The percentage of targets for which the deployment is available.
$sel:startedAt:DeploymentSummary', deploymentSummary_startedAt - Time the deployment started.
$sel:deploymentDurationInMinutes:DeploymentSummary', deploymentSummary_deploymentDurationInMinutes - Total amount of time the deployment lasted.
$sel:completedAt:DeploymentSummary', deploymentSummary_completedAt - Time the deployment completed.
$sel:finalBakeTimeInMinutes:DeploymentSummary', deploymentSummary_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:growthType:DeploymentSummary', deploymentSummary_growthType - The algorithm used to define how percentage grows over time.
Environment
data Environment Source #
See: newEnvironment smart constructor.
Constructors
| Environment' (Maybe EnvironmentState) (Maybe [Monitor]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newEnvironment :: Environment Source #
Create a value of Environment 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:state:Environment', environment_state - The state of the environment. An environment can be in one of the
following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK,
or ROLLED_BACK
$sel:monitors:Environment', environment_monitors - Amazon CloudWatch alarms monitored during the deployment.
$sel:applicationId:Environment', environment_applicationId - The application ID.
$sel:name:Environment', environment_name - The name of the environment.
$sel:id:Environment', environment_id - The environment ID.
$sel:description:Environment', environment_description - The description of the environment.
HostedConfigurationVersion
data HostedConfigurationVersion Source #
See: newHostedConfigurationVersion smart constructor.
Constructors
| HostedConfigurationVersion' (Maybe (Sensitive ByteString)) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newHostedConfigurationVersion :: HostedConfigurationVersion Source #
Create a value of HostedConfigurationVersion 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:content:HostedConfigurationVersion', hostedConfigurationVersion_content - The content of the configuration or the configuration data.
$sel:versionNumber:HostedConfigurationVersion', hostedConfigurationVersion_versionNumber - The configuration version.
$sel:applicationId:HostedConfigurationVersion', hostedConfigurationVersion_applicationId - The application ID.
$sel:description:HostedConfigurationVersion', hostedConfigurationVersion_description - A description of the configuration.
$sel:configurationProfileId:HostedConfigurationVersion', hostedConfigurationVersion_configurationProfileId - The configuration profile ID.
$sel:contentType:HostedConfigurationVersion', hostedConfigurationVersion_contentType - A standard MIME type describing the format of the configuration content.
For more information, see
Content-Type.
HostedConfigurationVersionSummary
data HostedConfigurationVersionSummary Source #
Information about the configuration.
See: newHostedConfigurationVersionSummary smart constructor.
Constructors
| HostedConfigurationVersionSummary' (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newHostedConfigurationVersionSummary :: HostedConfigurationVersionSummary Source #
Create a value of HostedConfigurationVersionSummary 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:versionNumber:HostedConfigurationVersionSummary', hostedConfigurationVersionSummary_versionNumber - The configuration version.
$sel:applicationId:HostedConfigurationVersionSummary', hostedConfigurationVersionSummary_applicationId - The application ID.
$sel:description:HostedConfigurationVersionSummary', hostedConfigurationVersionSummary_description - A description of the configuration.
$sel:configurationProfileId:HostedConfigurationVersionSummary', hostedConfigurationVersionSummary_configurationProfileId - The configuration profile ID.
$sel:contentType:HostedConfigurationVersionSummary', hostedConfigurationVersionSummary_contentType - A standard MIME type describing the format of the configuration content.
For more information, see
Content-Type.
Monitor
Amazon CloudWatch alarms to monitor during the deployment process.
See: newMonitor smart constructor.
Instances
| Eq Monitor Source # | |
| Read Monitor Source # | |
| Show Monitor Source # | |
| Generic Monitor Source # | |
| NFData Monitor Source # | |
Defined in Amazonka.AppConfig.Types.Monitor | |
| Hashable Monitor Source # | |
Defined in Amazonka.AppConfig.Types.Monitor | |
| ToJSON Monitor Source # | |
Defined in Amazonka.AppConfig.Types.Monitor | |
| FromJSON Monitor Source # | |
| type Rep Monitor Source # | |
Defined in Amazonka.AppConfig.Types.Monitor type Rep Monitor = D1 ('MetaData "Monitor" "Amazonka.AppConfig.Types.Monitor" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "Monitor'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alarmRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "alarmArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newMonitor :: Monitor Source #
Create a value of Monitor 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:alarmRoleArn:Monitor', monitor_alarmRoleArn - ARN of an IAM role for AppConfig to monitor AlarmArn.
$sel:alarmArn:Monitor', monitor_alarmArn - ARN of the Amazon CloudWatch alarm.
Validator
A validator provides a syntactic or semantic check to ensure the configuration you want to deploy functions as intended. To validate your application configuration data, you provide a schema or a Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.
See: newValidator smart constructor.
Constructors
| Validator' ValidatorType (Sensitive Text) |
Instances
| Eq Validator Source # | |
| Show Validator Source # | |
| Generic Validator Source # | |
| NFData Validator Source # | |
Defined in Amazonka.AppConfig.Types.Validator | |
| Hashable Validator Source # | |
Defined in Amazonka.AppConfig.Types.Validator | |
| ToJSON Validator Source # | |
Defined in Amazonka.AppConfig.Types.Validator | |
| FromJSON Validator Source # | |
| type Rep Validator Source # | |
Defined in Amazonka.AppConfig.Types.Validator type Rep Validator = D1 ('MetaData "Validator" "Amazonka.AppConfig.Types.Validator" "libZSservicesZSamazonka-appconfigZSamazonka-appconfig" 'False) (C1 ('MetaCons "Validator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ValidatorType) :*: S1 ('MetaSel ('Just "content") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))) | |
Arguments
| :: ValidatorType | |
| -> Text | |
| -> Validator |
Create a value of Validator 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:type':Validator', validator_type - AppConfig supports validators of type JSON_SCHEMA and LAMBDA
$sel:content:Validator', validator_content - Either the JSON Schema content or the Amazon Resource Name (ARN) of an
AWS Lambda function.