libZSservicesZSamazonka-appconfigZSamazonka-appconfig
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.AppConfig.Lens

Description

 
Synopsis

Operations

ListEnvironments

listEnvironments_nextToken :: Lens' ListEnvironments (Maybe Text) Source #

A token to start the list. Use this token to get the next set of results.

listEnvironments_maxResults :: Lens' ListEnvironments (Maybe Natural) Source #

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.

listEnvironmentsResponse_nextToken :: Lens' ListEnvironmentsResponse (Maybe Text) Source #

The token for the next set of items to return. Use this token to get the next set of results.

UpdateEnvironment

updateEnvironment_monitors :: Lens' UpdateEnvironment (Maybe [Monitor]) Source #

Amazon CloudWatch alarms to monitor during the deployment process.

environment_state :: Lens' Environment (Maybe EnvironmentState) Source #

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

environment_monitors :: Lens' Environment (Maybe [Monitor]) Source #

Amazon CloudWatch alarms monitored during the deployment.

environment_name :: Lens' Environment (Maybe Text) Source #

The name of the environment.

environment_description :: Lens' Environment (Maybe Text) Source #

The description of the environment.

DeleteEnvironment

deleteEnvironment_applicationId :: Lens' DeleteEnvironment Text Source #

The application ID that includes the environment you want to delete.

deleteEnvironment_environmentId :: Lens' DeleteEnvironment Text Source #

The ID of the environment you want to delete.

GetDeploymentStrategy

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

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

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

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

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

The name of the deployment strategy.

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

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

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

The description of the deployment strategy.

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

The algorithm used to define how percentage grew over time.

CreateConfigurationProfile

createConfigurationProfile_retrievalRoleArn :: Lens' CreateConfigurationProfile (Maybe Text) Source #

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

createConfigurationProfile_validators :: Lens' CreateConfigurationProfile (Maybe [Validator]) Source #

A list of methods for validating the configuration.

createConfigurationProfile_tags :: Lens' CreateConfigurationProfile (Maybe (HashMap Text Text)) Source #

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_locationUri :: Lens' CreateConfigurationProfile Text Source #

A URI to locate the configuration. You can specify a Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the Amazon Resource Name (ARN). For a parameter, specify either the parameter name in the format ssm-parameter://<Parameter_name> or the ARN. For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/<objectKey> . Here is an example: s3://my-bucket/my-app/us-east-1/my-config.json

configurationProfile_retrievalRoleArn :: Lens' ConfigurationProfile (Maybe Text) Source #

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

configurationProfile_validators :: Lens' ConfigurationProfile (Maybe [Validator]) Source #

A list of methods for validating the configuration.

configurationProfile_locationUri :: Lens' ConfigurationProfile (Maybe Text) Source #

The URI location of the configuration.

configurationProfile_name :: Lens' ConfigurationProfile (Maybe Text) Source #

The name of the configuration profile.

configurationProfile_description :: Lens' ConfigurationProfile (Maybe Text) Source #

The configuration profile description.

GetDeployment

getDeployment_applicationId :: Lens' GetDeployment Text Source #

The ID of the application that includes the deployment you want to get.

getDeployment_environmentId :: Lens' GetDeployment Text Source #

The ID of the environment that includes the deployment you want to get.

getDeployment_deploymentNumber :: Lens' GetDeployment Int Source #

The sequence number of the deployment.

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

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

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

The name of the configuration.

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

The state of the deployment.

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

The ID of the deployment strategy that was deployed.

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

The sequence number of the deployment.

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

The configuration version that was deployed.

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

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

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

The percentage of targets for which the deployment is available.

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

The time the deployment started.

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

The ID of the application that was deployed.

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

Total amount of time the deployment lasted.

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

The ID of the environment that was deployed.

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

The time the deployment completed.

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

Information about the source location of the configuration.

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

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

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

The description of the deployment.

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

The ID of the configuration profile that was deployed.

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

The algorithm used to define how percentage grew over time.

UpdateConfigurationProfile

updateConfigurationProfile_retrievalRoleArn :: Lens' UpdateConfigurationProfile (Maybe Text) Source #

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

updateConfigurationProfile_validators :: Lens' UpdateConfigurationProfile (Maybe [Validator]) Source #

A list of methods for validating the configuration.

configurationProfile_retrievalRoleArn :: Lens' ConfigurationProfile (Maybe Text) Source #

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

configurationProfile_validators :: Lens' ConfigurationProfile (Maybe [Validator]) Source #

A list of methods for validating the configuration.

configurationProfile_locationUri :: Lens' ConfigurationProfile (Maybe Text) Source #

The URI location of the configuration.

configurationProfile_name :: Lens' ConfigurationProfile (Maybe Text) Source #

The name of the configuration profile.

configurationProfile_description :: Lens' ConfigurationProfile (Maybe Text) Source #

The configuration profile description.

DeleteConfigurationProfile

deleteConfigurationProfile_applicationId :: Lens' DeleteConfigurationProfile Text Source #

The application ID that includes the configuration profile you want to delete.

deleteConfigurationProfile_configurationProfileId :: Lens' DeleteConfigurationProfile Text Source #

The ID of the configuration profile you want to delete.

ListTagsForResource

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

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.

ListHostedConfigurationVersions

listHostedConfigurationVersions_nextToken :: Lens' ListHostedConfigurationVersions (Maybe Text) Source #

A token to start the list. Use this token to get the next set of results.

listHostedConfigurationVersions_maxResults :: Lens' ListHostedConfigurationVersions (Maybe Natural) Source #

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.

listHostedConfigurationVersionsResponse_nextToken :: Lens' ListHostedConfigurationVersionsResponse (Maybe Text) Source #

The token for the next set of items to return. Use this token to get the next set of results.

GetConfigurationProfile

getConfigurationProfile_applicationId :: Lens' GetConfigurationProfile Text Source #

The ID of the application that includes the configuration profile you want to get.

getConfigurationProfile_configurationProfileId :: Lens' GetConfigurationProfile Text Source #

The ID of the configuration profile you want to get.

configurationProfile_retrievalRoleArn :: Lens' ConfigurationProfile (Maybe Text) Source #

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

configurationProfile_validators :: Lens' ConfigurationProfile (Maybe [Validator]) Source #

A list of methods for validating the configuration.

configurationProfile_locationUri :: Lens' ConfigurationProfile (Maybe Text) Source #

The URI location of the configuration.

configurationProfile_name :: Lens' ConfigurationProfile (Maybe Text) Source #

The name of the configuration profile.

configurationProfile_description :: Lens' ConfigurationProfile (Maybe Text) Source #

The configuration profile description.

DeleteApplication

deleteApplication_applicationId :: Lens' DeleteApplication Text Source #

The ID of the application to delete.

UpdateApplication

application_name :: Lens' Application (Maybe Text) Source #

The application name.

application_description :: Lens' Application (Maybe Text) Source #

The description of the application.

UpdateDeploymentStrategy

updateDeploymentStrategy_growthFactor :: Lens' UpdateDeploymentStrategy (Maybe Double) Source #

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

updateDeploymentStrategy_finalBakeTimeInMinutes :: Lens' UpdateDeploymentStrategy (Maybe Natural) Source #

The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

updateDeploymentStrategy_growthType :: Lens' UpdateDeploymentStrategy (Maybe GrowthType) Source #

The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the configuration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed configuration.

Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)
2*(2^1)
2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

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

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

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

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

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

The name of the deployment strategy.

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

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

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

The description of the deployment strategy.

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

The algorithm used to define how percentage grew over time.

DeleteDeploymentStrategy

deleteDeploymentStrategy_deploymentStrategyId :: Lens' DeleteDeploymentStrategy Text Source #

The ID of the deployment strategy you want to delete.

CreateApplication

createApplication_tags :: Lens' CreateApplication (Maybe (HashMap Text Text)) Source #

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.

application_name :: Lens' Application (Maybe Text) Source #

The application name.

application_description :: Lens' Application (Maybe Text) Source #

The description of the application.

ValidateConfiguration

validateConfiguration_configurationVersion :: Lens' ValidateConfiguration Text Source #

The version of the configuration to validate.

StopDeployment

stopDeployment_deploymentNumber :: Lens' StopDeployment Int Source #

The sequence number of the deployment.

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

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

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

The name of the configuration.

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

The state of the deployment.

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

The ID of the deployment strategy that was deployed.

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

The sequence number of the deployment.

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

The configuration version that was deployed.

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

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

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

The percentage of targets for which the deployment is available.

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

The time the deployment started.

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

The ID of the application that was deployed.

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

Total amount of time the deployment lasted.

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

The ID of the environment that was deployed.

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

The time the deployment completed.

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

Information about the source location of the configuration.

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

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

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

The description of the deployment.

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

The ID of the configuration profile that was deployed.

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

The algorithm used to define how percentage grew over time.

GetApplication

getApplication_applicationId :: Lens' GetApplication Text Source #

The ID of the application you want to get.

application_name :: Lens' Application (Maybe Text) Source #

The application name.

application_description :: Lens' Application (Maybe Text) Source #

The description of the application.

CreateHostedConfigurationVersion

createHostedConfigurationVersion_latestVersionNumber :: Lens' CreateHostedConfigurationVersion (Maybe Int) Source #

An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version of the latest hosted configuration version.

createHostedConfigurationVersion_content :: Lens' CreateHostedConfigurationVersion ByteString Source #

The content of the configuration or the configuration data.

createHostedConfigurationVersion_contentType :: Lens' CreateHostedConfigurationVersion Text Source #

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

hostedConfigurationVersion_content :: Lens' HostedConfigurationVersion (Maybe ByteString) Source #

The content of the configuration or the configuration data.

hostedConfigurationVersion_contentType :: Lens' HostedConfigurationVersion (Maybe Text) Source #

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

ListConfigurationProfiles

listConfigurationProfiles_nextToken :: Lens' ListConfigurationProfiles (Maybe Text) Source #

A token to start the list. Use this token to get the next set of results.

listConfigurationProfiles_maxResults :: Lens' ListConfigurationProfiles (Maybe Natural) Source #

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.

listConfigurationProfilesResponse_nextToken :: Lens' ListConfigurationProfilesResponse (Maybe Text) Source #

The token for the next set of items to return. Use this token to get the next set of results.

DeleteHostedConfigurationVersion

GetHostedConfigurationVersion

hostedConfigurationVersion_content :: Lens' HostedConfigurationVersion (Maybe ByteString) Source #

The content of the configuration or the configuration data.

hostedConfigurationVersion_contentType :: Lens' HostedConfigurationVersion (Maybe Text) Source #

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

ListDeployments

listDeployments_nextToken :: Lens' ListDeployments (Maybe Text) Source #

A token to start the list. Use this token to get the next set of results.

listDeployments_maxResults :: Lens' ListDeployments (Maybe Natural) Source #

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.

listDeploymentsResponse_nextToken :: Lens' ListDeploymentsResponse (Maybe Text) Source #

The token for the next set of items to return. Use this token to get the next set of results.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The ARN of the resource for which to retrieve tags.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

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.

GetEnvironment

getEnvironment_applicationId :: Lens' GetEnvironment Text Source #

The ID of the application that includes the environment you want to get.

getEnvironment_environmentId :: Lens' GetEnvironment Text Source #

The ID of the environment you wnat to get.

environment_state :: Lens' Environment (Maybe EnvironmentState) Source #

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

environment_monitors :: Lens' Environment (Maybe [Monitor]) Source #

Amazon CloudWatch alarms monitored during the deployment.

environment_name :: Lens' Environment (Maybe Text) Source #

The name of the environment.

environment_description :: Lens' Environment (Maybe Text) Source #

The description of the environment.

ListApplications

listApplications_nextToken :: Lens' ListApplications (Maybe Text) Source #

A token to start the list. Use this token to get the next set of results.

listApplications_maxResults :: Lens' ListApplications (Maybe Natural) Source #

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.

listApplicationsResponse_nextToken :: Lens' ListApplicationsResponse (Maybe Text) Source #

The token for the next set of items to return. Use this token to get the next set of results.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The ARN of the resource for which to remove tags.

ListDeploymentStrategies

listDeploymentStrategies_nextToken :: Lens' ListDeploymentStrategies (Maybe Text) Source #

A token to start the list. Use this token to get the next set of results.

listDeploymentStrategies_maxResults :: Lens' ListDeploymentStrategies (Maybe Natural) Source #

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.

listDeploymentStrategiesResponse_nextToken :: Lens' ListDeploymentStrategiesResponse (Maybe Text) Source #

The token for the next set of items to return. Use this token to get the next set of results.

GetConfiguration

getConfiguration_clientConfigurationVersion :: Lens' GetConfiguration (Maybe Text) Source #

The configuration version returned in the most recent GetConfiguration response.

AWS AppConfig uses the value of the ClientConfigurationVersion parameter to identify the configuration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.

To avoid excess charges, we recommend that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

For more information about working with configurations, see Retrieving the Configuration in the AWS AppConfig User Guide.

getConfiguration_application :: Lens' GetConfiguration Text Source #

The application to get. Specify either the application name or the application ID.

getConfiguration_environment :: Lens' GetConfiguration Text Source #

The environment to get. Specify either the environment name or the environment ID.

getConfiguration_configuration :: Lens' GetConfiguration Text Source #

The configuration to get. Specify either the configuration name or the configuration ID.

getConfiguration_clientId :: Lens' GetConfiguration Text Source #

A unique ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

getConfigurationResponse_content :: Lens' GetConfigurationResponse (Maybe ByteString) Source #

The content of the configuration or the configuration data.

getConfigurationResponse_contentType :: Lens' GetConfigurationResponse (Maybe Text) Source #

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

CreateDeploymentStrategy

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

The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

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

The algorithm used to define how percentage grows over time. AWS AppConfig supports the following growth types:

Linear: For this type, AppConfig processes the deployment by dividing the total number of targets by the value specified for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the configuration to 10 percent of the hosts. After those deployments are complete, the system deploys the configuration to the next 10 percent. This continues until 100% of the targets have successfully received the configuration.

Exponential: For this type, AppConfig processes the deployment exponentially using the following formula: G*(2^N). In this formula, G is the growth factor specified by the user and N is the number of steps until the configuration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the configuration as follows:

2*(2^0)
2*(2^1)
2*(2^2)

Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the configuration has been deployed to all targets.

createDeploymentStrategy_tags :: Lens' CreateDeploymentStrategy (Maybe (HashMap Text Text)) Source #

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

createDeploymentStrategy_growthFactor :: Lens' CreateDeploymentStrategy Double Source #

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

createDeploymentStrategy_replicateTo :: Lens' CreateDeploymentStrategy ReplicateTo Source #

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

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

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

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

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

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

The name of the deployment strategy.

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

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

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

The description of the deployment strategy.

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

The algorithm used to define how percentage grew over time.

StartDeployment

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

A description of the deployment.

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

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

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

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

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

The name of the configuration.

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

The state of the deployment.

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

The ID of the deployment strategy that was deployed.

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

The sequence number of the deployment.

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

The configuration version that was deployed.

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

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

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

The percentage of targets for which the deployment is available.

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

The time the deployment started.

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

The ID of the application that was deployed.

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

Total amount of time the deployment lasted.

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

The ID of the environment that was deployed.

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

The time the deployment completed.

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

Information about the source location of the configuration.

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

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

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

The description of the deployment.

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

The ID of the configuration profile that was deployed.

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

The algorithm used to define how percentage grew over time.

CreateEnvironment

createEnvironment_monitors :: Lens' CreateEnvironment (Maybe [Monitor]) Source #

Amazon CloudWatch alarms to monitor during the deployment process.

createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text)) Source #

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.

environment_state :: Lens' Environment (Maybe EnvironmentState) Source #

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

environment_monitors :: Lens' Environment (Maybe [Monitor]) Source #

Amazon CloudWatch alarms monitored during the deployment.

environment_name :: Lens' Environment (Maybe Text) Source #

The name of the environment.

environment_description :: Lens' Environment (Maybe Text) Source #

The description of the environment.

Types

Application

application_name :: Lens' Application (Maybe Text) Source #

The application name.

application_description :: Lens' Application (Maybe Text) Source #

The description of the application.

ConfigurationProfile

configurationProfile_retrievalRoleArn :: Lens' ConfigurationProfile (Maybe Text) Source #

The ARN of an IAM role with permission to access the configuration at the specified LocationUri.

configurationProfile_validators :: Lens' ConfigurationProfile (Maybe [Validator]) Source #

A list of methods for validating the configuration.

configurationProfile_locationUri :: Lens' ConfigurationProfile (Maybe Text) Source #

The URI location of the configuration.

configurationProfile_name :: Lens' ConfigurationProfile (Maybe Text) Source #

The name of the configuration profile.

configurationProfile_description :: Lens' ConfigurationProfile (Maybe Text) Source #

The configuration profile description.

ConfigurationProfileSummary

configurationProfileSummary_validatorTypes :: Lens' ConfigurationProfileSummary (Maybe [ValidatorType]) Source #

The types of validators in the configuration profile.

Deployment

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

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

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

The name of the configuration.

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

The state of the deployment.

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

The ID of the deployment strategy that was deployed.

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

The sequence number of the deployment.

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

The configuration version that was deployed.

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

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

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

The percentage of targets for which the deployment is available.

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

The time the deployment started.

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

The ID of the application that was deployed.

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

Total amount of time the deployment lasted.

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

The ID of the environment that was deployed.

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

The time the deployment completed.

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

Information about the source location of the configuration.

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

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

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

The description of the deployment.

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

The ID of the configuration profile that was deployed.

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

The algorithm used to define how percentage grew over time.

DeploymentEvent

deploymentEvent_triggeredBy :: Lens' DeploymentEvent (Maybe TriggeredBy) Source #

The entity that triggered the deployment event. Events can be triggered by a user, AWS AppConfig, an Amazon CloudWatch alarm, or an internal error.

deploymentEvent_occurredAt :: Lens' DeploymentEvent (Maybe UTCTime) Source #

The date and time the event occurred.

deploymentEvent_eventType :: Lens' DeploymentEvent (Maybe DeploymentEventType) Source #

The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; the start or completion of a rollback.

deploymentEvent_description :: Lens' DeploymentEvent (Maybe Text) Source #

A description of the deployment event. Descriptions include, but are not limited to, the user account or the CloudWatch alarm ARN that initiated a rollback, the percentage of hosts that received the deployment, or in the case of an internal error, a recommendation to attempt a new deployment.

DeploymentStrategy

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

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

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

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

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

The name of the deployment strategy.

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

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

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

The description of the deployment strategy.

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

The algorithm used to define how percentage grew over time.

DeploymentSummary

deploymentSummary_growthFactor :: Lens' DeploymentSummary (Maybe Double) Source #

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

deploymentSummary_deploymentNumber :: Lens' DeploymentSummary (Maybe Int) Source #

The sequence number of the deployment.

deploymentSummary_percentageComplete :: Lens' DeploymentSummary (Maybe Double) Source #

The percentage of targets for which the deployment is available.

deploymentSummary_finalBakeTimeInMinutes :: Lens' DeploymentSummary (Maybe Natural) Source #

The amount of time AppConfig monitors for alarms before considering the deployment to be complete and no longer eligible for automatic roll back.

deploymentSummary_growthType :: Lens' DeploymentSummary (Maybe GrowthType) Source #

The algorithm used to define how percentage grows over time.

Environment

environment_state :: Lens' Environment (Maybe EnvironmentState) Source #

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

environment_monitors :: Lens' Environment (Maybe [Monitor]) Source #

Amazon CloudWatch alarms monitored during the deployment.

environment_name :: Lens' Environment (Maybe Text) Source #

The name of the environment.

environment_description :: Lens' Environment (Maybe Text) Source #

The description of the environment.

HostedConfigurationVersion

hostedConfigurationVersion_content :: Lens' HostedConfigurationVersion (Maybe ByteString) Source #

The content of the configuration or the configuration data.

hostedConfigurationVersion_contentType :: Lens' HostedConfigurationVersion (Maybe Text) Source #

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

HostedConfigurationVersionSummary

hostedConfigurationVersionSummary_contentType :: Lens' HostedConfigurationVersionSummary (Maybe Text) Source #

A standard MIME type describing the format of the configuration content. For more information, see Content-Type.

Monitor

monitor_alarmRoleArn :: Lens' Monitor (Maybe Text) Source #

ARN of an IAM role for AppConfig to monitor AlarmArn.

monitor_alarmArn :: Lens' Monitor (Maybe Text) Source #

ARN of the Amazon CloudWatch alarm.

Validator

validator_type :: Lens' Validator ValidatorType Source #

AppConfig supports validators of type JSON_SCHEMA and LAMBDA

validator_content :: Lens' Validator Text Source #

Either the JSON Schema content or the Amazon Resource Name (ARN) of an AWS Lambda function.