View Source aws_appconfig (aws v0.5.0)
Use AppConfig, a capability of Amazon Web Services Systems Manager, to create, manage, and quickly deploy application configurations.
AppConfig supports controlled deployments to applications of any size and includes built-in validation checks and monitoring. You can use AppConfig with applications hosted on Amazon EC2 instances, Lambda, containers, mobile applications, or IoT devices.
To prevent errors when deploying application configurations, especially for production systems where a simple typo could cause an unexpected outage, AppConfig includes validators. A validator provides a syntactic or semantic check to ensure that the configuration you want to deploy works as intended. To validate your application configuration data, you provide a schema or an Amazon Web Services Lambda function that runs against the configuration. The configuration deployment or update can only proceed when the configuration data is valid.
During a configuration deployment, AppConfig monitors the application to ensure that the deployment is successful. If the system encounters an error, AppConfig rolls back the change to minimize impact for your application users. You can configure a deployment strategy for each application or environment that includes deployment criteria, including velocity, bake time, and alarms to monitor. Similar to error monitoring, if a deployment triggers an alarm, AppConfig automatically rolls back to the previous version.
AppConfig supports multiple use cases. Here are some examples:
Feature flags: Use AppConfig to turn on new features that require a timely deployment, such as a product launch or announcement.
Application tuning: Use AppConfig to carefully introduce changes to your application that can only be tested with production traffic.
Allow list: Use AppConfig to allow premium subscribers to access paid content.
Operational issues: Use AppConfig to reduce stress on your application when a dependency or other external factor impacts the system.
Link to this section Summary
Functions
Creates an application.
Creates a configuration profile, which is information that enables AppConfig to access the configuration source.
Creates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets.
Creates an environment.
Deletes an application.
Deletes a configuration profile.
Deletes a deployment strategy.
Deletes an environment.
Retrieves the latest deployed configuration.
Retrieves information about a deployment strategy.
Retrieves information about an environment.
Stops a deployment.
Assigns metadata to an AppConfig resource.
Link to this section Functions
Creates an application.
An application in AppConfig is a logical unit of code that provides capabilities for your customers. For example, an application can be a microservice that runs on Amazon EC2 instances, a mobile application installed by your users, a serverless application using Amazon API Gateway and Lambda, or any system you run on behalf of others.Creates a configuration profile, which is information that enables AppConfig to access the configuration source.
Valid configuration sources include the AppConfig hosted configuration store, Amazon Web Services Systems Manager (SSM) documents, SSM Parameter Store parameters, Amazon S3 objects, or any integration source action supported by CodePipeline. A configuration profile includes the following information:
The URI location of the configuration data.
The Identity and Access Management (IAM) role that provides access to the configuration data.
A validator for the configuration data. Available validators include either a JSON Schema or an Amazon Web Services Lambda function.
create_configuration_profile(Client, ApplicationId, Input0, Options0)
View SourceCreates a deployment strategy that defines important criteria for rolling out your configuration to the designated targets.
A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.Creates an environment.
For each application, you define one or more environments. An environment is a logical deployment group of AppConfig targets, such as applications in aBeta
or Production
environment. You can also define environments for application subcomponents such as the Web
, Mobile
and Back-end
components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.
create_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, Input)
View Sourcecreate_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, Input0, Options0)
View SourceDeletes an application.
Deleting an application does not delete a configuration from a host.delete_configuration_profile(Client, ApplicationId, ConfigurationProfileId, Input)
View SourceDeletes a configuration profile.
Deleting a configuration profile does not delete a configuration from a host.delete_configuration_profile(Client, ApplicationId, ConfigurationProfileId, Input0, Options0)
View SourceDeletes a deployment strategy.
Deleting a deployment strategy does not delete a configuration from a host.delete_deployment_strategy(Client, DeploymentStrategyId, Input0, Options0)
View SourceDeletes an environment.
Deleting an environment does not delete a configuration from a host.delete_environment(Client, ApplicationId, EnvironmentId, Input0, Options0)
View Sourcedelete_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, VersionNumber, Input)
View Sourcedelete_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, VersionNumber, Input0, Options0)
View Sourceget_application(Client, ApplicationId, QueryMap, HeadersMap, Options0)
View Sourceget_configuration(Client, Application, Configuration, Environment, ClientId)
View SourceRetrieves the latest deployed configuration.
Note the following important information.
This API action has been deprecated. Calls to receive configuration data should use the StartConfigurationSession and GetLatestConfiguration APIs instead.
GetConfiguration
is a priced call. For more information, see Pricing.
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.
GetConfiguration
, we recommend that you include the ClientConfigurationVersion
value with every call to GetConfiguration
. The value to use for ClientConfigurationVersion
comes from the ConfigurationVersion
attribute returned by GetConfiguration
when there is new or updated data, and should be saved for subsequent calls to GetConfiguration
.
get_configuration(Client, Application, Configuration, Environment, ClientId, QueryMap, HeadersMap)
View Sourceget_configuration(Client, Application, Configuration, Environment, ClientId, QueryMap, HeadersMap, Options0)
View Sourceget_configuration_profile(Client, ApplicationId, ConfigurationProfileId)
View Sourceget_configuration_profile(Client, ApplicationId, ConfigurationProfileId, QueryMap, HeadersMap)
View Sourceget_configuration_profile(Client, ApplicationId, ConfigurationProfileId, QueryMap, HeadersMap, Options0)
View Sourceget_deployment(Client, ApplicationId, DeploymentNumber, EnvironmentId)
View Sourceget_deployment(Client, ApplicationId, DeploymentNumber, EnvironmentId, QueryMap, HeadersMap)
View Sourceget_deployment(Client, ApplicationId, DeploymentNumber, EnvironmentId, QueryMap, HeadersMap, Options0)
View SourceRetrieves information about a deployment strategy.
A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.get_deployment_strategy(Client, DeploymentStrategyId, QueryMap, HeadersMap)
View Sourceget_deployment_strategy(Client, DeploymentStrategyId, QueryMap, HeadersMap, Options0)
View SourceRetrieves information about an environment.
An environment is a logical deployment group of AppConfig applications, such as applications in aProduction
environment or in an EU_Region
environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.
get_environment(Client, ApplicationId, EnvironmentId, QueryMap, HeadersMap)
View Sourceget_environment(Client, ApplicationId, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourceget_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, VersionNumber)
View Sourceget_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, VersionNumber, QueryMap, HeadersMap)
View Sourceget_hosted_configuration_version(Client, ApplicationId, ConfigurationProfileId, VersionNumber, QueryMap, HeadersMap, Options0)
View Sourcelist_configuration_profiles(Client, ApplicationId, QueryMap, HeadersMap)
View Sourcelist_configuration_profiles(Client, ApplicationId, QueryMap, HeadersMap, Options0)
View Sourcelist_deployment_strategies(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_deployments(Client, ApplicationId, EnvironmentId, QueryMap, HeadersMap)
View Sourcelist_deployments(Client, ApplicationId, EnvironmentId, QueryMap, HeadersMap, Options0)
View Sourcelist_environments(Client, ApplicationId, QueryMap, HeadersMap, Options0)
View Sourcelist_hosted_configuration_versions(Client, ApplicationId, ConfigurationProfileId)
View Sourcelist_hosted_configuration_versions(Client, ApplicationId, ConfigurationProfileId, QueryMap, HeadersMap)
View Sourcelist_hosted_configuration_versions(Client, ApplicationId, ConfigurationProfileId, QueryMap, HeadersMap, Options0)
View Sourcelist_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Sourcestart_deployment(Client, ApplicationId, EnvironmentId, Input0, Options0)
View Sourcestop_deployment(Client, ApplicationId, DeploymentNumber, EnvironmentId, Input)
View SourceStops a deployment.
This API action works only on deployments that have a status ofDEPLOYING
. This action moves the deployment to a status of ROLLED_BACK
.
stop_deployment(Client, ApplicationId, DeploymentNumber, EnvironmentId, Input0, Options0)
View SourceAssigns metadata to an AppConfig resource.
Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define. You can specify a maximum of 50 tags for a resource.