View Source AWS.AppConfig (aws-elixir v1.0.0)
AppConfig feature flags and dynamic configurations help software builders quickly and securely adjust application behavior in production environments without full code deployments.
AppConfig speeds up software release frequency, improves application resiliency, and helps you address emergent issues more quickly. With feature flags, you can gradually release new capabilities to users and measure the impact of those changes before fully deploying the new capabilities to all users. With operational flags and dynamic configurations, you can update block lists, allow lists, throttling limits, logging verbosity, and perform other operational tuning to quickly respond to issues in production environments.
AppConfig is a capability of Amazon Web Services Systems Manager.
Despite the fact that application configuration content can vary greatly from application to application, AppConfig supports the following use cases, which cover a broad spectrum of customer needs:
*
Feature flags and toggles - Safely release new capabilities to your customers in a controlled environment. Instantly roll back changes if you experience a problem.
*
Application tuning - Carefully introduce application changes while testing the impact of those changes with users in production environments.
*
Allow list or block list - Control access to premium features or instantly block specific users without deploying new code.
*
Centralized configuration storage - Keep your configuration data organized and consistent across all of your workloads. You can use AppConfig to deploy configuration data stored in the AppConfig hosted configuration store, Secrets Manager, Systems Manager, Parameter Store, or Amazon S3.
How AppConfig works
This section provides a high-level description of how AppConfig works and how you get started.
Definitions
1. Identify configuration values in code you want to manage in the cloud
Before you start creating AppConfig artifacts, we recommend you identify configuration data in your code that you want to dynamically manage using AppConfig. Good examples include feature flags or toggles, allow and block lists, logging verbosity, service limits, and throttling rules, to name a few.
If your configuration data already exists in the cloud, you can take advantage of AppConfig validation, deployment, and extension features to further streamline configuration data management.
2. Create an application namespace
To create a namespace, you create an AppConfig artifact called an application. An application is simply an organizational construct like a folder.
3. Create environments
For each AppConfig application, you define one or more environments.
An environment is a logical grouping of targets, such as applications in a
Beta or Production environment, Lambda functions,
or containers. You can also define environments for application subcomponents,
such as the Web, Mobile, and
Back-end.
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.
4. Create a configuration profile
A configuration profile includes, among other things, a URI that enables
AppConfig to locate your configuration data in its stored location
and a profile type. AppConfig supports two configuration profile types:
feature flags and freeform configurations. Feature flag configuration profiles
store their data in the AppConfig hosted configuration store and the URI
is simply hosted. For freeform configuration profiles, you can store
your data in the AppConfig hosted configuration store or any Amazon Web Services
service that integrates with AppConfig, as described in Creating a free form configuration
profile
in the the AppConfig User Guide.
A configuration profile can also include optional validators to ensure your configuration data is syntactically and semantically correct. AppConfig performs a check using the validators when you start a deployment. If any errors are detected, the deployment rolls back to the previous configuration data.
5. Deploy configuration data
When you create a new deployment, you specify the following:
An application ID
A configuration profile ID
A configuration version
An environment ID where you want to deploy the configuration data
A deployment strategy ID that defines how fast you want the changes to take effect
When you call the StartDeployment API action, AppConfig performs the following tasks:
Retrieves the configuration data from the underlying data store by using the location URI in the configuration profile.
Verifies the configuration data is syntactically and semantically correct by using the validators you specified when you created your configuration profile.
Caches a copy of the data so it is ready to be retrieved by your application. This cached copy is called the deployed data.
6. Retrieve the configuration
You can configure AppConfig Agent as a local host and have the agent poll AppConfig for configuration updates. The agent calls the StartConfigurationSession and GetLatestConfiguration API actions and caches your configuration data locally. To retrieve the data, your application makes an HTTP call to the localhost server. AppConfig Agent supports several use cases, as described in Simplified retrieval methods in the the AppConfig User Guide.
If AppConfig Agent isn't supported for your use case, you can configure your application to poll AppConfig for configuration updates by directly calling the StartConfigurationSession and GetLatestConfiguration API actions.
This reference is intended to be used with the AppConfig User Guide.
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.
Creates an AppConfig extension.
When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile.
Creates a new configuration in the AppConfig hosted configuration store.
Deletes an application.
Deletes a configuration profile.
Deletes a deployment strategy.
Deletes an environment.
Deletes an AppConfig extension.
Deletes an extension association.
Deletes a version of a configuration from the AppConfig hosted configuration store.
Retrieves information about an application.
(Deprecated) Retrieves the latest deployed configuration.
Retrieves information about a configuration profile.
Retrieves information about a configuration deployment.
Retrieves information about a deployment strategy.
Retrieves information about an environment.
Returns information about an AppConfig extension.
Returns information about an AppConfig extension association.
Retrieves information about a specific configuration version.
Lists all applications in your Amazon Web Services account.
Lists the configuration profiles for an application.
Lists deployment strategies.
Lists the deployments for an environment in descending deployment number order.
Lists the environments for an application.
Lists all AppConfig extension associations in the account.
Lists all custom and Amazon Web Services authored AppConfig extensions in the account.
Lists configurations stored in the AppConfig hosted configuration store by version.
Retrieves the list of key-value tags assigned to the resource.
Starts a deployment.
Stops a deployment.
Assigns metadata to an AppConfig resource.
Deletes a tag key and value from an AppConfig resource.
Updates an application.
Updates a configuration profile.
Updates a deployment strategy.
Updates an environment.
Updates an AppConfig extension.
Updates an association.
Uses the validators in a configuration profile to validate a configuration.
Functions
Creates an application.
In AppConfig, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage configuration data for a mobile application installed by your users.
create_configuration_profile(client, application_id, input, options \\ [])
View SourceCreates a configuration profile, which is information that enables AppConfig to access the configuration source.
Valid configuration sources include the following:
* Configuration data in YAML, JSON, and other formats stored in the AppConfig hosted configuration store
* Configuration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket
* Pipelines stored in CodePipeline
* Secrets stored in Secrets Manager
* Standard and secure string parameters stored in Amazon Web Services Systems Manager Parameter Store
* Configuration data in SSM documents stored in the Systems Manager document store
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.
For more information, see Create a Configuration and a Configuration Profile in the AppConfig User Guide.
Creates 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 deployment group of AppConfig targets, such as applications in
a
Beta 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.
Creates an AppConfig extension.
An extension augments your ability to inject logic or behavior at different points during the AppConfig workflow of creating or deploying a configuration.
You can create your own extensions or use the Amazon Web Services authored
extensions provided by
AppConfig. For an AppConfig extension that uses Lambda, you must create a Lambda
function to perform any computation and processing
defined in the extension. If you plan to create custom versions of the Amazon
Web Services
authored notification extensions, you only need to specify an Amazon Resource
Name (ARN) in
the Uri field for the new extension version.
*
For a custom EventBridge notification extension, enter the ARN of the
EventBridge
default events in the Uri field.
*
For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS
topic in the Uri field.
*
For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS
message queue in the Uri field.
For more information about extensions, see Extending workflows in the AppConfig User Guide.
When you create an extension or configure an Amazon Web Services authored extension, you associate the extension with an AppConfig application, environment, or configuration profile.
For example, you can choose to run the
AppConfig
deployment events to Amazon SNSAmazon Web Services authored extension and receive notifications on an Amazon SNS topic anytime a configuration deployment is started for a specific application. Defining which extension to associate with an AppConfig resource is called an extension association. An extension association is a specified relationship between an extension and an AppConfig resource, such as an application or a configuration profile. For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
create_hosted_configuration_version(client, application_id, configuration_profile_id, input, options \\ [])
View SourceCreates a new configuration in the AppConfig hosted configuration store.
Deletes an application.
Deleting an application does not delete a configuration from a host.
delete_configuration_profile(client, application_id, configuration_profile_id, input, options \\ [])
View SourceDeletes a configuration profile.
Deleting a configuration profile does not delete a configuration from a host.
delete_deployment_strategy(client, deployment_strategy_id, input, options \\ [])
View SourceDeletes a deployment strategy.
Deleting a deployment strategy does not delete a configuration from a host.
delete_environment(client, application_id, environment_id, input, options \\ [])
View SourceDeletes an environment.
Deleting an environment does not delete a configuration from a host.
delete_extension(client, extension_identifier, input, options \\ [])
View SourceDeletes an AppConfig extension.
You must delete all associations to an extension before you delete the extension.
delete_extension_association(client, extension_association_id, input, options \\ [])
View SourceDeletes an extension association.
This action doesn't delete extensions defined in the association.
delete_hosted_configuration_version(client, application_id, configuration_profile_id, version_number, input, options \\ [])
View SourceDeletes a version of a configuration from the AppConfig hosted configuration store.
Retrieves information about an application.
get_configuration(client, application, configuration, environment, client_configuration_version \\ nil, client_id, options \\ [])
View Source(Deprecated) Retrieves the latest deployed configuration.
Note the following important information.
This API action is deprecated. Calls to receive configuration data should use the StartConfigurationSession and GetLatestConfiguration APIs instead.
GetConfiguration is a priced call. For more information, see
Pricing.
get_configuration_profile(client, application_id, configuration_profile_id, options \\ [])
View SourceRetrieves information about a configuration profile.
get_deployment(client, application_id, deployment_number, environment_id, options \\ [])
View SourceRetrieves information about a configuration deployment.
get_deployment_strategy(client, deployment_strategy_id, options \\ [])
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_environment(client, application_id, environment_id, options \\ [])
View SourceRetrieves information about an environment.
An environment is a deployment group of
AppConfig applications, such as applications in a Production
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_extension(client, extension_identifier, version_number \\ nil, options \\ [])
View SourceReturns information about an AppConfig extension.
get_extension_association(client, extension_association_id, options \\ [])
View SourceReturns information about an AppConfig extension association.
For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
get_hosted_configuration_version(client, application_id, configuration_profile_id, version_number, options \\ [])
View SourceRetrieves information about a specific configuration version.
list_applications(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all applications in your Amazon Web Services account.
list_configuration_profiles(client, application_id, max_results \\ nil, next_token \\ nil, type \\ nil, options \\ [])
View SourceLists the configuration profiles for an application.
list_deployment_strategies(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists deployment strategies.
list_deployments(client, application_id, environment_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the deployments for an environment in descending deployment number order.
list_environments(client, application_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists the environments for an application.
list_extension_associations(client, extension_identifier \\ nil, extension_version_number \\ nil, max_results \\ nil, next_token \\ nil, resource_identifier \\ nil, options \\ [])
View SourceLists all AppConfig extension associations in the account.
For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
list_extensions(client, max_results \\ nil, name \\ nil, next_token \\ nil, options \\ [])
View SourceLists all custom and Amazon Web Services authored AppConfig extensions in the account.
For more information about extensions, see Extending workflows in the AppConfig User Guide.
list_hosted_configuration_versions(client, application_id, configuration_profile_id, max_results \\ nil, next_token \\ nil, version_label \\ nil, options \\ [])
View SourceLists configurations stored in the AppConfig hosted configuration store by version.
Retrieves the list of key-value tags assigned to the resource.
start_deployment(client, application_id, environment_id, input, options \\ [])
View SourceStarts a deployment.
stop_deployment(client, application_id, deployment_number, environment_id, input, options \\ [])
View SourceStops a deployment.
This API action works only on deployments that have a status of
DEPLOYING. This action moves the deployment to a status of
ROLLED_BACK.
Assigns 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.
Deletes a tag key and value from an AppConfig resource.
Updates an application.
update_configuration_profile(client, application_id, configuration_profile_id, input, options \\ [])
View SourceUpdates a configuration profile.
update_deployment_strategy(client, deployment_strategy_id, input, options \\ [])
View SourceUpdates a deployment strategy.
update_environment(client, application_id, environment_id, input, options \\ [])
View SourceUpdates an environment.
update_extension(client, extension_identifier, input, options \\ [])
View SourceUpdates an AppConfig extension.
For more information about extensions, see Extending workflows in the AppConfig User Guide.
update_extension_association(client, extension_association_id, input, options \\ [])
View SourceUpdates an association.
For more information about extensions and associations, see Extending workflows in the AppConfig User Guide.
validate_configuration(client, application_id, configuration_profile_id, input, options \\ [])
View SourceUses the validators in a configuration profile to validate a configuration.