| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.AppConfig
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- CreateApplication
- CreateConfigurationProfile
- CreateDeploymentStrategy
- CreateEnvironment
- CreateExtension
- CreateExtensionAssociation
- CreateHostedConfigurationVersion
- DeleteApplication
- DeleteConfigurationProfile
- DeleteDeploymentStrategy
- DeleteEnvironment
- DeleteExtension
- DeleteExtensionAssociation
- DeleteHostedConfigurationVersion
- GetApplication
- GetConfigurationProfile
- GetDeployment
- GetDeploymentStrategy
- GetEnvironment
- GetExtension
- GetExtensionAssociation
- GetHostedConfigurationVersion
- ListApplications
- ListConfigurationProfiles
- ListDeploymentStrategies
- ListDeployments
- ListEnvironments
- ListExtensionAssociations
- ListExtensions
- ListHostedConfigurationVersions
- ListTagsForResource
- StartDeployment
- StopDeployment
- TagResource
- UntagResource
- UpdateApplication
- UpdateConfigurationProfile
- UpdateDeploymentStrategy
- UpdateEnvironment
- UpdateExtension
- UpdateExtensionAssociation
- ValidateConfiguration
- Types
- ActionPoint
- DeploymentEventType
- DeploymentState
- EnvironmentState
- GrowthType
- ReplicateTo
- TriggeredBy
- ValidatorType
- Action
- ActionInvocation
- Application
- AppliedExtension
- ConfigurationProfile
- ConfigurationProfileSummary
- Deployment
- DeploymentEvent
- DeploymentStrategy
- DeploymentSummary
- Environment
- Extension
- ExtensionAssociation
- ExtensionAssociationSummary
- ExtensionSummary
- HostedConfigurationVersion
- HostedConfigurationVersionSummary
- Monitor
- Parameter
- Validator
Description
Derived from API version 2019-10-09 of the AWS service descriptions, licensed under Apache 2.0.
Use AppConfig, a capability of Amazon Web Services 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, 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 an Amazon Web Services 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:
- Feature flags: Use AppConfig to turn on new features that require a timely deployment, such as a product launch or announcement.
- Application tuning: Use AppConfig to carefully introduce changes to your application that can only be tested with production traffic.
- 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 AppConfig User Guide.
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _PayloadTooLargeException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ServiceQuotaExceededException :: AsError a => Fold a ServiceError
- 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 CreateConfigurationProfile = CreateConfigurationProfile' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Validator]) Text Text Text
- newCreateConfigurationProfile :: Text -> Text -> Text -> CreateConfigurationProfile
- data ConfigurationProfile = ConfigurationProfile' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Validator])
- newConfigurationProfile :: ConfigurationProfile
- data CreateDeploymentStrategy = CreateDeploymentStrategy' (Maybe Text) (Maybe Natural) (Maybe GrowthType) (Maybe ReplicateTo) (Maybe (HashMap Text Text)) Text Natural Double
- newCreateDeploymentStrategy :: Text -> Natural -> Double -> CreateDeploymentStrategy
- data DeploymentStrategy = DeploymentStrategy' (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Text) (Maybe Text) (Maybe ReplicateTo)
- newDeploymentStrategy :: DeploymentStrategy
- data CreateEnvironment = CreateEnvironment' (Maybe Text) (Maybe [Monitor]) (Maybe (HashMap Text Text)) Text Text
- newCreateEnvironment :: Text -> Text -> CreateEnvironment
- data Environment = Environment' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Monitor]) (Maybe Text) (Maybe EnvironmentState)
- newEnvironment :: Environment
- data CreateExtension = CreateExtension' (Maybe Text) (Maybe Int) (Maybe (HashMap Text Parameter)) (Maybe (HashMap Text Text)) Text (HashMap ActionPoint (NonEmpty Action))
- newCreateExtension :: Text -> CreateExtension
- data Extension = Extension' (Maybe (HashMap ActionPoint (NonEmpty Action))) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Parameter)) (Maybe Int)
- newExtension :: Extension
- data CreateExtensionAssociation = CreateExtensionAssociation' (Maybe Int) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Text Text
- newCreateExtensionAssociation :: Text -> Text -> CreateExtensionAssociation
- data ExtensionAssociation = ExtensionAssociation' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text)
- newExtensionAssociation :: ExtensionAssociation
- data CreateHostedConfigurationVersion = CreateHostedConfigurationVersion' (Maybe Text) (Maybe Int) Text Text (Sensitive ByteString) Text
- newCreateHostedConfigurationVersion :: Text -> Text -> ByteString -> Text -> CreateHostedConfigurationVersion
- data HostedConfigurationVersion = HostedConfigurationVersion' (Maybe Text) (Maybe Text) (Maybe (Sensitive ByteString)) (Maybe Text) (Maybe Text) (Maybe Int)
- newHostedConfigurationVersion :: HostedConfigurationVersion
- data DeleteApplication = DeleteApplication' Text
- newDeleteApplication :: Text -> DeleteApplication
- data DeleteApplicationResponse = DeleteApplicationResponse' {
- newDeleteApplicationResponse :: DeleteApplicationResponse
- data DeleteConfigurationProfile = DeleteConfigurationProfile' Text Text
- newDeleteConfigurationProfile :: Text -> Text -> DeleteConfigurationProfile
- data DeleteConfigurationProfileResponse = DeleteConfigurationProfileResponse' {
- newDeleteConfigurationProfileResponse :: DeleteConfigurationProfileResponse
- data DeleteDeploymentStrategy = DeleteDeploymentStrategy' Text
- newDeleteDeploymentStrategy :: Text -> DeleteDeploymentStrategy
- data DeleteDeploymentStrategyResponse = DeleteDeploymentStrategyResponse' {
- newDeleteDeploymentStrategyResponse :: DeleteDeploymentStrategyResponse
- data DeleteEnvironment = DeleteEnvironment' Text Text
- newDeleteEnvironment :: Text -> Text -> DeleteEnvironment
- data DeleteEnvironmentResponse = DeleteEnvironmentResponse' {
- newDeleteEnvironmentResponse :: DeleteEnvironmentResponse
- data DeleteExtension = DeleteExtension' (Maybe Int) Text
- newDeleteExtension :: Text -> DeleteExtension
- data DeleteExtensionResponse = DeleteExtensionResponse' {
- newDeleteExtensionResponse :: DeleteExtensionResponse
- data DeleteExtensionAssociation = DeleteExtensionAssociation' Text
- newDeleteExtensionAssociation :: Text -> DeleteExtensionAssociation
- data DeleteExtensionAssociationResponse = DeleteExtensionAssociationResponse' {
- newDeleteExtensionAssociationResponse :: DeleteExtensionAssociationResponse
- data DeleteHostedConfigurationVersion = DeleteHostedConfigurationVersion' Text Text Int
- newDeleteHostedConfigurationVersion :: Text -> Text -> Int -> DeleteHostedConfigurationVersion
- data DeleteHostedConfigurationVersionResponse = DeleteHostedConfigurationVersionResponse' {
- newDeleteHostedConfigurationVersionResponse :: DeleteHostedConfigurationVersionResponse
- data GetApplication = GetApplication' Text
- newGetApplication :: Text -> GetApplication
- data Application = Application' (Maybe Text) (Maybe Text) (Maybe Text)
- newApplication :: Application
- data GetConfigurationProfile = GetConfigurationProfile' Text Text
- newGetConfigurationProfile :: Text -> Text -> GetConfigurationProfile
- data ConfigurationProfile = ConfigurationProfile' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Validator])
- newConfigurationProfile :: ConfigurationProfile
- data GetDeployment = GetDeployment' Text Text Int
- newGetDeployment :: Text -> Text -> Int -> GetDeployment
- data Deployment = Deployment' (Maybe Text) (Maybe [AppliedExtension]) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Double) (Maybe ISO8601) (Maybe DeploymentState)
- newDeployment :: Deployment
- data GetDeploymentStrategy = GetDeploymentStrategy' Text
- newGetDeploymentStrategy :: Text -> GetDeploymentStrategy
- data DeploymentStrategy = DeploymentStrategy' (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Text) (Maybe Text) (Maybe ReplicateTo)
- newDeploymentStrategy :: DeploymentStrategy
- data GetEnvironment = GetEnvironment' Text Text
- newGetEnvironment :: Text -> Text -> GetEnvironment
- data Environment = Environment' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Monitor]) (Maybe Text) (Maybe EnvironmentState)
- newEnvironment :: Environment
- data GetExtension = GetExtension' (Maybe Int) Text
- newGetExtension :: Text -> GetExtension
- data Extension = Extension' (Maybe (HashMap ActionPoint (NonEmpty Action))) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Parameter)) (Maybe Int)
- newExtension :: Extension
- data GetExtensionAssociation = GetExtensionAssociation' Text
- newGetExtensionAssociation :: Text -> GetExtensionAssociation
- data ExtensionAssociation = ExtensionAssociation' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text)
- newExtensionAssociation :: ExtensionAssociation
- data GetHostedConfigurationVersion = GetHostedConfigurationVersion' Text Text Int
- newGetHostedConfigurationVersion :: Text -> Text -> Int -> GetHostedConfigurationVersion
- data HostedConfigurationVersion = HostedConfigurationVersion' (Maybe Text) (Maybe Text) (Maybe (Sensitive ByteString)) (Maybe Text) (Maybe Text) (Maybe Int)
- newHostedConfigurationVersion :: HostedConfigurationVersion
- data ListApplications = ListApplications' (Maybe Natural) (Maybe Text)
- newListApplications :: ListApplications
- data ListApplicationsResponse = ListApplicationsResponse' (Maybe [Application]) (Maybe Text) Int
- newListApplicationsResponse :: Int -> ListApplicationsResponse
- data ListConfigurationProfiles = ListConfigurationProfiles' (Maybe Natural) (Maybe Text) (Maybe Text) Text
- newListConfigurationProfiles :: Text -> ListConfigurationProfiles
- data ListConfigurationProfilesResponse = ListConfigurationProfilesResponse' (Maybe [ConfigurationProfileSummary]) (Maybe Text) Int
- newListConfigurationProfilesResponse :: Int -> ListConfigurationProfilesResponse
- data ListDeploymentStrategies = ListDeploymentStrategies' (Maybe Natural) (Maybe Text)
- newListDeploymentStrategies :: ListDeploymentStrategies
- data ListDeploymentStrategiesResponse = ListDeploymentStrategiesResponse' (Maybe [DeploymentStrategy]) (Maybe Text) Int
- newListDeploymentStrategiesResponse :: Int -> ListDeploymentStrategiesResponse
- data ListDeployments = ListDeployments' (Maybe Natural) (Maybe Text) Text Text
- newListDeployments :: Text -> Text -> ListDeployments
- data ListDeploymentsResponse = ListDeploymentsResponse' (Maybe [DeploymentSummary]) (Maybe Text) Int
- newListDeploymentsResponse :: Int -> ListDeploymentsResponse
- data ListEnvironments = ListEnvironments' (Maybe Natural) (Maybe Text) Text
- newListEnvironments :: Text -> ListEnvironments
- data ListEnvironmentsResponse = ListEnvironmentsResponse' (Maybe [Environment]) (Maybe Text) Int
- newListEnvironmentsResponse :: Int -> ListEnvironmentsResponse
- data ListExtensionAssociations = ListExtensionAssociations' (Maybe Text) (Maybe Int) (Maybe Natural) (Maybe Text) (Maybe Text)
- newListExtensionAssociations :: ListExtensionAssociations
- data ListExtensionAssociationsResponse = ListExtensionAssociationsResponse' (Maybe [ExtensionAssociationSummary]) (Maybe Text) Int
- newListExtensionAssociationsResponse :: Int -> ListExtensionAssociationsResponse
- data ListExtensions = ListExtensions' (Maybe Natural) (Maybe Text) (Maybe Text)
- newListExtensions :: ListExtensions
- data ListExtensionsResponse = ListExtensionsResponse' (Maybe [ExtensionSummary]) (Maybe Text) Int
- newListExtensionsResponse :: Int -> ListExtensionsResponse
- data ListHostedConfigurationVersions = ListHostedConfigurationVersions' (Maybe Natural) (Maybe Text) Text Text
- newListHostedConfigurationVersions :: Text -> Text -> ListHostedConfigurationVersions
- data ListHostedConfigurationVersionsResponse = ListHostedConfigurationVersionsResponse' (Maybe [HostedConfigurationVersionSummary]) (Maybe Text) Int
- newListHostedConfigurationVersionsResponse :: Int -> ListHostedConfigurationVersionsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- 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 Text) (Maybe [AppliedExtension]) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Double) (Maybe ISO8601) (Maybe DeploymentState)
- newDeployment :: Deployment
- data StopDeployment = StopDeployment' Text Text Int
- newStopDeployment :: Text -> Text -> Int -> StopDeployment
- data Deployment = Deployment' (Maybe Text) (Maybe [AppliedExtension]) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Double) (Maybe ISO8601) (Maybe DeploymentState)
- newDeployment :: Deployment
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data UpdateApplication = UpdateApplication' (Maybe Text) (Maybe Text) Text
- newUpdateApplication :: Text -> UpdateApplication
- data Application = Application' (Maybe Text) (Maybe Text) (Maybe Text)
- newApplication :: Application
- data UpdateConfigurationProfile = UpdateConfigurationProfile' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Validator]) Text Text
- newUpdateConfigurationProfile :: Text -> Text -> UpdateConfigurationProfile
- data ConfigurationProfile = ConfigurationProfile' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Validator])
- newConfigurationProfile :: ConfigurationProfile
- data UpdateDeploymentStrategy = UpdateDeploymentStrategy' (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Double) (Maybe GrowthType) Text
- newUpdateDeploymentStrategy :: Text -> UpdateDeploymentStrategy
- data DeploymentStrategy = DeploymentStrategy' (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Text) (Maybe Text) (Maybe ReplicateTo)
- newDeploymentStrategy :: DeploymentStrategy
- data UpdateEnvironment = UpdateEnvironment' (Maybe Text) (Maybe [Monitor]) (Maybe Text) Text Text
- newUpdateEnvironment :: Text -> Text -> UpdateEnvironment
- data Environment = Environment' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Monitor]) (Maybe Text) (Maybe EnvironmentState)
- newEnvironment :: Environment
- data UpdateExtension = UpdateExtension' (Maybe (HashMap ActionPoint (NonEmpty Action))) (Maybe Text) (Maybe (HashMap Text Parameter)) (Maybe Int) Text
- newUpdateExtension :: Text -> UpdateExtension
- data Extension = Extension' (Maybe (HashMap ActionPoint (NonEmpty Action))) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Parameter)) (Maybe Int)
- newExtension :: Extension
- data UpdateExtensionAssociation = UpdateExtensionAssociation' (Maybe (HashMap Text Text)) Text
- newUpdateExtensionAssociation :: Text -> UpdateExtensionAssociation
- data ExtensionAssociation = ExtensionAssociation' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text)
- newExtensionAssociation :: ExtensionAssociation
- data ValidateConfiguration = ValidateConfiguration' Text Text Text
- newValidateConfiguration :: Text -> Text -> Text -> ValidateConfiguration
- data ValidateConfigurationResponse = ValidateConfigurationResponse' {
- newValidateConfigurationResponse :: ValidateConfigurationResponse
- newtype ActionPoint where
- ActionPoint' { }
- pattern ActionPoint_ON_DEPLOYMENT_BAKING :: ActionPoint
- pattern ActionPoint_ON_DEPLOYMENT_COMPLETE :: ActionPoint
- pattern ActionPoint_ON_DEPLOYMENT_ROLLED_BACK :: ActionPoint
- pattern ActionPoint_ON_DEPLOYMENT_START :: ActionPoint
- pattern ActionPoint_ON_DEPLOYMENT_STEP :: ActionPoint
- pattern ActionPoint_PRE_CREATE_HOSTED_CONFIGURATION_VERSION :: ActionPoint
- pattern ActionPoint_PRE_START_DEPLOYMENT :: ActionPoint
- 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 Action = Action' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newAction :: Action
- data ActionInvocation = ActionInvocation' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newActionInvocation :: ActionInvocation
- data Application = Application' (Maybe Text) (Maybe Text) (Maybe Text)
- newApplication :: Application
- data AppliedExtension = AppliedExtension' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Int)
- newAppliedExtension :: AppliedExtension
- data ConfigurationProfile = ConfigurationProfile' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Validator])
- newConfigurationProfile :: ConfigurationProfile
- data ConfigurationProfileSummary = ConfigurationProfileSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [ValidatorType])
- newConfigurationProfileSummary :: ConfigurationProfileSummary
- data Deployment = Deployment' (Maybe Text) (Maybe [AppliedExtension]) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Double) (Maybe ISO8601) (Maybe DeploymentState)
- newDeployment :: Deployment
- data DeploymentEvent = DeploymentEvent' (Maybe [ActionInvocation]) (Maybe Text) (Maybe DeploymentEventType) (Maybe ISO8601) (Maybe TriggeredBy)
- newDeploymentEvent :: DeploymentEvent
- data DeploymentStrategy = DeploymentStrategy' (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Text) (Maybe Text) (Maybe ReplicateTo)
- newDeploymentStrategy :: DeploymentStrategy
- data DeploymentSummary = DeploymentSummary' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Int) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Double) (Maybe ISO8601) (Maybe DeploymentState)
- newDeploymentSummary :: DeploymentSummary
- data Environment = Environment' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Monitor]) (Maybe Text) (Maybe EnvironmentState)
- newEnvironment :: Environment
- data Extension = Extension' (Maybe (HashMap ActionPoint (NonEmpty Action))) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Parameter)) (Maybe Int)
- newExtension :: Extension
- data ExtensionAssociation = ExtensionAssociation' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text)
- newExtensionAssociation :: ExtensionAssociation
- data ExtensionAssociationSummary = ExtensionAssociationSummary' (Maybe Text) (Maybe Text) (Maybe Text)
- newExtensionAssociationSummary :: ExtensionAssociationSummary
- data ExtensionSummary = ExtensionSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int)
- newExtensionSummary :: ExtensionSummary
- data HostedConfigurationVersion = HostedConfigurationVersion' (Maybe Text) (Maybe Text) (Maybe (Sensitive ByteString)) (Maybe Text) (Maybe Text) (Maybe Int)
- newHostedConfigurationVersion :: HostedConfigurationVersion
- data HostedConfigurationVersionSummary = HostedConfigurationVersionSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int)
- newHostedConfigurationVersionSummary :: HostedConfigurationVersionSummary
- data Monitor = Monitor' (Maybe Text) Text
- newMonitor :: Text -> Monitor
- data Parameter = Parameter' (Maybe Text) (Maybe Bool)
- newParameter :: Parameter
- 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.
BadRequestException
_BadRequestException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an Amazon Web Services service.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The request could not be processed because of conflict in the current state of the resource.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
There was an internal failure in the AppConfig service.
PayloadTooLargeException
_PayloadTooLargeException :: AsError a => Fold a ServiceError Source #
The configuration size is too large.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource could not be found.
ServiceQuotaExceededException
_ServiceQuotaExceededException :: AsError a => Fold a ServiceError Source #
The number of hosted configuration versions exceeds the limit for the AppConfig hosted configuration store. Delete one or more versions and try again.
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.
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:
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.
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:description:Application', application_description - The description of the application.
$sel:id:Application', application_id - The application ID.
$sel:name:Application', application_name - The application name.
CreateConfigurationProfile
data CreateConfigurationProfile Source #
See: newCreateConfigurationProfile smart constructor.
Constructors
| CreateConfigurationProfile' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Validator]) 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:
CreateConfigurationProfile, createConfigurationProfile_description - A description of the configuration profile.
CreateConfigurationProfile, createConfigurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration.
$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.
CreateConfigurationProfile, createConfigurationProfile_type - The type of configurations contained in the profile. AppConfig supports
feature flags and freeform configurations. We recommend you create
feature flag configurations to enable or disable new features and
freeform configurations to distribute configurations to an application.
When calling this API, enter one of the following values for Type:
AWS.AppConfig.FeatureFlags
AWS.Freeform
CreateConfigurationProfile, createConfigurationProfile_validators - A list of methods for validating the configuration.
CreateConfigurationProfile, createConfigurationProfile_applicationId - The application ID.
CreateConfigurationProfile, createConfigurationProfile_name - A name for the configuration profile.
CreateConfigurationProfile, createConfigurationProfile_locationUri - A URI to locate the configuration. You can specify the AppConfig hosted
configuration store, Systems Manager (SSM) document, an SSM Parameter
Store parameter, or an Amazon S3 object. For the hosted configuration
store and for feature flags, specify hosted. 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 Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Validator]) |
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:applicationId:ConfigurationProfile', configurationProfile_applicationId - The application ID.
$sel:description:ConfigurationProfile', configurationProfile_description - The configuration profile description.
$sel:id:ConfigurationProfile', configurationProfile_id - The configuration profile ID.
$sel:locationUri:ConfigurationProfile', configurationProfile_locationUri - The URI location of the configuration.
$sel:name:ConfigurationProfile', configurationProfile_name - The name of the configuration profile.
$sel:retrievalRoleArn:ConfigurationProfile', configurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
ConfigurationProfile, configurationProfile_type - The type of configurations contained in the profile. AppConfig supports
feature flags and freeform configurations. We recommend you create
feature flag configurations to enable or disable new features and
freeform configurations to distribute configurations to an application.
When calling this API, enter one of the following values for Type:
AWS.AppConfig.FeatureFlags
AWS.Freeform
$sel:validators:ConfigurationProfile', configurationProfile_validators - A list of methods for validating the configuration.
CreateDeploymentStrategy
data CreateDeploymentStrategy Source #
See: newCreateDeploymentStrategy smart constructor.
Constructors
| CreateDeploymentStrategy' (Maybe Text) (Maybe Natural) (Maybe GrowthType) (Maybe ReplicateTo) (Maybe (HashMap Text Text)) Text Natural Double |
Instances
newCreateDeploymentStrategy Source #
Arguments
| :: Text | |
| -> Natural | |
| -> Double | |
| -> CreateDeploymentStrategy |
Create a value of CreateDeploymentStrategy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDeploymentStrategy, createDeploymentStrategy_description - A description of the deployment strategy.
CreateDeploymentStrategy, createDeploymentStrategy_finalBakeTimeInMinutes - Specifies the amount of time AppConfig monitors for Amazon CloudWatch
alarms after the configuration has been deployed to 100% of its targets,
before considering the deployment to be complete. If an alarm is
triggered during this time, AppConfig rolls back the deployment. You
must configure permissions for AppConfig to roll back based on
CloudWatch alarms. For more information, see
Configuring permissions for rollback based on Amazon CloudWatch alarms
in the AppConfig User Guide.
CreateDeploymentStrategy, createDeploymentStrategy_growthType - The algorithm used to define how percentage grows over time. AppConfig
supports the following growth types:
Linear: For this type, AppConfig processes the deployment by
dividing the total number of targets by the value specified for
Step percentage. For example, a linear deployment that uses a
Step percentage of 10 deploys the configuration to 10 percent of the
hosts. After those deployments are complete, the system deploys the
configuration to the next 10 percent. This continues until 100% of the
targets have successfully received the configuration.
Exponential: For this type, AppConfig processes the deployment
exponentially using the following formula: G*(2^N). In this formula,
G is the growth factor specified by the user and N is the number of
steps until the configuration is deployed to all targets. For example,
if you specify a growth factor of 2, then the system rolls out the
configuration as follows:
2*(2^0)
2*(2^1)
2*(2^2)
Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.
CreateDeploymentStrategy, createDeploymentStrategy_replicateTo - Save the deployment strategy to a Systems Manager (SSM) document.
$sel:tags:CreateDeploymentStrategy', createDeploymentStrategy_tags - Metadata to assign to the deployment strategy. Tags help organize and
categorize your AppConfig resources. Each tag consists of a key and an
optional value, both of which you define.
CreateDeploymentStrategy, createDeploymentStrategy_name - A name for the deployment strategy.
CreateDeploymentStrategy, createDeploymentStrategy_deploymentDurationInMinutes - Total amount of time for a deployment to last.
CreateDeploymentStrategy, createDeploymentStrategy_growthFactor - The percentage of targets to receive a deployed configuration during
each interval.
data DeploymentStrategy Source #
See: newDeploymentStrategy smart constructor.
Constructors
| DeploymentStrategy' (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Text) (Maybe Text) (Maybe ReplicateTo) |
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:deploymentDurationInMinutes:DeploymentStrategy', deploymentStrategy_deploymentDurationInMinutes - Total amount of time the deployment lasted.
$sel:description:DeploymentStrategy', deploymentStrategy_description - The description of the deployment strategy.
$sel:finalBakeTimeInMinutes:DeploymentStrategy', deploymentStrategy_finalBakeTimeInMinutes - The amount of time that AppConfig monitored for alarms before
considering the deployment to be complete and no longer eligible for
automatic rollback.
$sel:growthFactor:DeploymentStrategy', deploymentStrategy_growthFactor - The percentage of targets that received a deployed configuration during
each interval.
$sel:growthType:DeploymentStrategy', deploymentStrategy_growthType - The algorithm used to define how percentage grew over time.
$sel:id:DeploymentStrategy', deploymentStrategy_id - The deployment strategy ID.
$sel:name:DeploymentStrategy', deploymentStrategy_name - The name of the deployment strategy.
$sel:replicateTo:DeploymentStrategy', deploymentStrategy_replicateTo - Save the deployment strategy to a Systems Manager (SSM) document.
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:
CreateEnvironment, createEnvironment_description - A description of the environment.
CreateEnvironment, createEnvironment_monitors - Amazon CloudWatch alarms to monitor during the deployment process.
$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.
CreateEnvironment, createEnvironment_applicationId - The application ID.
CreateEnvironment, createEnvironment_name - A name for the environment.
data Environment Source #
See: newEnvironment smart constructor.
Constructors
| Environment' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Monitor]) (Maybe Text) (Maybe EnvironmentState) |
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:applicationId:Environment', environment_applicationId - The application ID.
$sel:description:Environment', environment_description - The description of the environment.
$sel:id:Environment', environment_id - The environment ID.
$sel:monitors:Environment', environment_monitors - Amazon CloudWatch alarms monitored during the deployment.
$sel:name:Environment', environment_name - The name of the environment.
$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
CreateExtension
data CreateExtension Source #
See: newCreateExtension smart constructor.
Constructors
| CreateExtension' (Maybe Text) (Maybe Int) (Maybe (HashMap Text Parameter)) (Maybe (HashMap Text Text)) Text (HashMap ActionPoint (NonEmpty Action)) |
Instances
Arguments
| :: Text | |
| -> CreateExtension |
Create a value of CreateExtension 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:
CreateExtension, createExtension_description - Information about the extension.
$sel:latestVersionNumber:CreateExtension', createExtension_latestVersionNumber - You can omit this field when you create an extension. When you create a
new version, specify the most recent current version number. For
example, you create version 3, enter 2 for this field.
CreateExtension, createExtension_parameters - The parameters accepted by the extension. You specify parameter values
when you associate the extension to an AppConfig resource by using the
CreateExtensionAssociation API action. For Lambda extension actions,
these parameters are included in the Lambda request object.
$sel:tags:CreateExtension', createExtension_tags - Adds one or more tags for the specified extension. Tags are metadata
that help you categorize resources in different ways, for example, by
purpose, owner, or environment. Each tag consists of a key and an
optional value, both of which you define.
CreateExtension, createExtension_name - A name for the extension. Each extension name in your account must be
unique. Extension versions use the same name.
CreateExtension, createExtension_actions - The actions defined in the extension.
See: newExtension smart constructor.
Constructors
| Extension' (Maybe (HashMap ActionPoint (NonEmpty Action))) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Parameter)) (Maybe Int) |
Instances
newExtension :: Extension Source #
Create a value of Extension 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:actions:Extension', extension_actions - The actions defined in the extension.
$sel:arn:Extension', extension_arn - The system-generated Amazon Resource Name (ARN) for the extension.
Extension, extension_description - Information about the extension.
$sel:id:Extension', extension_id - The system-generated ID of the extension.
Extension, extension_name - The extension name.
$sel:parameters:Extension', extension_parameters - The parameters accepted by the extension. You specify parameter values
when you associate the extension to an AppConfig resource by using the
CreateExtensionAssociation API action. For Lambda extension actions,
these parameters are included in the Lambda request object.
$sel:versionNumber:Extension', extension_versionNumber - The extension version number.
CreateExtensionAssociation
data CreateExtensionAssociation Source #
See: newCreateExtensionAssociation smart constructor.
Constructors
| CreateExtensionAssociation' (Maybe Int) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Text Text |
Instances
newCreateExtensionAssociation Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateExtensionAssociation |
Create a value of CreateExtensionAssociation 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:
CreateExtensionAssociation, createExtensionAssociation_extensionVersionNumber - The version number of the extension. If not specified, AppConfig uses
the maximum version of the extension.
CreateExtensionAssociation, createExtensionAssociation_parameters - The parameter names and values defined in the extensions. Extension
parameters marked Required must be entered for this field.
$sel:tags:CreateExtensionAssociation', createExtensionAssociation_tags - Adds one or more tags for the specified extension association. Tags are
metadata that help you categorize resources in different ways, for
example, by purpose, owner, or environment. Each tag consists of a key
and an optional value, both of which you define.
CreateExtensionAssociation, createExtensionAssociation_extensionIdentifier - The name, the ID, or the Amazon Resource Name (ARN) of the extension.
$sel:resourceIdentifier:CreateExtensionAssociation', createExtensionAssociation_resourceIdentifier - The ARN of an application, configuration profile, or environment.
data ExtensionAssociation Source #
See: newExtensionAssociation smart constructor.
Constructors
| ExtensionAssociation' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) |
Instances
newExtensionAssociation :: ExtensionAssociation Source #
Create a value of ExtensionAssociation 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:arn:ExtensionAssociation', extensionAssociation_arn - The system-generated Amazon Resource Name (ARN) for the extension.
$sel:extensionArn:ExtensionAssociation', extensionAssociation_extensionArn - The ARN of the extension defined in the association.
$sel:extensionVersionNumber:ExtensionAssociation', extensionAssociation_extensionVersionNumber - The version number for the extension defined in the association.
$sel:id:ExtensionAssociation', extensionAssociation_id - The system-generated ID for the association.
$sel:parameters:ExtensionAssociation', extensionAssociation_parameters - The parameter names and values defined in the association.
$sel:resourceArn:ExtensionAssociation', extensionAssociation_resourceArn - The ARNs of applications, configuration profiles, or environments
defined in the association.
CreateHostedConfigurationVersion
data CreateHostedConfigurationVersion Source #
See: newCreateHostedConfigurationVersion smart constructor.
Constructors
| CreateHostedConfigurationVersion' (Maybe Text) (Maybe Int) 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:
CreateHostedConfigurationVersion, createHostedConfigurationVersion_description - A description of the configuration.
$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 number of the latest
hosted configuration version.
CreateHostedConfigurationVersion, createHostedConfigurationVersion_applicationId - The application ID.
CreateHostedConfigurationVersion, createHostedConfigurationVersion_configurationProfileId - The configuration profile ID.
CreateHostedConfigurationVersion, createHostedConfigurationVersion_content - The content of the configuration or the configuration data.
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 Text) (Maybe Text) (Maybe (Sensitive ByteString)) (Maybe Text) (Maybe Text) (Maybe Int) |
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:applicationId:HostedConfigurationVersion', hostedConfigurationVersion_applicationId - The application ID.
$sel:configurationProfileId:HostedConfigurationVersion', hostedConfigurationVersion_configurationProfileId - The configuration profile ID.
$sel:content:HostedConfigurationVersion', hostedConfigurationVersion_content - The content of the configuration or the configuration data.
$sel:contentType:HostedConfigurationVersion', hostedConfigurationVersion_contentType - A standard MIME type describing the format of the configuration content.
For more information, see
Content-Type.
$sel:description:HostedConfigurationVersion', hostedConfigurationVersion_description - A description of the configuration.
$sel:versionNumber:HostedConfigurationVersion', hostedConfigurationVersion_versionNumber - The configuration version.
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:
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.
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:
DeleteConfigurationProfile, deleteConfigurationProfile_applicationId - The application ID that includes the configuration profile you want to
delete.
DeleteConfigurationProfile, deleteConfigurationProfile_configurationProfileId - The ID of the configuration profile you want to delete.
data DeleteConfigurationProfileResponse Source #
See: newDeleteConfigurationProfileResponse smart constructor.
Constructors
| DeleteConfigurationProfileResponse' | |
Instances
| Generic DeleteConfigurationProfileResponse Source # | |
Defined in Amazonka.AppConfig.DeleteConfigurationProfile Associated Types type Rep DeleteConfigurationProfileResponse :: Type -> Type # | |
| Read DeleteConfigurationProfileResponse Source # | |
| Show DeleteConfigurationProfileResponse Source # | |
Defined in Amazonka.AppConfig.DeleteConfigurationProfile Methods showsPrec :: Int -> DeleteConfigurationProfileResponse -> ShowS # | |
| NFData DeleteConfigurationProfileResponse Source # | |
Defined in Amazonka.AppConfig.DeleteConfigurationProfile Methods rnf :: DeleteConfigurationProfileResponse -> () # | |
| Eq DeleteConfigurationProfileResponse Source # | |
| type Rep DeleteConfigurationProfileResponse Source # | |
newDeleteConfigurationProfileResponse :: DeleteConfigurationProfileResponse Source #
Create a value of DeleteConfigurationProfileResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteDeploymentStrategy
data DeleteDeploymentStrategy Source #
See: newDeleteDeploymentStrategy smart constructor.
Constructors
| DeleteDeploymentStrategy' Text |
Instances
newDeleteDeploymentStrategy Source #
Arguments
| :: Text | |
| -> DeleteDeploymentStrategy |
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:
DeleteDeploymentStrategy, deleteDeploymentStrategy_deploymentStrategyId - The ID of the deployment strategy you want to delete.
data DeleteDeploymentStrategyResponse Source #
See: newDeleteDeploymentStrategyResponse smart constructor.
Constructors
| DeleteDeploymentStrategyResponse' | |
Instances
| Generic DeleteDeploymentStrategyResponse Source # | |
Defined in Amazonka.AppConfig.DeleteDeploymentStrategy Associated Types type Rep DeleteDeploymentStrategyResponse :: Type -> Type # | |
| Read DeleteDeploymentStrategyResponse Source # | |
| Show DeleteDeploymentStrategyResponse Source # | |
Defined in Amazonka.AppConfig.DeleteDeploymentStrategy Methods showsPrec :: Int -> DeleteDeploymentStrategyResponse -> ShowS # | |
| NFData DeleteDeploymentStrategyResponse Source # | |
Defined in Amazonka.AppConfig.DeleteDeploymentStrategy Methods rnf :: DeleteDeploymentStrategyResponse -> () # | |
| Eq DeleteDeploymentStrategyResponse Source # | |
| 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.
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:
DeleteEnvironment, deleteEnvironment_applicationId - The application ID that includes the environment that you want to
delete.
DeleteEnvironment, deleteEnvironment_environmentId - The ID of the environment that 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.
DeleteExtension
data DeleteExtension Source #
See: newDeleteExtension smart constructor.
Constructors
| DeleteExtension' (Maybe Int) Text |
Instances
Arguments
| :: Text | |
| -> DeleteExtension |
Create a value of DeleteExtension 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:
DeleteExtension, deleteExtension_versionNumber - A specific version of an extension to delete. If omitted, the highest
version is deleted.
DeleteExtension, deleteExtension_extensionIdentifier - The name, ID, or Amazon Resource Name (ARN) of the extension you want to
delete.
data DeleteExtensionResponse Source #
See: newDeleteExtensionResponse smart constructor.
Constructors
| DeleteExtensionResponse' | |
Instances
newDeleteExtensionResponse :: DeleteExtensionResponse Source #
Create a value of DeleteExtensionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteExtensionAssociation
data DeleteExtensionAssociation Source #
See: newDeleteExtensionAssociation smart constructor.
Constructors
| DeleteExtensionAssociation' Text |
Instances
newDeleteExtensionAssociation Source #
Arguments
| :: Text | |
| -> DeleteExtensionAssociation |
Create a value of DeleteExtensionAssociation 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:
DeleteExtensionAssociation, deleteExtensionAssociation_extensionAssociationId - The ID of the extension association to delete.
data DeleteExtensionAssociationResponse Source #
See: newDeleteExtensionAssociationResponse smart constructor.
Constructors
| DeleteExtensionAssociationResponse' | |
Instances
| Generic DeleteExtensionAssociationResponse Source # | |
Defined in Amazonka.AppConfig.DeleteExtensionAssociation Associated Types type Rep DeleteExtensionAssociationResponse :: Type -> Type # | |
| Read DeleteExtensionAssociationResponse Source # | |
| Show DeleteExtensionAssociationResponse Source # | |
Defined in Amazonka.AppConfig.DeleteExtensionAssociation Methods showsPrec :: Int -> DeleteExtensionAssociationResponse -> ShowS # | |
| NFData DeleteExtensionAssociationResponse Source # | |
Defined in Amazonka.AppConfig.DeleteExtensionAssociation Methods rnf :: DeleteExtensionAssociationResponse -> () # | |
| Eq DeleteExtensionAssociationResponse Source # | |
| type Rep DeleteExtensionAssociationResponse Source # | |
newDeleteExtensionAssociationResponse :: DeleteExtensionAssociationResponse Source #
Create a value of DeleteExtensionAssociationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
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:
DeleteHostedConfigurationVersion, deleteHostedConfigurationVersion_applicationId - The application ID.
DeleteHostedConfigurationVersion, deleteHostedConfigurationVersion_configurationProfileId - The configuration profile ID.
DeleteHostedConfigurationVersion, deleteHostedConfigurationVersion_versionNumber - The versions number to delete.
data DeleteHostedConfigurationVersionResponse Source #
See: newDeleteHostedConfigurationVersionResponse smart constructor.
Constructors
| DeleteHostedConfigurationVersionResponse' | |
Instances
| Generic DeleteHostedConfigurationVersionResponse Source # | |
Defined in Amazonka.AppConfig.DeleteHostedConfigurationVersion Associated Types type Rep DeleteHostedConfigurationVersionResponse :: Type -> Type # | |
| Read DeleteHostedConfigurationVersionResponse Source # | |
| Show DeleteHostedConfigurationVersionResponse Source # | |
| NFData DeleteHostedConfigurationVersionResponse Source # | |
Defined in Amazonka.AppConfig.DeleteHostedConfigurationVersion Methods rnf :: DeleteHostedConfigurationVersionResponse -> () # | |
| Eq DeleteHostedConfigurationVersionResponse Source # | |
| type Rep DeleteHostedConfigurationVersionResponse Source # | |
Defined in Amazonka.AppConfig.DeleteHostedConfigurationVersion type Rep DeleteHostedConfigurationVersionResponse = D1 ('MetaData "DeleteHostedConfigurationVersionResponse" "Amazonka.AppConfig.DeleteHostedConfigurationVersion" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" '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.
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:
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:description:Application', application_description - The description of the application.
$sel:id:Application', application_id - The application ID.
$sel:name:Application', application_name - The application name.
GetConfigurationProfile
data GetConfigurationProfile Source #
See: newGetConfigurationProfile smart constructor.
Constructors
| GetConfigurationProfile' Text Text |
Instances
newGetConfigurationProfile Source #
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:
GetConfigurationProfile, getConfigurationProfile_applicationId - The ID of the application that includes the configuration profile you
want to get.
GetConfigurationProfile, getConfigurationProfile_configurationProfileId - The ID of the configuration profile that you want to get.
data ConfigurationProfile Source #
See: newConfigurationProfile smart constructor.
Constructors
| ConfigurationProfile' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Validator]) |
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:applicationId:ConfigurationProfile', configurationProfile_applicationId - The application ID.
$sel:description:ConfigurationProfile', configurationProfile_description - The configuration profile description.
$sel:id:ConfigurationProfile', configurationProfile_id - The configuration profile ID.
$sel:locationUri:ConfigurationProfile', configurationProfile_locationUri - The URI location of the configuration.
$sel:name:ConfigurationProfile', configurationProfile_name - The name of the configuration profile.
$sel:retrievalRoleArn:ConfigurationProfile', configurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
ConfigurationProfile, configurationProfile_type - The type of configurations contained in the profile. AppConfig supports
feature flags and freeform configurations. We recommend you create
feature flag configurations to enable or disable new features and
freeform configurations to distribute configurations to an application.
When calling this API, enter one of the following values for Type:
AWS.AppConfig.FeatureFlags
AWS.Freeform
$sel:validators:ConfigurationProfile', configurationProfile_validators - A list of methods for validating the configuration.
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:
GetDeployment, getDeployment_applicationId - The ID of the application that includes the deployment you want to get.
GetDeployment, getDeployment_environmentId - The ID of the environment that includes the deployment you want to get.
GetDeployment, getDeployment_deploymentNumber - The sequence number of the deployment.
data Deployment Source #
See: newDeployment smart constructor.
Constructors
| Deployment' (Maybe Text) (Maybe [AppliedExtension]) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Double) (Maybe ISO8601) (Maybe DeploymentState) |
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:applicationId:Deployment', deployment_applicationId - The ID of the application that was deployed.
$sel:appliedExtensions:Deployment', deployment_appliedExtensions - A list of extensions that were processed as part of the deployment. The
extensions that were previously associated to the configuration profile,
environment, or the application when StartDeployment was called.
$sel:completedAt:Deployment', deployment_completedAt - The time the deployment completed.
$sel:configurationLocationUri:Deployment', deployment_configurationLocationUri - Information about the source location of the configuration.
$sel:configurationName:Deployment', deployment_configurationName - The name of the configuration.
$sel:configurationProfileId:Deployment', deployment_configurationProfileId - The ID of the configuration profile that was deployed.
$sel:configurationVersion:Deployment', deployment_configurationVersion - The configuration version that was deployed.
$sel:deploymentDurationInMinutes:Deployment', deployment_deploymentDurationInMinutes - Total amount of time the deployment lasted.
$sel:deploymentNumber:Deployment', deployment_deploymentNumber - The sequence number of the deployment.
$sel:deploymentStrategyId:Deployment', deployment_deploymentStrategyId - The ID of the deployment strategy that was deployed.
Deployment, deployment_description - The description of the deployment.
$sel:environmentId:Deployment', deployment_environmentId - The ID of the environment 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:finalBakeTimeInMinutes:Deployment', deployment_finalBakeTimeInMinutes - The amount of time that AppConfig monitored for alarms before
considering the deployment to be complete and no longer eligible for
automatic rollback.
$sel:growthFactor:Deployment', deployment_growthFactor - The percentage of targets to receive a deployed configuration during
each interval.
$sel:growthType:Deployment', deployment_growthType - The algorithm used to define how percentage grew over time.
$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:state:Deployment', deployment_state - The state of the deployment.
GetDeploymentStrategy
data GetDeploymentStrategy Source #
See: newGetDeploymentStrategy smart constructor.
Constructors
| GetDeploymentStrategy' Text |
Instances
newGetDeploymentStrategy Source #
Arguments
| :: Text | |
| -> GetDeploymentStrategy |
Create a value of GetDeploymentStrategy with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDeploymentStrategy, getDeploymentStrategy_deploymentStrategyId - The ID of the deployment strategy to get.
data DeploymentStrategy Source #
See: newDeploymentStrategy smart constructor.
Constructors
| DeploymentStrategy' (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Text) (Maybe Text) (Maybe ReplicateTo) |
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:deploymentDurationInMinutes:DeploymentStrategy', deploymentStrategy_deploymentDurationInMinutes - Total amount of time the deployment lasted.
$sel:description:DeploymentStrategy', deploymentStrategy_description - The description of the deployment strategy.
$sel:finalBakeTimeInMinutes:DeploymentStrategy', deploymentStrategy_finalBakeTimeInMinutes - The amount of time that AppConfig monitored for alarms before
considering the deployment to be complete and no longer eligible for
automatic rollback.
$sel:growthFactor:DeploymentStrategy', deploymentStrategy_growthFactor - The percentage of targets that received a deployed configuration during
each interval.
$sel:growthType:DeploymentStrategy', deploymentStrategy_growthType - The algorithm used to define how percentage grew over time.
$sel:id:DeploymentStrategy', deploymentStrategy_id - The deployment strategy ID.
$sel:name:DeploymentStrategy', deploymentStrategy_name - The name of the deployment strategy.
$sel:replicateTo:DeploymentStrategy', deploymentStrategy_replicateTo - Save the deployment strategy to a Systems Manager (SSM) document.
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:
GetEnvironment, getEnvironment_applicationId - The ID of the application that includes the environment you want to get.
GetEnvironment, getEnvironment_environmentId - The ID of the environment that you want to get.
data Environment Source #
See: newEnvironment smart constructor.
Constructors
| Environment' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Monitor]) (Maybe Text) (Maybe EnvironmentState) |
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:applicationId:Environment', environment_applicationId - The application ID.
$sel:description:Environment', environment_description - The description of the environment.
$sel:id:Environment', environment_id - The environment ID.
$sel:monitors:Environment', environment_monitors - Amazon CloudWatch alarms monitored during the deployment.
$sel:name:Environment', environment_name - The name of the environment.
$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
GetExtension
data GetExtension Source #
See: newGetExtension smart constructor.
Constructors
| GetExtension' (Maybe Int) Text |
Instances
Arguments
| :: Text | |
| -> GetExtension |
Create a value of GetExtension 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:
GetExtension, getExtension_versionNumber - The extension version number. If no version number was defined,
AppConfig uses the highest version.
GetExtension, getExtension_extensionIdentifier - The name, the ID, or the Amazon Resource Name (ARN) of the extension.
See: newExtension smart constructor.
Constructors
| Extension' (Maybe (HashMap ActionPoint (NonEmpty Action))) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Parameter)) (Maybe Int) |
Instances
newExtension :: Extension Source #
Create a value of Extension 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:actions:Extension', extension_actions - The actions defined in the extension.
$sel:arn:Extension', extension_arn - The system-generated Amazon Resource Name (ARN) for the extension.
Extension, extension_description - Information about the extension.
$sel:id:Extension', extension_id - The system-generated ID of the extension.
Extension, extension_name - The extension name.
$sel:parameters:Extension', extension_parameters - The parameters accepted by the extension. You specify parameter values
when you associate the extension to an AppConfig resource by using the
CreateExtensionAssociation API action. For Lambda extension actions,
these parameters are included in the Lambda request object.
$sel:versionNumber:Extension', extension_versionNumber - The extension version number.
GetExtensionAssociation
data GetExtensionAssociation Source #
See: newGetExtensionAssociation smart constructor.
Constructors
| GetExtensionAssociation' Text |
Instances
newGetExtensionAssociation Source #
Arguments
| :: Text | |
| -> GetExtensionAssociation |
Create a value of GetExtensionAssociation 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:
GetExtensionAssociation, getExtensionAssociation_extensionAssociationId - The extension association ID to get.
data ExtensionAssociation Source #
See: newExtensionAssociation smart constructor.
Constructors
| ExtensionAssociation' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) |
Instances
newExtensionAssociation :: ExtensionAssociation Source #
Create a value of ExtensionAssociation 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:arn:ExtensionAssociation', extensionAssociation_arn - The system-generated Amazon Resource Name (ARN) for the extension.
$sel:extensionArn:ExtensionAssociation', extensionAssociation_extensionArn - The ARN of the extension defined in the association.
$sel:extensionVersionNumber:ExtensionAssociation', extensionAssociation_extensionVersionNumber - The version number for the extension defined in the association.
$sel:id:ExtensionAssociation', extensionAssociation_id - The system-generated ID for the association.
$sel:parameters:ExtensionAssociation', extensionAssociation_parameters - The parameter names and values defined in the association.
$sel:resourceArn:ExtensionAssociation', extensionAssociation_resourceArn - The ARNs of applications, configuration profiles, or environments
defined in the association.
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:
GetHostedConfigurationVersion, getHostedConfigurationVersion_applicationId - The application ID.
GetHostedConfigurationVersion, getHostedConfigurationVersion_configurationProfileId - The configuration profile ID.
GetHostedConfigurationVersion, getHostedConfigurationVersion_versionNumber - The version.
data HostedConfigurationVersion Source #
See: newHostedConfigurationVersion smart constructor.
Constructors
| HostedConfigurationVersion' (Maybe Text) (Maybe Text) (Maybe (Sensitive ByteString)) (Maybe Text) (Maybe Text) (Maybe Int) |
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:applicationId:HostedConfigurationVersion', hostedConfigurationVersion_applicationId - The application ID.
$sel:configurationProfileId:HostedConfigurationVersion', hostedConfigurationVersion_configurationProfileId - The configuration profile ID.
$sel:content:HostedConfigurationVersion', hostedConfigurationVersion_content - The content of the configuration or the configuration data.
$sel:contentType:HostedConfigurationVersion', hostedConfigurationVersion_contentType - A standard MIME type describing the format of the configuration content.
For more information, see
Content-Type.
$sel:description:HostedConfigurationVersion', hostedConfigurationVersion_description - A description of the configuration.
$sel:versionNumber:HostedConfigurationVersion', hostedConfigurationVersion_versionNumber - The configuration version.
ListApplications
data ListApplications Source #
See: newListApplications smart constructor.
Constructors
| ListApplications' (Maybe Natural) (Maybe Text) |
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: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.
ListApplications, listApplications_nextToken - A token to start the list. Next token is a pagination token generated by
AppConfig to describe what page the previous List call ended on. For the
first List request, the nextToken should not be set. On subsequent
calls, the nextToken parameter should be set to the previous responses
nextToken value. Use this token 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.
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.
ListConfigurationProfiles
data ListConfigurationProfiles Source #
See: newListConfigurationProfiles smart constructor.
Instances
newListConfigurationProfiles Source #
Arguments
| :: Text | |
| -> ListConfigurationProfiles |
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: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.
ListConfigurationProfiles, listConfigurationProfiles_nextToken - A token to start the list. Use this token to get the next set of
results.
ListConfigurationProfiles, listConfigurationProfiles_type - A filter based on the type of configurations that the configuration
profile contains. A configuration can be a feature flag or a freeform
configuration.
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.
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.
ListDeploymentStrategies
data ListDeploymentStrategies Source #
See: newListDeploymentStrategies smart constructor.
Constructors
| ListDeploymentStrategies' (Maybe Natural) (Maybe Text) |
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: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.
ListDeploymentStrategies, listDeploymentStrategies_nextToken - A token to start the list. Use this token 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.
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.
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:maxResults:ListDeployments', listDeployments_maxResults - The maximum number of items that may be returned for this call. If there
are items that have not yet been returned, the response will include a
non-null NextToken that you can provide in a subsequent call to get
the next set of results.
ListDeployments, listDeployments_nextToken - The token returned by a prior call to this operation indicating the next
set of results to be returned. If not specified, the operation will
return the first set of results.
ListDeployments, listDeployments_applicationId - The application ID.
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.
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.
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: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.
ListEnvironments, listEnvironments_nextToken - A token to start the list. Use this token to get the next set of
results.
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.
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.
ListExtensionAssociations
data ListExtensionAssociations Source #
See: newListExtensionAssociations smart constructor.
Constructors
| ListExtensionAssociations' (Maybe Text) (Maybe Int) (Maybe Natural) (Maybe Text) (Maybe Text) |
Instances
newListExtensionAssociations :: ListExtensionAssociations Source #
Create a value of ListExtensionAssociations 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:
ListExtensionAssociations, listExtensionAssociations_extensionIdentifier - The name, the ID, or the Amazon Resource Name (ARN) of the extension.
ListExtensionAssociations, listExtensionAssociations_extensionVersionNumber - The version number for the extension defined in the association.
$sel:maxResults:ListExtensionAssociations', listExtensionAssociations_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.
ListExtensionAssociations, listExtensionAssociations_nextToken - A token to start the list. Use this token to get the next set of results
or pass null to get the first set of results.
$sel:resourceIdentifier:ListExtensionAssociations', listExtensionAssociations_resourceIdentifier - The ARN of an application, configuration profile, or environment.
data ListExtensionAssociationsResponse Source #
See: newListExtensionAssociationsResponse smart constructor.
Constructors
| ListExtensionAssociationsResponse' (Maybe [ExtensionAssociationSummary]) (Maybe Text) Int |
Instances
newListExtensionAssociationsResponse Source #
Arguments
| :: Int | |
| -> ListExtensionAssociationsResponse |
Create a value of ListExtensionAssociationsResponse 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:ListExtensionAssociationsResponse', listExtensionAssociationsResponse_items - The list of extension associations. Each item represents an extension
association to an application, environment, or configuration profile.
ListExtensionAssociations, listExtensionAssociationsResponse_nextToken - The token for the next set of items to return. Use this token to get the
next set of results.
$sel:httpStatus:ListExtensionAssociationsResponse', listExtensionAssociationsResponse_httpStatus - The response's http status code.
ListExtensions
data ListExtensions Source #
See: newListExtensions smart constructor.
Instances
newListExtensions :: ListExtensions Source #
Create a value of ListExtensions 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:maxResults:ListExtensions', listExtensions_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.
ListExtensions, listExtensions_name - The extension name.
ListExtensions, listExtensions_nextToken - A token to start the list. Use this token to get the next set of
results.
data ListExtensionsResponse Source #
See: newListExtensionsResponse smart constructor.
Constructors
| ListExtensionsResponse' (Maybe [ExtensionSummary]) (Maybe Text) Int |
Instances
newListExtensionsResponse Source #
Create a value of ListExtensionsResponse 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:ListExtensionsResponse', listExtensionsResponse_items - The list of available extensions. The list includes Amazon Web
Services-authored and user-created extensions.
ListExtensions, listExtensionsResponse_nextToken - The token for the next set of items to return. Use this token to get the
next set of results.
$sel:httpStatus:ListExtensionsResponse', listExtensionsResponse_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: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.
ListHostedConfigurationVersions, listHostedConfigurationVersions_nextToken - A token to start the list. Use this token to get the next set of
results.
ListHostedConfigurationVersions, listHostedConfigurationVersions_applicationId - The application ID.
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.
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.
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:
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.
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:
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.
StartDeployment, startDeployment_applicationId - The application ID.
StartDeployment, startDeployment_environmentId - The environment ID.
StartDeployment, startDeployment_deploymentStrategyId - The deployment strategy ID.
StartDeployment, startDeployment_configurationProfileId - The configuration profile ID.
StartDeployment, startDeployment_configurationVersion - The configuration version to deploy.
data Deployment Source #
See: newDeployment smart constructor.
Constructors
| Deployment' (Maybe Text) (Maybe [AppliedExtension]) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Double) (Maybe ISO8601) (Maybe DeploymentState) |
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:applicationId:Deployment', deployment_applicationId - The ID of the application that was deployed.
$sel:appliedExtensions:Deployment', deployment_appliedExtensions - A list of extensions that were processed as part of the deployment. The
extensions that were previously associated to the configuration profile,
environment, or the application when StartDeployment was called.
$sel:completedAt:Deployment', deployment_completedAt - The time the deployment completed.
$sel:configurationLocationUri:Deployment', deployment_configurationLocationUri - Information about the source location of the configuration.
$sel:configurationName:Deployment', deployment_configurationName - The name of the configuration.
$sel:configurationProfileId:Deployment', deployment_configurationProfileId - The ID of the configuration profile that was deployed.
$sel:configurationVersion:Deployment', deployment_configurationVersion - The configuration version that was deployed.
$sel:deploymentDurationInMinutes:Deployment', deployment_deploymentDurationInMinutes - Total amount of time the deployment lasted.
$sel:deploymentNumber:Deployment', deployment_deploymentNumber - The sequence number of the deployment.
$sel:deploymentStrategyId:Deployment', deployment_deploymentStrategyId - The ID of the deployment strategy that was deployed.
Deployment, deployment_description - The description of the deployment.
$sel:environmentId:Deployment', deployment_environmentId - The ID of the environment 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:finalBakeTimeInMinutes:Deployment', deployment_finalBakeTimeInMinutes - The amount of time that AppConfig monitored for alarms before
considering the deployment to be complete and no longer eligible for
automatic rollback.
$sel:growthFactor:Deployment', deployment_growthFactor - The percentage of targets to receive a deployed configuration during
each interval.
$sel:growthType:Deployment', deployment_growthType - The algorithm used to define how percentage grew over time.
$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:state:Deployment', deployment_state - The state of the deployment.
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:
StopDeployment, stopDeployment_applicationId - The application ID.
StopDeployment, stopDeployment_environmentId - The environment ID.
StopDeployment, stopDeployment_deploymentNumber - The sequence number of the deployment.
data Deployment Source #
See: newDeployment smart constructor.
Constructors
| Deployment' (Maybe Text) (Maybe [AppliedExtension]) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Double) (Maybe ISO8601) (Maybe DeploymentState) |
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:applicationId:Deployment', deployment_applicationId - The ID of the application that was deployed.
$sel:appliedExtensions:Deployment', deployment_appliedExtensions - A list of extensions that were processed as part of the deployment. The
extensions that were previously associated to the configuration profile,
environment, or the application when StartDeployment was called.
$sel:completedAt:Deployment', deployment_completedAt - The time the deployment completed.
$sel:configurationLocationUri:Deployment', deployment_configurationLocationUri - Information about the source location of the configuration.
$sel:configurationName:Deployment', deployment_configurationName - The name of the configuration.
$sel:configurationProfileId:Deployment', deployment_configurationProfileId - The ID of the configuration profile that was deployed.
$sel:configurationVersion:Deployment', deployment_configurationVersion - The configuration version that was deployed.
$sel:deploymentDurationInMinutes:Deployment', deployment_deploymentDurationInMinutes - Total amount of time the deployment lasted.
$sel:deploymentNumber:Deployment', deployment_deploymentNumber - The sequence number of the deployment.
$sel:deploymentStrategyId:Deployment', deployment_deploymentStrategyId - The ID of the deployment strategy that was deployed.
Deployment, deployment_description - The description of the deployment.
$sel:environmentId:Deployment', deployment_environmentId - The ID of the environment 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:finalBakeTimeInMinutes:Deployment', deployment_finalBakeTimeInMinutes - The amount of time that AppConfig monitored for alarms before
considering the deployment to be complete and no longer eligible for
automatic rollback.
$sel:growthFactor:Deployment', deployment_growthFactor - The percentage of targets to receive a deployed configuration during
each interval.
$sel:growthType:Deployment', deployment_growthType - The algorithm used to define how percentage grew over time.
$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:state:Deployment', deployment_state - The state of the deployment.
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:
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.
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:
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.
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:
UpdateApplication, updateApplication_description - A description of the application.
UpdateApplication, updateApplication_name - The name of the application.
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:description:Application', application_description - The description of the application.
$sel:id:Application', application_id - The application ID.
$sel:name:Application', application_name - The application name.
UpdateConfigurationProfile
data UpdateConfigurationProfile Source #
See: newUpdateConfigurationProfile smart constructor.
Constructors
| UpdateConfigurationProfile' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Validator]) 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:
UpdateConfigurationProfile, updateConfigurationProfile_description - A description of the configuration profile.
UpdateConfigurationProfile, updateConfigurationProfile_name - The name of the configuration profile.
UpdateConfigurationProfile, updateConfigurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
UpdateConfigurationProfile, updateConfigurationProfile_validators - A list of methods for validating the configuration.
UpdateConfigurationProfile, updateConfigurationProfile_applicationId - The application ID.
UpdateConfigurationProfile, updateConfigurationProfile_configurationProfileId - The ID of the configuration profile.
data ConfigurationProfile Source #
See: newConfigurationProfile smart constructor.
Constructors
| ConfigurationProfile' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Validator]) |
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:applicationId:ConfigurationProfile', configurationProfile_applicationId - The application ID.
$sel:description:ConfigurationProfile', configurationProfile_description - The configuration profile description.
$sel:id:ConfigurationProfile', configurationProfile_id - The configuration profile ID.
$sel:locationUri:ConfigurationProfile', configurationProfile_locationUri - The URI location of the configuration.
$sel:name:ConfigurationProfile', configurationProfile_name - The name of the configuration profile.
$sel:retrievalRoleArn:ConfigurationProfile', configurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
ConfigurationProfile, configurationProfile_type - The type of configurations contained in the profile. AppConfig supports
feature flags and freeform configurations. We recommend you create
feature flag configurations to enable or disable new features and
freeform configurations to distribute configurations to an application.
When calling this API, enter one of the following values for Type:
AWS.AppConfig.FeatureFlags
AWS.Freeform
$sel:validators:ConfigurationProfile', configurationProfile_validators - A list of methods for validating the configuration.
UpdateDeploymentStrategy
data UpdateDeploymentStrategy Source #
See: newUpdateDeploymentStrategy smart constructor.
Constructors
| UpdateDeploymentStrategy' (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Double) (Maybe GrowthType) Text |
Instances
newUpdateDeploymentStrategy Source #
Arguments
| :: Text | |
| -> UpdateDeploymentStrategy |
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:
UpdateDeploymentStrategy, updateDeploymentStrategy_deploymentDurationInMinutes - Total amount of time for a deployment to last.
UpdateDeploymentStrategy, updateDeploymentStrategy_description - A description of the deployment strategy.
UpdateDeploymentStrategy, updateDeploymentStrategy_finalBakeTimeInMinutes - The amount of time that AppConfig monitors for alarms before considering
the deployment to be complete and no longer eligible for automatic
rollback.
UpdateDeploymentStrategy, updateDeploymentStrategy_growthFactor - The percentage of targets to receive a deployed configuration during
each interval.
UpdateDeploymentStrategy, updateDeploymentStrategy_growthType - The algorithm used to define how percentage grows over time. AppConfig
supports the following growth types:
Linear: For this type, AppConfig processes the deployment by 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.
UpdateDeploymentStrategy, updateDeploymentStrategy_deploymentStrategyId - The deployment strategy ID.
data DeploymentStrategy Source #
See: newDeploymentStrategy smart constructor.
Constructors
| DeploymentStrategy' (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Text) (Maybe Text) (Maybe ReplicateTo) |
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:deploymentDurationInMinutes:DeploymentStrategy', deploymentStrategy_deploymentDurationInMinutes - Total amount of time the deployment lasted.
$sel:description:DeploymentStrategy', deploymentStrategy_description - The description of the deployment strategy.
$sel:finalBakeTimeInMinutes:DeploymentStrategy', deploymentStrategy_finalBakeTimeInMinutes - The amount of time that AppConfig monitored for alarms before
considering the deployment to be complete and no longer eligible for
automatic rollback.
$sel:growthFactor:DeploymentStrategy', deploymentStrategy_growthFactor - The percentage of targets that received a deployed configuration during
each interval.
$sel:growthType:DeploymentStrategy', deploymentStrategy_growthType - The algorithm used to define how percentage grew over time.
$sel:id:DeploymentStrategy', deploymentStrategy_id - The deployment strategy ID.
$sel:name:DeploymentStrategy', deploymentStrategy_name - The name of the deployment strategy.
$sel:replicateTo:DeploymentStrategy', deploymentStrategy_replicateTo - Save the deployment strategy to a Systems Manager (SSM) document.
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:
UpdateEnvironment, updateEnvironment_description - A description of the environment.
UpdateEnvironment, updateEnvironment_monitors - Amazon CloudWatch alarms to monitor during the deployment process.
UpdateEnvironment, updateEnvironment_name - The name of the environment.
UpdateEnvironment, updateEnvironment_applicationId - The application ID.
UpdateEnvironment, updateEnvironment_environmentId - The environment ID.
data Environment Source #
See: newEnvironment smart constructor.
Constructors
| Environment' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Monitor]) (Maybe Text) (Maybe EnvironmentState) |
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:applicationId:Environment', environment_applicationId - The application ID.
$sel:description:Environment', environment_description - The description of the environment.
$sel:id:Environment', environment_id - The environment ID.
$sel:monitors:Environment', environment_monitors - Amazon CloudWatch alarms monitored during the deployment.
$sel:name:Environment', environment_name - The name of the environment.
$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
UpdateExtension
data UpdateExtension Source #
See: newUpdateExtension smart constructor.
Constructors
| UpdateExtension' (Maybe (HashMap ActionPoint (NonEmpty Action))) (Maybe Text) (Maybe (HashMap Text Parameter)) (Maybe Int) Text |
Instances
Arguments
| :: Text | |
| -> UpdateExtension |
Create a value of UpdateExtension 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:
UpdateExtension, updateExtension_actions - The actions defined in the extension.
UpdateExtension, updateExtension_description - Information about the extension.
UpdateExtension, updateExtension_parameters - One or more parameters for the actions called by the extension.
UpdateExtension, updateExtension_versionNumber - The extension version number.
UpdateExtension, updateExtension_extensionIdentifier - The name, the ID, or the Amazon Resource Name (ARN) of the extension.
See: newExtension smart constructor.
Constructors
| Extension' (Maybe (HashMap ActionPoint (NonEmpty Action))) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Parameter)) (Maybe Int) |
Instances
newExtension :: Extension Source #
Create a value of Extension 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:actions:Extension', extension_actions - The actions defined in the extension.
$sel:arn:Extension', extension_arn - The system-generated Amazon Resource Name (ARN) for the extension.
Extension, extension_description - Information about the extension.
$sel:id:Extension', extension_id - The system-generated ID of the extension.
Extension, extension_name - The extension name.
$sel:parameters:Extension', extension_parameters - The parameters accepted by the extension. You specify parameter values
when you associate the extension to an AppConfig resource by using the
CreateExtensionAssociation API action. For Lambda extension actions,
these parameters are included in the Lambda request object.
$sel:versionNumber:Extension', extension_versionNumber - The extension version number.
UpdateExtensionAssociation
data UpdateExtensionAssociation Source #
See: newUpdateExtensionAssociation smart constructor.
Instances
newUpdateExtensionAssociation Source #
Arguments
| :: Text | |
| -> UpdateExtensionAssociation |
Create a value of UpdateExtensionAssociation 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:
UpdateExtensionAssociation, updateExtensionAssociation_parameters - The parameter names and values defined in the extension.
UpdateExtensionAssociation, updateExtensionAssociation_extensionAssociationId - The system-generated ID for the association.
data ExtensionAssociation Source #
See: newExtensionAssociation smart constructor.
Constructors
| ExtensionAssociation' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) |
Instances
newExtensionAssociation :: ExtensionAssociation Source #
Create a value of ExtensionAssociation 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:arn:ExtensionAssociation', extensionAssociation_arn - The system-generated Amazon Resource Name (ARN) for the extension.
$sel:extensionArn:ExtensionAssociation', extensionAssociation_extensionArn - The ARN of the extension defined in the association.
$sel:extensionVersionNumber:ExtensionAssociation', extensionAssociation_extensionVersionNumber - The version number for the extension defined in the association.
$sel:id:ExtensionAssociation', extensionAssociation_id - The system-generated ID for the association.
$sel:parameters:ExtensionAssociation', extensionAssociation_parameters - The parameter names and values defined in the association.
$sel:resourceArn:ExtensionAssociation', extensionAssociation_resourceArn - The ARNs of applications, configuration profiles, or environments
defined in the association.
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:
ValidateConfiguration, validateConfiguration_applicationId - The application ID.
ValidateConfiguration, validateConfiguration_configurationProfileId - The configuration profile ID.
ValidateConfiguration, validateConfiguration_configurationVersion - The version of the configuration to validate.
data ValidateConfigurationResponse Source #
See: newValidateConfigurationResponse smart constructor.
Constructors
| ValidateConfigurationResponse' | |
Instances
| Generic ValidateConfigurationResponse Source # | |
Defined in Amazonka.AppConfig.ValidateConfiguration Associated Types type Rep ValidateConfigurationResponse :: Type -> Type # | |
| Read ValidateConfigurationResponse Source # | |
| Show ValidateConfigurationResponse Source # | |
Defined in Amazonka.AppConfig.ValidateConfiguration Methods showsPrec :: Int -> ValidateConfigurationResponse -> ShowS # show :: ValidateConfigurationResponse -> String # showList :: [ValidateConfigurationResponse] -> ShowS # | |
| NFData ValidateConfigurationResponse Source # | |
Defined in Amazonka.AppConfig.ValidateConfiguration Methods rnf :: ValidateConfigurationResponse -> () # | |
| Eq ValidateConfigurationResponse Source # | |
Defined in Amazonka.AppConfig.ValidateConfiguration | |
| 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.
Types
ActionPoint
newtype ActionPoint Source #
Constructors
| ActionPoint' | |
Fields | |
Bundled Patterns
| pattern ActionPoint_ON_DEPLOYMENT_BAKING :: ActionPoint | |
| pattern ActionPoint_ON_DEPLOYMENT_COMPLETE :: ActionPoint | |
| pattern ActionPoint_ON_DEPLOYMENT_ROLLED_BACK :: ActionPoint | |
| pattern ActionPoint_ON_DEPLOYMENT_START :: ActionPoint | |
| pattern ActionPoint_ON_DEPLOYMENT_STEP :: ActionPoint | |
| pattern ActionPoint_PRE_CREATE_HOSTED_CONFIGURATION_VERSION :: ActionPoint | |
| pattern ActionPoint_PRE_START_DEPLOYMENT :: ActionPoint |
Instances
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
Action
An action defines the tasks the extension performs during the AppConfig
workflow. Each action includes an action point such as
ON_CREATE_HOSTED_CONFIGURATION, PRE_DEPLOYMENT, or ON_DEPLOYMENT.
Each action also includes a name, a URI to an Lambda function, and an
Amazon Resource Name (ARN) for an Identity and Access Management assume
role. You specify the name, URI, and ARN for each action point defined
in the extension. You can specify the following actions for an
extension:
PRE_CREATE_HOSTED_CONFIGURATION_VERSION
PRE_START_DEPLOYMENT
ON_DEPLOYMENT_START
ON_DEPLOYMENT_STEP
ON_DEPLOYMENT_BAKING
ON_DEPLOYMENT_COMPLETE
ON_DEPLOYMENT_ROLLED_BACK
See: newAction smart constructor.
Instances
Create a value of Action 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:Action', action_description - Information about the action.
$sel:name:Action', action_name - The action name.
$sel:roleArn:Action', action_roleArn - An Amazon Resource Name (ARN) for an Identity and Access Management
assume role.
$sel:uri:Action', action_uri - The extension URI associated to the action point in the extension
definition. The URI can be an Amazon Resource Name (ARN) for one of the
following: an Lambda function, an Amazon Simple Queue Service queue, an
Amazon Simple Notification Service topic, or the Amazon EventBridge
default event bus.
ActionInvocation
data ActionInvocation Source #
An extension that was invoked as part of a deployment event.
See: newActionInvocation smart constructor.
Constructors
| ActionInvocation' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newActionInvocation :: ActionInvocation Source #
Create a value of ActionInvocation 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:actionName:ActionInvocation', actionInvocation_actionName - The name of the action.
$sel:errorCode:ActionInvocation', actionInvocation_errorCode - The error code when an extension invocation fails.
$sel:errorMessage:ActionInvocation', actionInvocation_errorMessage - The error message when an extension invocation fails.
$sel:extensionIdentifier:ActionInvocation', actionInvocation_extensionIdentifier - The name, the ID, or the Amazon Resource Name (ARN) of the extension.
$sel:invocationId:ActionInvocation', actionInvocation_invocationId - A system-generated ID for this invocation.
$sel:roleArn:ActionInvocation', actionInvocation_roleArn - An Amazon Resource Name (ARN) for an Identity and Access Management
assume role.
$sel:uri:ActionInvocation', actionInvocation_uri - The extension URI associated to the action point in the extension
definition. The URI can be an Amazon Resource Name (ARN) for one of the
following: an Lambda function, an Amazon Simple Queue Service queue, an
Amazon Simple Notification Service topic, or the Amazon EventBridge
default event bus.
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:description:Application', application_description - The description of the application.
$sel:id:Application', application_id - The application ID.
$sel:name:Application', application_name - The application name.
AppliedExtension
data AppliedExtension Source #
An extension that was invoked during a deployment.
See: newAppliedExtension smart constructor.
Instances
newAppliedExtension :: AppliedExtension Source #
Create a value of AppliedExtension 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:extensionAssociationId:AppliedExtension', appliedExtension_extensionAssociationId - The system-generated ID for the association.
$sel:extensionId:AppliedExtension', appliedExtension_extensionId - The system-generated ID of the extension.
$sel:parameters:AppliedExtension', appliedExtension_parameters - One or more parameters for the actions called by the extension.
$sel:versionNumber:AppliedExtension', appliedExtension_versionNumber - The extension version number.
ConfigurationProfile
data ConfigurationProfile Source #
See: newConfigurationProfile smart constructor.
Constructors
| ConfigurationProfile' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Validator]) |
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:applicationId:ConfigurationProfile', configurationProfile_applicationId - The application ID.
$sel:description:ConfigurationProfile', configurationProfile_description - The configuration profile description.
$sel:id:ConfigurationProfile', configurationProfile_id - The configuration profile ID.
$sel:locationUri:ConfigurationProfile', configurationProfile_locationUri - The URI location of the configuration.
$sel:name:ConfigurationProfile', configurationProfile_name - The name of the configuration profile.
$sel:retrievalRoleArn:ConfigurationProfile', configurationProfile_retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at
the specified LocationUri.
ConfigurationProfile, configurationProfile_type - The type of configurations contained in the profile. AppConfig supports
feature flags and freeform configurations. We recommend you create
feature flag configurations to enable or disable new features and
freeform configurations to distribute configurations to an application.
When calling this API, enter one of the following values for Type:
AWS.AppConfig.FeatureFlags
AWS.Freeform
$sel:validators:ConfigurationProfile', configurationProfile_validators - A list of methods for validating the configuration.
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 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:applicationId:ConfigurationProfileSummary', configurationProfileSummary_applicationId - The application ID.
$sel:id:ConfigurationProfileSummary', configurationProfileSummary_id - The ID of the configuration profile.
$sel:locationUri:ConfigurationProfileSummary', configurationProfileSummary_locationUri - The URI location of the configuration.
$sel:name:ConfigurationProfileSummary', configurationProfileSummary_name - The name of the configuration profile.
$sel:type':ConfigurationProfileSummary', configurationProfileSummary_type - The type of configurations contained in the profile. AppConfig supports
feature flags and freeform configurations. We recommend you create
feature flag configurations to enable or disable new features and
freeform configurations to distribute configurations to an application.
When calling this API, enter one of the following values for Type:
AWS.AppConfig.FeatureFlags
AWS.Freeform
$sel:validatorTypes:ConfigurationProfileSummary', configurationProfileSummary_validatorTypes - The types of validators in the configuration profile.
Deployment
data Deployment Source #
See: newDeployment smart constructor.
Constructors
| Deployment' (Maybe Text) (Maybe [AppliedExtension]) (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [DeploymentEvent]) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Double) (Maybe ISO8601) (Maybe DeploymentState) |
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:applicationId:Deployment', deployment_applicationId - The ID of the application that was deployed.
$sel:appliedExtensions:Deployment', deployment_appliedExtensions - A list of extensions that were processed as part of the deployment. The
extensions that were previously associated to the configuration profile,
environment, or the application when StartDeployment was called.
$sel:completedAt:Deployment', deployment_completedAt - The time the deployment completed.
$sel:configurationLocationUri:Deployment', deployment_configurationLocationUri - Information about the source location of the configuration.
$sel:configurationName:Deployment', deployment_configurationName - The name of the configuration.
$sel:configurationProfileId:Deployment', deployment_configurationProfileId - The ID of the configuration profile that was deployed.
$sel:configurationVersion:Deployment', deployment_configurationVersion - The configuration version that was deployed.
$sel:deploymentDurationInMinutes:Deployment', deployment_deploymentDurationInMinutes - Total amount of time the deployment lasted.
$sel:deploymentNumber:Deployment', deployment_deploymentNumber - The sequence number of the deployment.
$sel:deploymentStrategyId:Deployment', deployment_deploymentStrategyId - The ID of the deployment strategy that was deployed.
Deployment, deployment_description - The description of the deployment.
$sel:environmentId:Deployment', deployment_environmentId - The ID of the environment 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:finalBakeTimeInMinutes:Deployment', deployment_finalBakeTimeInMinutes - The amount of time that AppConfig monitored for alarms before
considering the deployment to be complete and no longer eligible for
automatic rollback.
$sel:growthFactor:Deployment', deployment_growthFactor - The percentage of targets to receive a deployed configuration during
each interval.
$sel:growthType:Deployment', deployment_growthType - The algorithm used to define how percentage grew over time.
$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:state:Deployment', deployment_state - The state of the deployment.
DeploymentEvent
data DeploymentEvent Source #
An object that describes a deployment event.
See: newDeploymentEvent smart constructor.
Constructors
| DeploymentEvent' (Maybe [ActionInvocation]) (Maybe Text) (Maybe DeploymentEventType) (Maybe ISO8601) (Maybe TriggeredBy) |
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:actionInvocations:DeploymentEvent', deploymentEvent_actionInvocations - The list of extensions that were invoked as part of the deployment.
$sel:description:DeploymentEvent', deploymentEvent_description - A description of the deployment event. Descriptions include, but are not
limited to, the user account or the Amazon 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.
$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; and the start or completion of a rollback.
$sel:occurredAt:DeploymentEvent', deploymentEvent_occurredAt - The date and time the event occurred.
$sel:triggeredBy:DeploymentEvent', deploymentEvent_triggeredBy - The entity that triggered the deployment event. Events can be triggered
by a user, AppConfig, an Amazon CloudWatch alarm, or an internal error.
DeploymentStrategy
data DeploymentStrategy Source #
See: newDeploymentStrategy smart constructor.
Constructors
| DeploymentStrategy' (Maybe Natural) (Maybe Text) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Text) (Maybe Text) (Maybe ReplicateTo) |
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:deploymentDurationInMinutes:DeploymentStrategy', deploymentStrategy_deploymentDurationInMinutes - Total amount of time the deployment lasted.
$sel:description:DeploymentStrategy', deploymentStrategy_description - The description of the deployment strategy.
$sel:finalBakeTimeInMinutes:DeploymentStrategy', deploymentStrategy_finalBakeTimeInMinutes - The amount of time that AppConfig monitored for alarms before
considering the deployment to be complete and no longer eligible for
automatic rollback.
$sel:growthFactor:DeploymentStrategy', deploymentStrategy_growthFactor - The percentage of targets that received a deployed configuration during
each interval.
$sel:growthType:DeploymentStrategy', deploymentStrategy_growthType - The algorithm used to define how percentage grew over time.
$sel:id:DeploymentStrategy', deploymentStrategy_id - The deployment strategy ID.
$sel:name:DeploymentStrategy', deploymentStrategy_name - The name of the deployment strategy.
$sel:replicateTo:DeploymentStrategy', deploymentStrategy_replicateTo - Save the deployment strategy to a Systems Manager (SSM) document.
DeploymentSummary
data DeploymentSummary Source #
Information about the deployment.
See: newDeploymentSummary smart constructor.
Constructors
| DeploymentSummary' (Maybe ISO8601) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Int) (Maybe Natural) (Maybe Double) (Maybe GrowthType) (Maybe Double) (Maybe ISO8601) (Maybe DeploymentState) |
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:completedAt:DeploymentSummary', deploymentSummary_completedAt - Time the deployment completed.
$sel:configurationName:DeploymentSummary', deploymentSummary_configurationName - The name of the configuration.
$sel:configurationVersion:DeploymentSummary', deploymentSummary_configurationVersion - The version of the configuration.
$sel:deploymentDurationInMinutes:DeploymentSummary', deploymentSummary_deploymentDurationInMinutes - Total amount of time the deployment lasted.
$sel:deploymentNumber:DeploymentSummary', deploymentSummary_deploymentNumber - The sequence number of the deployment.
$sel:finalBakeTimeInMinutes:DeploymentSummary', deploymentSummary_finalBakeTimeInMinutes - The amount of time that AppConfig monitors for alarms before considering
the deployment to be complete and no longer eligible for automatic
rollback.
$sel:growthFactor:DeploymentSummary', deploymentSummary_growthFactor - The percentage of targets to receive a deployed configuration during
each interval.
$sel:growthType:DeploymentSummary', deploymentSummary_growthType - The algorithm used to define how percentage grows over time.
$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:state:DeploymentSummary', deploymentSummary_state - The state of the deployment.
Environment
data Environment Source #
See: newEnvironment smart constructor.
Constructors
| Environment' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Monitor]) (Maybe Text) (Maybe EnvironmentState) |
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:applicationId:Environment', environment_applicationId - The application ID.
$sel:description:Environment', environment_description - The description of the environment.
$sel:id:Environment', environment_id - The environment ID.
$sel:monitors:Environment', environment_monitors - Amazon CloudWatch alarms monitored during the deployment.
$sel:name:Environment', environment_name - The name of the environment.
$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
Extension
See: newExtension smart constructor.
Constructors
| Extension' (Maybe (HashMap ActionPoint (NonEmpty Action))) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Parameter)) (Maybe Int) |
Instances
newExtension :: Extension Source #
Create a value of Extension 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:actions:Extension', extension_actions - The actions defined in the extension.
$sel:arn:Extension', extension_arn - The system-generated Amazon Resource Name (ARN) for the extension.
Extension, extension_description - Information about the extension.
$sel:id:Extension', extension_id - The system-generated ID of the extension.
Extension, extension_name - The extension name.
$sel:parameters:Extension', extension_parameters - The parameters accepted by the extension. You specify parameter values
when you associate the extension to an AppConfig resource by using the
CreateExtensionAssociation API action. For Lambda extension actions,
these parameters are included in the Lambda request object.
$sel:versionNumber:Extension', extension_versionNumber - The extension version number.
ExtensionAssociation
data ExtensionAssociation Source #
See: newExtensionAssociation smart constructor.
Constructors
| ExtensionAssociation' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) |
Instances
newExtensionAssociation :: ExtensionAssociation Source #
Create a value of ExtensionAssociation 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:arn:ExtensionAssociation', extensionAssociation_arn - The system-generated Amazon Resource Name (ARN) for the extension.
$sel:extensionArn:ExtensionAssociation', extensionAssociation_extensionArn - The ARN of the extension defined in the association.
$sel:extensionVersionNumber:ExtensionAssociation', extensionAssociation_extensionVersionNumber - The version number for the extension defined in the association.
$sel:id:ExtensionAssociation', extensionAssociation_id - The system-generated ID for the association.
$sel:parameters:ExtensionAssociation', extensionAssociation_parameters - The parameter names and values defined in the association.
$sel:resourceArn:ExtensionAssociation', extensionAssociation_resourceArn - The ARNs of applications, configuration profiles, or environments
defined in the association.
ExtensionAssociationSummary
data ExtensionAssociationSummary Source #
Information about an association between an extension and an AppConfig
resource such as an application, environment, or configuration profile.
Call GetExtensionAssociation to get more information about an
association.
See: newExtensionAssociationSummary smart constructor.
Instances
newExtensionAssociationSummary :: ExtensionAssociationSummary Source #
Create a value of ExtensionAssociationSummary 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:extensionArn:ExtensionAssociationSummary', extensionAssociationSummary_extensionArn - The system-generated Amazon Resource Name (ARN) for the extension.
$sel:id:ExtensionAssociationSummary', extensionAssociationSummary_id - The extension association ID. This ID is used to call other
ExtensionAssociation API actions such as GetExtensionAssociation or
DeleteExtensionAssociation.
$sel:resourceArn:ExtensionAssociationSummary', extensionAssociationSummary_resourceArn - The ARNs of applications, configuration profiles, or environments
defined in the association.
ExtensionSummary
data ExtensionSummary Source #
Information about an extension. Call GetExtension to get more
information about an extension.
See: newExtensionSummary smart constructor.
Instances
newExtensionSummary :: ExtensionSummary Source #
Create a value of ExtensionSummary 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:arn:ExtensionSummary', extensionSummary_arn - The system-generated Amazon Resource Name (ARN) for the extension.
$sel:description:ExtensionSummary', extensionSummary_description - Information about the extension.
$sel:id:ExtensionSummary', extensionSummary_id - The system-generated ID of the extension.
$sel:name:ExtensionSummary', extensionSummary_name - The extension name.
$sel:versionNumber:ExtensionSummary', extensionSummary_versionNumber - The extension version number.
HostedConfigurationVersion
data HostedConfigurationVersion Source #
See: newHostedConfigurationVersion smart constructor.
Constructors
| HostedConfigurationVersion' (Maybe Text) (Maybe Text) (Maybe (Sensitive ByteString)) (Maybe Text) (Maybe Text) (Maybe Int) |
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:applicationId:HostedConfigurationVersion', hostedConfigurationVersion_applicationId - The application ID.
$sel:configurationProfileId:HostedConfigurationVersion', hostedConfigurationVersion_configurationProfileId - The configuration profile ID.
$sel:content:HostedConfigurationVersion', hostedConfigurationVersion_content - The content of the configuration or the configuration data.
$sel:contentType:HostedConfigurationVersion', hostedConfigurationVersion_contentType - A standard MIME type describing the format of the configuration content.
For more information, see
Content-Type.
$sel:description:HostedConfigurationVersion', hostedConfigurationVersion_description - A description of the configuration.
$sel:versionNumber:HostedConfigurationVersion', hostedConfigurationVersion_versionNumber - The configuration version.
HostedConfigurationVersionSummary
data HostedConfigurationVersionSummary Source #
Information about the configuration.
See: newHostedConfigurationVersionSummary smart constructor.
Constructors
| HostedConfigurationVersionSummary' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) |
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:applicationId:HostedConfigurationVersionSummary', hostedConfigurationVersionSummary_applicationId - The application ID.
$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.
$sel:description:HostedConfigurationVersionSummary', hostedConfigurationVersionSummary_description - A description of the configuration.
$sel:versionNumber:HostedConfigurationVersionSummary', hostedConfigurationVersionSummary_versionNumber - The configuration version.
Monitor
Amazon CloudWatch alarms to monitor during the deployment process.
See: newMonitor smart constructor.
Instances
| FromJSON Monitor Source # | |
| ToJSON Monitor Source # | |
Defined in Amazonka.AppConfig.Types.Monitor | |
| Generic Monitor Source # | |
| Read Monitor Source # | |
| Show Monitor Source # | |
| NFData Monitor Source # | |
Defined in Amazonka.AppConfig.Types.Monitor | |
| Eq Monitor Source # | |
| Hashable Monitor Source # | |
Defined in Amazonka.AppConfig.Types.Monitor | |
| type Rep Monitor Source # | |
Defined in Amazonka.AppConfig.Types.Monitor type Rep Monitor = D1 ('MetaData "Monitor" "Amazonka.AppConfig.Types.Monitor" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "Monitor'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alarmRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "alarmArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
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 Identity and Access Management (IAM) role for AppConfig to
monitor AlarmArn.
$sel:alarmArn:Monitor', monitor_alarmArn - Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
Parameter
A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked. Parameter values are specified in an extension association. For more information about extensions, see Working with AppConfig extensions in the AppConfig User Guide.
See: newParameter smart constructor.
Constructors
| Parameter' (Maybe Text) (Maybe Bool) |
Instances
| FromJSON Parameter Source # | |
| ToJSON Parameter Source # | |
Defined in Amazonka.AppConfig.Types.Parameter | |
| Generic Parameter Source # | |
| Read Parameter Source # | |
| Show Parameter Source # | |
| NFData Parameter Source # | |
Defined in Amazonka.AppConfig.Types.Parameter | |
| Eq Parameter Source # | |
| Hashable Parameter Source # | |
Defined in Amazonka.AppConfig.Types.Parameter | |
| type Rep Parameter Source # | |
Defined in Amazonka.AppConfig.Types.Parameter type Rep Parameter = D1 ('MetaData "Parameter" "Amazonka.AppConfig.Types.Parameter" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "Parameter'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "required") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) | |
newParameter :: Parameter Source #
Create a value of Parameter 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:Parameter', parameter_description - Information about the parameter.
$sel:required:Parameter', parameter_required - A parameter value must be specified in the extension association.
Validator
A validator provides a syntactic or semantic check to ensure the configuration that you want to deploy functions as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services 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
| FromJSON Validator Source # | |
| ToJSON Validator Source # | |
Defined in Amazonka.AppConfig.Types.Validator | |
| Generic Validator Source # | |
| Show Validator Source # | |
| NFData Validator Source # | |
Defined in Amazonka.AppConfig.Types.Validator | |
| Eq Validator Source # | |
| Hashable Validator Source # | |
Defined in Amazonka.AppConfig.Types.Validator | |
| type Rep Validator Source # | |
Defined in Amazonka.AppConfig.Types.Validator type Rep Validator = D1 ('MetaData "Validator" "Amazonka.AppConfig.Types.Validator" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" '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
Lambda function.