amazonka-appconfig-2.0: Amazon AppConfig SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AppConfig.Lens

Description

 
Synopsis

Operations

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_description :: Lens' Application (Maybe Text) Source #

The description of the application.

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

The application name.

CreateConfigurationProfile

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

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.

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_type :: Lens' CreateConfigurationProfile (Maybe Text) Source #

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_validators :: Lens' CreateConfigurationProfile (Maybe [Validator]) Source #

A list of methods for validating the configuration.

createConfigurationProfile_locationUri :: Lens' CreateConfigurationProfile Text Source #

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

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

The configuration profile description.

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_retrievalRoleArn :: Lens' ConfigurationProfile (Maybe Text) Source #

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

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

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

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

A list of methods for validating the configuration.

CreateDeploymentStrategy

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

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_growthType :: Lens' CreateDeploymentStrategy (Maybe GrowthType) Source #

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_replicateTo :: Lens' CreateDeploymentStrategy (Maybe ReplicateTo) Source #

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

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.

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

The description of the deployment strategy.

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

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

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

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

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

The algorithm used to define how percentage grew over time.

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

The name of the deployment strategy.

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

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

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_description :: Lens' Environment (Maybe Text) Source #

The description of the environment.

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_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

CreateExtension

createExtension_description :: Lens' CreateExtension (Maybe Text) Source #

Information about the extension.

createExtension_latestVersionNumber :: Lens' CreateExtension (Maybe Int) Source #

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_parameters :: Lens' CreateExtension (Maybe (HashMap Text Parameter)) Source #

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.

createExtension_tags :: Lens' CreateExtension (Maybe (HashMap Text Text)) Source #

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_name :: Lens' CreateExtension Text Source #

A name for the extension. Each extension name in your account must be unique. Extension versions use the same name.

extension_actions :: Lens' Extension (Maybe (HashMap ActionPoint (NonEmpty Action))) Source #

The actions defined in the extension.

extension_arn :: Lens' Extension (Maybe Text) Source #

The system-generated Amazon Resource Name (ARN) for the extension.

extension_description :: Lens' Extension (Maybe Text) Source #

Information about the extension.

extension_id :: Lens' Extension (Maybe Text) Source #

The system-generated ID of the extension.

extension_name :: Lens' Extension (Maybe Text) Source #

The extension name.

extension_parameters :: Lens' Extension (Maybe (HashMap Text Parameter)) Source #

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.

extension_versionNumber :: Lens' Extension (Maybe Int) Source #

The extension version number.

CreateExtensionAssociation

createExtensionAssociation_extensionVersionNumber :: Lens' CreateExtensionAssociation (Maybe Int) Source #

The version number of the extension. If not specified, AppConfig uses the maximum version of the extension.

createExtensionAssociation_parameters :: Lens' CreateExtensionAssociation (Maybe (HashMap Text Text)) Source #

The parameter names and values defined in the extensions. Extension parameters marked Required must be entered for this field.

createExtensionAssociation_tags :: Lens' CreateExtensionAssociation (Maybe (HashMap Text Text)) Source #

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_extensionIdentifier :: Lens' CreateExtensionAssociation Text Source #

The name, the ID, or the Amazon Resource Name (ARN) of the extension.

createExtensionAssociation_resourceIdentifier :: Lens' CreateExtensionAssociation Text Source #

The ARN of an application, configuration profile, or environment.

extensionAssociation_arn :: Lens' ExtensionAssociation (Maybe Text) Source #

The system-generated Amazon Resource Name (ARN) for the extension.

extensionAssociation_extensionArn :: Lens' ExtensionAssociation (Maybe Text) Source #

The ARN of the extension defined in the association.

extensionAssociation_extensionVersionNumber :: Lens' ExtensionAssociation (Maybe Int) Source #

The version number for the extension defined in the association.

extensionAssociation_id :: Lens' ExtensionAssociation (Maybe Text) Source #

The system-generated ID for the association.

extensionAssociation_parameters :: Lens' ExtensionAssociation (Maybe (HashMap Text Text)) Source #

The parameter names and values defined in the association.

extensionAssociation_resourceArn :: Lens' ExtensionAssociation (Maybe Text) Source #

The ARNs of applications, configuration profiles, or environments defined in the association.

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

DeleteApplication

deleteApplication_applicationId :: Lens' DeleteApplication Text Source #

The ID of the application to delete.

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.

DeleteDeploymentStrategy

deleteDeploymentStrategy_deploymentStrategyId :: Lens' DeleteDeploymentStrategy Text Source #

The ID of the deployment strategy you want to delete.

DeleteEnvironment

deleteEnvironment_applicationId :: Lens' DeleteEnvironment Text Source #

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

deleteEnvironment_environmentId :: Lens' DeleteEnvironment Text Source #

The ID of the environment that you want to delete.

DeleteExtension

deleteExtension_versionNumber :: Lens' DeleteExtension (Maybe Int) Source #

A specific version of an extension to delete. If omitted, the highest version is deleted.

deleteExtension_extensionIdentifier :: Lens' DeleteExtension Text Source #

The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete.

DeleteExtensionAssociation

DeleteHostedConfigurationVersion

GetApplication

getApplication_applicationId :: Lens' GetApplication Text Source #

The ID of the application you want to get.

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

The description of the application.

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

The application name.

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 that you want to get.

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

The configuration profile description.

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_retrievalRoleArn :: Lens' ConfigurationProfile (Maybe Text) Source #

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

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

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

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

A list of methods for validating the configuration.

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_applicationId :: Lens' Deployment (Maybe Text) Source #

The ID of the application that was deployed.

deployment_appliedExtensions :: Lens' Deployment (Maybe [AppliedExtension]) Source #

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.

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_configurationName :: Lens' Deployment (Maybe Text) Source #

The name of the configuration.

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

The ID of the configuration profile that was deployed.

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

The configuration version that was deployed.

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

Total amount of time the deployment lasted.

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

The sequence number of the deployment.

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

The ID of the deployment strategy that was deployed.

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

The description of the deployment.

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

The ID of the environment 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_finalBakeTimeInMinutes :: Lens' Deployment (Maybe Natural) Source #

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

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

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

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

The algorithm used to define how percentage grew over time.

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_state :: Lens' Deployment (Maybe DeploymentState) Source #

The state of the deployment.

GetDeploymentStrategy

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

The description of the deployment strategy.

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

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

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

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

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

The algorithm used to define how percentage grew over time.

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

The name of the deployment strategy.

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

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

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 that you want to get.

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

The description of the environment.

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_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

GetExtension

getExtension_versionNumber :: Lens' GetExtension (Maybe Int) Source #

The extension version number. If no version number was defined, AppConfig uses the highest version.

getExtension_extensionIdentifier :: Lens' GetExtension Text Source #

The name, the ID, or the Amazon Resource Name (ARN) of the extension.

extension_actions :: Lens' Extension (Maybe (HashMap ActionPoint (NonEmpty Action))) Source #

The actions defined in the extension.

extension_arn :: Lens' Extension (Maybe Text) Source #

The system-generated Amazon Resource Name (ARN) for the extension.

extension_description :: Lens' Extension (Maybe Text) Source #

Information about the extension.

extension_id :: Lens' Extension (Maybe Text) Source #

The system-generated ID of the extension.

extension_name :: Lens' Extension (Maybe Text) Source #

The extension name.

extension_parameters :: Lens' Extension (Maybe (HashMap Text Parameter)) Source #

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.

extension_versionNumber :: Lens' Extension (Maybe Int) Source #

The extension version number.

GetExtensionAssociation

extensionAssociation_arn :: Lens' ExtensionAssociation (Maybe Text) Source #

The system-generated Amazon Resource Name (ARN) for the extension.

extensionAssociation_extensionArn :: Lens' ExtensionAssociation (Maybe Text) Source #

The ARN of the extension defined in the association.

extensionAssociation_extensionVersionNumber :: Lens' ExtensionAssociation (Maybe Int) Source #

The version number for the extension defined in the association.

extensionAssociation_id :: Lens' ExtensionAssociation (Maybe Text) Source #

The system-generated ID for the association.

extensionAssociation_parameters :: Lens' ExtensionAssociation (Maybe (HashMap Text Text)) Source #

The parameter names and values defined in the association.

extensionAssociation_resourceArn :: Lens' ExtensionAssociation (Maybe Text) Source #

The ARNs of applications, configuration profiles, or environments defined in the association.

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.

ListApplications

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.

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

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.

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.

ListConfigurationProfiles

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.

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

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

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

A filter based on the type of configurations that the configuration profile contains. A configuration can be a feature flag or a freeform configuration.

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.

ListDeploymentStrategies

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.

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

A token to start the list. Use this token 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.

ListDeployments

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

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_nextToken :: Lens' ListDeployments (Maybe Text) Source #

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.

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.

ListEnvironments

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.

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

A token to start the list. Use this token 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.

ListExtensionAssociations

listExtensionAssociations_extensionIdentifier :: Lens' ListExtensionAssociations (Maybe Text) Source #

The name, the ID, or the Amazon Resource Name (ARN) of the extension.

listExtensionAssociations_extensionVersionNumber :: Lens' ListExtensionAssociations (Maybe Int) Source #

The version number for the extension defined in the association.

listExtensionAssociations_maxResults :: Lens' ListExtensionAssociations (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.

listExtensionAssociations_nextToken :: Lens' ListExtensionAssociations (Maybe Text) Source #

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.

listExtensionAssociations_resourceIdentifier :: Lens' ListExtensionAssociations (Maybe Text) Source #

The ARN of an application, configuration profile, or environment.

listExtensionAssociationsResponse_items :: Lens' ListExtensionAssociationsResponse (Maybe [ExtensionAssociationSummary]) Source #

The list of extension associations. Each item represents an extension association to an application, environment, or configuration profile.

listExtensionAssociationsResponse_nextToken :: Lens' ListExtensionAssociationsResponse (Maybe Text) Source #

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

ListExtensions

listExtensions_maxResults :: Lens' ListExtensions (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.

listExtensions_nextToken :: Lens' ListExtensions (Maybe Text) Source #

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

listExtensionsResponse_items :: Lens' ListExtensionsResponse (Maybe [ExtensionSummary]) Source #

The list of available extensions. The list includes Amazon Web Services-authored and user-created extensions.

listExtensionsResponse_nextToken :: Lens' ListExtensionsResponse (Maybe Text) Source #

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

ListHostedConfigurationVersions

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.

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

A token to start the list. Use this token 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.

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.

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_applicationId :: Lens' Deployment (Maybe Text) Source #

The ID of the application that was deployed.

deployment_appliedExtensions :: Lens' Deployment (Maybe [AppliedExtension]) Source #

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.

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_configurationName :: Lens' Deployment (Maybe Text) Source #

The name of the configuration.

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

The ID of the configuration profile that was deployed.

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

The configuration version that was deployed.

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

Total amount of time the deployment lasted.

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

The sequence number of the deployment.

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

The ID of the deployment strategy that was deployed.

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

The description of the deployment.

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

The ID of the environment 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_finalBakeTimeInMinutes :: Lens' Deployment (Maybe Natural) Source #

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

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

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

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

The algorithm used to define how percentage grew over time.

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_state :: Lens' Deployment (Maybe DeploymentState) Source #

The state of the deployment.

StopDeployment

stopDeployment_deploymentNumber :: Lens' StopDeployment Int Source #

The sequence number of the deployment.

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

The ID of the application that was deployed.

deployment_appliedExtensions :: Lens' Deployment (Maybe [AppliedExtension]) Source #

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.

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_configurationName :: Lens' Deployment (Maybe Text) Source #

The name of the configuration.

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

The ID of the configuration profile that was deployed.

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

The configuration version that was deployed.

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

Total amount of time the deployment lasted.

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

The sequence number of the deployment.

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

The ID of the deployment strategy that was deployed.

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

The description of the deployment.

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

The ID of the environment 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_finalBakeTimeInMinutes :: Lens' Deployment (Maybe Natural) Source #

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

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

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

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

The algorithm used to define how percentage grew over time.

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_state :: Lens' Deployment (Maybe DeploymentState) Source #

The state of the deployment.

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.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The ARN of the resource for which to remove tags.

UpdateApplication

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

The description of the application.

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

The application name.

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_description :: Lens' ConfigurationProfile (Maybe Text) Source #

The configuration profile description.

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_retrievalRoleArn :: Lens' ConfigurationProfile (Maybe Text) Source #

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

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

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

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

A list of methods for validating the configuration.

UpdateDeploymentStrategy

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

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

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

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

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

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.

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

The description of the deployment strategy.

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

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

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

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

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

The algorithm used to define how percentage grew over time.

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

The name of the deployment strategy.

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

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

UpdateEnvironment

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

Amazon CloudWatch alarms to monitor during the deployment process.

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

The description of the environment.

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_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

UpdateExtension

updateExtension_description :: Lens' UpdateExtension (Maybe Text) Source #

Information about the extension.

updateExtension_parameters :: Lens' UpdateExtension (Maybe (HashMap Text Parameter)) Source #

One or more parameters for the actions called by the extension.

updateExtension_extensionIdentifier :: Lens' UpdateExtension Text Source #

The name, the ID, or the Amazon Resource Name (ARN) of the extension.

extension_actions :: Lens' Extension (Maybe (HashMap ActionPoint (NonEmpty Action))) Source #

The actions defined in the extension.

extension_arn :: Lens' Extension (Maybe Text) Source #

The system-generated Amazon Resource Name (ARN) for the extension.

extension_description :: Lens' Extension (Maybe Text) Source #

Information about the extension.

extension_id :: Lens' Extension (Maybe Text) Source #

The system-generated ID of the extension.

extension_name :: Lens' Extension (Maybe Text) Source #

The extension name.

extension_parameters :: Lens' Extension (Maybe (HashMap Text Parameter)) Source #

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.

extension_versionNumber :: Lens' Extension (Maybe Int) Source #

The extension version number.

UpdateExtensionAssociation

updateExtensionAssociation_parameters :: Lens' UpdateExtensionAssociation (Maybe (HashMap Text Text)) Source #

The parameter names and values defined in the extension.

extensionAssociation_arn :: Lens' ExtensionAssociation (Maybe Text) Source #

The system-generated Amazon Resource Name (ARN) for the extension.

extensionAssociation_extensionArn :: Lens' ExtensionAssociation (Maybe Text) Source #

The ARN of the extension defined in the association.

extensionAssociation_extensionVersionNumber :: Lens' ExtensionAssociation (Maybe Int) Source #

The version number for the extension defined in the association.

extensionAssociation_id :: Lens' ExtensionAssociation (Maybe Text) Source #

The system-generated ID for the association.

extensionAssociation_parameters :: Lens' ExtensionAssociation (Maybe (HashMap Text Text)) Source #

The parameter names and values defined in the association.

extensionAssociation_resourceArn :: Lens' ExtensionAssociation (Maybe Text) Source #

The ARNs of applications, configuration profiles, or environments defined in the association.

ValidateConfiguration

validateConfiguration_configurationVersion :: Lens' ValidateConfiguration Text Source #

The version of the configuration to validate.

Types

Action

action_description :: Lens' Action (Maybe Text) Source #

Information about the action.

action_name :: Lens' Action (Maybe Text) Source #

The action name.

action_roleArn :: Lens' Action (Maybe Text) Source #

An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

action_uri :: Lens' Action (Maybe Text) Source #

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

actionInvocation_errorCode :: Lens' ActionInvocation (Maybe Text) Source #

The error code when an extension invocation fails.

actionInvocation_errorMessage :: Lens' ActionInvocation (Maybe Text) Source #

The error message when an extension invocation fails.

actionInvocation_extensionIdentifier :: Lens' ActionInvocation (Maybe Text) Source #

The name, the ID, or the Amazon Resource Name (ARN) of the extension.

actionInvocation_invocationId :: Lens' ActionInvocation (Maybe Text) Source #

A system-generated ID for this invocation.

actionInvocation_roleArn :: Lens' ActionInvocation (Maybe Text) Source #

An Amazon Resource Name (ARN) for an Identity and Access Management assume role.

actionInvocation_uri :: Lens' ActionInvocation (Maybe Text) Source #

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

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

The description of the application.

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

The application name.

AppliedExtension

appliedExtension_extensionAssociationId :: Lens' AppliedExtension (Maybe Text) Source #

The system-generated ID for the association.

appliedExtension_extensionId :: Lens' AppliedExtension (Maybe Text) Source #

The system-generated ID of the extension.

appliedExtension_parameters :: Lens' AppliedExtension (Maybe (HashMap Text Text)) Source #

One or more parameters for the actions called by the extension.

ConfigurationProfile

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

The configuration profile description.

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_retrievalRoleArn :: Lens' ConfigurationProfile (Maybe Text) Source #

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

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

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

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

A list of methods for validating the configuration.

ConfigurationProfileSummary

configurationProfileSummary_type :: Lens' ConfigurationProfileSummary (Maybe Text) Source #

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

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

The types of validators in the configuration profile.

Deployment

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

The ID of the application that was deployed.

deployment_appliedExtensions :: Lens' Deployment (Maybe [AppliedExtension]) Source #

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.

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_configurationName :: Lens' Deployment (Maybe Text) Source #

The name of the configuration.

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

The ID of the configuration profile that was deployed.

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

The configuration version that was deployed.

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

Total amount of time the deployment lasted.

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

The sequence number of the deployment.

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

The ID of the deployment strategy that was deployed.

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

The description of the deployment.

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

The ID of the environment 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_finalBakeTimeInMinutes :: Lens' Deployment (Maybe Natural) Source #

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

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

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

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

The algorithm used to define how percentage grew over time.

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_state :: Lens' Deployment (Maybe DeploymentState) Source #

The state of the deployment.

DeploymentEvent

deploymentEvent_actionInvocations :: Lens' DeploymentEvent (Maybe [ActionInvocation]) Source #

The list of extensions that were invoked as part of the deployment.

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

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; and the start or completion of a rollback.

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

The date and time the event occurred.

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

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

DeploymentStrategy

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

The description of the deployment strategy.

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

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

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

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

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

The algorithm used to define how percentage grew over time.

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

The name of the deployment strategy.

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

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

DeploymentSummary

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

The sequence number of the deployment.

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

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

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

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

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

The algorithm used to define how percentage grows over time.

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

The percentage of targets for which the deployment is available.

Environment

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

The description of the environment.

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_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

Extension

extension_actions :: Lens' Extension (Maybe (HashMap ActionPoint (NonEmpty Action))) Source #

The actions defined in the extension.

extension_arn :: Lens' Extension (Maybe Text) Source #

The system-generated Amazon Resource Name (ARN) for the extension.

extension_description :: Lens' Extension (Maybe Text) Source #

Information about the extension.

extension_id :: Lens' Extension (Maybe Text) Source #

The system-generated ID of the extension.

extension_name :: Lens' Extension (Maybe Text) Source #

The extension name.

extension_parameters :: Lens' Extension (Maybe (HashMap Text Parameter)) Source #

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.

extension_versionNumber :: Lens' Extension (Maybe Int) Source #

The extension version number.

ExtensionAssociation

extensionAssociation_arn :: Lens' ExtensionAssociation (Maybe Text) Source #

The system-generated Amazon Resource Name (ARN) for the extension.

extensionAssociation_extensionArn :: Lens' ExtensionAssociation (Maybe Text) Source #

The ARN of the extension defined in the association.

extensionAssociation_extensionVersionNumber :: Lens' ExtensionAssociation (Maybe Int) Source #

The version number for the extension defined in the association.

extensionAssociation_id :: Lens' ExtensionAssociation (Maybe Text) Source #

The system-generated ID for the association.

extensionAssociation_parameters :: Lens' ExtensionAssociation (Maybe (HashMap Text Text)) Source #

The parameter names and values defined in the association.

extensionAssociation_resourceArn :: Lens' ExtensionAssociation (Maybe Text) Source #

The ARNs of applications, configuration profiles, or environments defined in the association.

ExtensionAssociationSummary

extensionAssociationSummary_extensionArn :: Lens' ExtensionAssociationSummary (Maybe Text) Source #

The system-generated Amazon Resource Name (ARN) for the extension.

extensionAssociationSummary_id :: Lens' ExtensionAssociationSummary (Maybe Text) Source #

The extension association ID. This ID is used to call other ExtensionAssociation API actions such as GetExtensionAssociation or DeleteExtensionAssociation.

extensionAssociationSummary_resourceArn :: Lens' ExtensionAssociationSummary (Maybe Text) Source #

The ARNs of applications, configuration profiles, or environments defined in the association.

ExtensionSummary

extensionSummary_arn :: Lens' ExtensionSummary (Maybe Text) Source #

The system-generated Amazon Resource Name (ARN) for the extension.

extensionSummary_id :: Lens' ExtensionSummary (Maybe Text) Source #

The system-generated ID of the extension.

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 Identity and Access Management (IAM) role for AppConfig to monitor AlarmArn.

monitor_alarmArn :: Lens' Monitor Text Source #

Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

Parameter

parameter_description :: Lens' Parameter (Maybe Text) Source #

Information about the parameter.

parameter_required :: Lens' Parameter (Maybe Bool) Source #

A parameter value must be specified in the extension association.

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 Lambda function.