AWS appconfig documentation change
Summary
Restructured content organization, added video introduction, removed redundant sections, and enhanced documentation links. Added explicit requirement for IAM role configuration to enable automatic rollback monitoring.
Security assessment
The change adds documentation about configuring IAM roles for CloudWatch alarm integration with automatic rollback ('To use this feature, you must create an AWS IAM role...'). This clarifies security best practices but does not indicate a specific security vulnerability being addressed.
Diff
diff --git a/appconfig/latest/userguide/what-is-appconfig.md b/appconfig/latest/userguide/what-is-appconfig.md index e1851916e..45a9a25ba 100644 --- a//appconfig/latest/userguide/what-is-appconfig.md +++ b//appconfig/latest/userguide/what-is-appconfig.md @@ -5 +5 @@ -AWS AppConfig use casesBenefits of using AWS AppConfigHow AWS AppConfig worksGet started with AWS AppConfigSDKsPricing for AWS AppConfigAWS AppConfig quotas +Get started with AWS AppConfigAWS AppConfig use casesBenefits overviewHow AWS AppConfig worksPricing for AWS AppConfig @@ -9 +9 @@ AWS AppConfig use casesBenefits of using AWS AppConfigHow AWS AppConfig worksGet -AWS AppConfig feature flags and dynamic configurations help software builders quickly and securely adjust application behavior in production environments without full code deployments. AWS 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. +AWS AppConfig feature flags and dynamic configurations help software builders quickly and securely adjust application behavior in production environments without full code deployments. AWS AppConfig speeds up software release frequency, improves application resiliency, and helps you address emergent issues more quickly. @@ -11,17 +11 @@ AWS AppConfig feature flags and dynamic configurations help software builders qu -###### Note - -AWS AppConfig is a tool in AWS Systems Manager. - -**Improve efficiency and release changes faster** - -Using feature flags with new capabilities speeds up the process of releasing changes to production environments. Instead of relying on long-lived development branches that require complicated merges before a release, feature flags enable you to write software using trunk-based development. Feature flags enable you to safely roll out pre-release code in a CI/CD pipeline that is hidden from users. When you are ready to release the changes, you can update the feature flag without deploying new code. After the launch is complete, the flag can still function as a block switch to disable a new feature or capability without the need to roll back the code deployment. - -**Avoid unintended changes or failures with built-in safety features** - -AWS AppConfig offers the following safety features to help you avoid enabling feature flags or updating configuration data that could cause application failures. - - * **Validators** : A validator ensures that your configuration data is syntactically and semantically correct before deploying the changes to production environments. - - * **Deployment strategies** : A deployment strategy enables you to slowly release changes to production environments over minutes or hours. - - * **Monitoring and automatic rollback** : AWS AppConfig integrates with Amazon CloudWatch to monitor changes to your applications. If your application becomes unhealthy because of a bad configuration change and that change triggers an alarm in CloudWatch, AWS AppConfig automatically rolls back the change to minimize impact on your application users. +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. @@ -28,0 +13 @@ AWS AppConfig offers the following safety features to help you avoid enabling fe +## **Get started with AWS AppConfig** @@ -29,0 +15 @@ AWS AppConfig offers the following safety features to help you avoid enabling fe +The following video can help you understand the capabilities of AWS AppConfig. @@ -30,0 +17 @@ AWS AppConfig offers the following safety features to help you avoid enabling fe +###### Video: Introduction to AWS AppConfig @@ -32 +19 @@ AWS AppConfig offers the following safety features to help you avoid enabling fe -**Secure and scalable feature flag deployments** +View a video introduction to AWS AppConfig capabilities. @@ -34 +21 @@ AWS AppConfig offers the following safety features to help you avoid enabling fe -AWS AppConfig integrates with AWS Identity and Access Management (IAM) to provide fine-grain, role-based access to the service. AWS AppConfig also integrates with AWS Key Management Service (AWS KMS) for encryption and AWS CloudTrail for auditing. Before being released to external customers, all AWS AppConfig safety controls were initially developed with and validated by internal customers that use the service at scale. +View more AWS videos on the [Amazon Web Services YouTube Channel](https://www.youtube.com/user/AmazonWebServices). @@ -38 +25 @@ AWS AppConfig integrates with AWS Identity and Access Management (IAM) to provid -Despite the fact that application configuration content can vary greatly from application to application, AWS AppConfig supports the following use cases, which cover a broad spectrum of customer needs: +AWS AppConfig supports a broad spectrum of use cases: @@ -51 +38 @@ Despite the fact that application configuration content can vary greatly from ap -## Benefits of using AWS AppConfig +## Benefits overview @@ -53 +40 @@ Despite the fact that application configuration content can vary greatly from ap -AWS AppConfig offers the following benefits for your organization: +The following brief overview outlines the benefits of using AWS AppConfig. @@ -55 +42 @@ AWS AppConfig offers the following benefits for your organization: - * **Reduce unexpected down time for your customers** +**Improve efficiency and release changes faster** @@ -57 +43,0 @@ AWS AppConfig offers the following benefits for your organization: -AWS AppConfig reduces application downtime by enabling you to create rules to validate your configuration. Configurations that aren't valid can't be deployed. AWS AppConfig provides the following two options for validating configurations: @@ -59 +45 @@ AWS AppConfig reduces application downtime by enabling you to create rules to va - * For syntactic validation, you can use a JSON schema. AWS AppConfig validates your configuration by using the JSON schema to ensure that configuration changes adhere to the application requirements. +Using feature flags with new capabilities speeds up the process of releasing changes to production environments. Instead of relying on long-lived development branches that require complicated merges before a release, feature flags enable you to write software using trunk-based development. Feature flags enable you to safely roll out pre-release code in a CI/CD pipeline that is hidden from users. When you are ready to release the changes, you can update the feature flag without deploying new code. After the launch is complete, the flag can still function as a block switch to disable a new feature or capability without the need to roll back the code deployment. @@ -61 +47 @@ AWS AppConfig reduces application downtime by enabling you to create rules to va - * For semantic validation, AWS AppConfig can call an AWS Lambda function that you own to validate the data within your configuration. +**Avoid unintended changes or failures with built-in safety features** @@ -63 +48,0 @@ AWS AppConfig reduces application downtime by enabling you to create rules to va - * **Quickly deploy changes across a set of targets** @@ -65 +50 @@ AWS AppConfig reduces application downtime by enabling you to create rules to va -AWS AppConfig simplifies the administration of applications at scale by deploying configuration changes from a central location. AWS AppConfig supports configurations stored in the AWS AppConfig hosted configuration store, Systems Manager Parameter Store, Systems Manager (SSM) documents, and Amazon S3. You can use AWS AppConfig with applications hosted on EC2 instances, AWS Lambda, containers, mobile applications, or IoT devices. +AWS AppConfig offers the following safety features to help you avoid enabling feature flags or updating configuration data that could cause application failures. @@ -67 +52 @@ AWS AppConfig simplifies the administration of applications at scale by deployin -Targets don't need to be configured with the Systems Manager SSM Agent or the IAM instance profile required by other Systems Manager tools. This means that AWS AppConfig works with unmanaged instances. + * **Validators** : A validator ensures that your configuration data is syntactically and semantically correct before deploying the changes to production environments. @@ -69 +54 @@ Targets don't need to be configured with the Systems Manager SSM Agent or the IA - * **Update applications without interruptions** + * **Deployment strategies** : A deployment strategy enables you to slowly release changes to production environments over minutes or hours. @@ -71 +56 @@ Targets don't need to be configured with the Systems Manager SSM Agent or the IA -AWS AppConfig deploys configuration changes to your targets at runtime without a heavy-weight build process or taking your targets out of service. + * **Monitoring and automatic rollback** : AWS AppConfig integrates with Amazon CloudWatch to monitor changes to your applications. If your application becomes unhealthy because of a bad configuration change and that change triggers an alarm in CloudWatch, AWS AppConfig automatically rolls back the change to minimize impact on your application users. @@ -73 +57,0 @@ AWS AppConfig deploys configuration changes to your targets at runtime without a - * **Control deployment of changes across your application** @@ -75 +58,0 @@ AWS AppConfig deploys configuration changes to your targets at runtime without a -When deploying configuration changes to your targets, AWS AppConfig enables you to minimize risk by using a deployment strategy. Deployment strategies allow you to slowly roll out configuration changes to your fleet. If you experience a problem during the deployment, you can roll back the configuration change before it reaches the majority of yours hosts. @@ -77,0 +61 @@ When deploying configuration changes to your targets, AWS AppConfig enables you +**Secure and scalable feature flag deployments** @@ -79,0 +64,2 @@ When deploying configuration changes to your targets, AWS AppConfig enables you +AWS AppConfig integrates with AWS Identity and Access Management (IAM) to provide fine-grain, role-based access to the service. AWS AppConfig also integrates with AWS Key Management Service (AWS KMS) for encryption and AWS CloudTrail for auditing. Before being released to external customers, all AWS AppConfig safety controls were initially developed with and validated by internal customers that use the service at scale. + @@ -94 +80 @@ If your configuration data already exists in the cloud, you can take advantage o -To create a namespace, you create an AWS AppConfig artifact called an application. An application is simply an organizational construct like a folder. +To create a namespace, you create an AWS AppConfig artifact called an application. An application is simply an organizational construct like a folder. For more information, see [Creating a namespace for your application in AWS AppConfig](./appconfig-creating-namespace.html). @@ -99 +85 @@ To create a namespace, you create an AWS AppConfig artifact called an applicatio -For each AWS 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, AWS Lambda functions, or containers. You can also define environments for application subcomponents, such as the `Web`, `Mobile`, and `Back-end`. +For each AWS 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, AWS Lambda functions, or containers. You can also define environments for application subcomponents, such as the `Web`, `Mobile`, and `Back-end`. For more information, see [Creating environments for your application in AWS AppConfig](./appconfig-creating-environment.html). @@ -101 +87 @@ For each AWS AppConfig application, you define one or more environments. An envi -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. +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. To use this feature, you must create an AWS Identity and Access Management role so that AWS AppConfig can monitor alarms. For more information, see [Configure permissions for automatic rollback](./setting-up-appconfig.html#getting-started-with-appconfig-cloudwatch-alarms-permissions). @@ -106 +92 @@ You can configure Amazon CloudWatch alarms for each environment. The system moni -A configuration profile includes, among other things, a URI that enables AWS AppConfig to locate your configuration data in its stored location and a profile type. AWS AppConfig supports two configuration profile types: feature flags and freeform configurations. Feature flag configuration profiles store their data in the AWS AppConfig hosted configuration store and the URI is simply `hosted`. For freeform configuration profiles, you can store your data in the AWS AppConfig hosted configuration store or any AWS service that integrates with AWS AppConfig, as described in [Creating a free form configuration profile in AWS AppConfig](./appconfig-free-form-configurations-creating.html). +A configuration profile includes, among other things, a URI that enables AWS AppConfig to locate your configuration data in its stored location and a profile type. AWS AppConfig supports two configuration profile types: feature flags and freeform configurations. Feature flag configuration profiles store their data in the AWS AppConfig hosted configuration store and the URI is simply `hosted`. For freeform configuration profiles, you can store your data in the AWS AppConfig hosted configuration store or any AWS service that integrates with AWS AppConfig, as described in [Creating a free form configuration profile in AWS AppConfig](./appconfig-free-form-configurations-creating.html). For more information about creating a configuration profile, see [Creating a configuration profile in AWS AppConfig](./appconfig-creating-configuration-profile.html). @@ -128 +114 @@ When you create a new deployment, you specify the following: -When you call the [StartDeployment](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_StartDeployment.html) API action, AWS AppConfig performs the following tasks: +When you start a deployment, AWS AppConfig performs the following tasks: @@ -138,0 +125,2 @@ When you call the [StartDeployment](https://docs.aws.amazon.com/appconfig/2019-1 +For more information about deploying a configuration, see [Deploying feature flags and configuration data in AWS AppConfig](./deploying-feature-flags.html). + @@ -146,43 +134 @@ If AWS AppConfig Agent isn't supported for your use case, you can configure your -## **Get started with AWS AppConfig** - -The following resources can help you work directly with AWS AppConfig. - -###### Video: Introduction to AWS AppConfig feature flags - -View a video introduction to AWS AppConfig feature flag capabilities. - -View more AWS videos on the [Amazon Web Services YouTube Channel](https://www.youtube.com/user/AmazonWebServices). - -The following blogs can help you learn more about AWS AppConfig and its capabilities: - - * [Using AWS AppConfig feature flags](https://aws.amazon.com/blogs/mt/using-aws-appconfig-feature-flags/) - - * [Best Practices for validating AWS AppConfig Feature Flags and Configuration Data](https://aws.amazon.com/blogs/mt/best-practices-for-validating-aws-appconfig-feature-flags-and-configuration-data/) - - - - -## SDKs - -For information about AWS AppConfig language-specific SDKs, see the following resources: - - * [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/appconfig-2019-10-09/) - - * [AWS SDK for .NET](https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/AppConfig/NAppConfig.html) - - * [AWS SDK for C++](https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-appconfig/html/namespace_aws_1_1_app_config.html) - - * [AWS SDK for Go](https://docs.aws.amazon.com/sdk-for-go/api/service/appconfig/) - - * [AWS SDK for Java V2](https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/appconfig/package-summary.html) - - * [AWS SDK for JavaScript](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/AppConfig.html) - - * [AWS SDK for PHP V3](https://docs.aws.amazon.com/aws-sdk-php/v3/api/namespace-Aws.AppConfig.html) - - * [AWS SDK for Python](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/appconfig.html) - - * [AWS SDK for Ruby V3](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/AppConfig.html) - - - +For more information about retrieving a configuration, see [Retrieving feature flags and configuration data in AWS AppConfig](./retrieving-feature-flags.html). @@ -194,8 +139,0 @@ Pricing for AWS AppConfig is pay-as-you-go based on configuration data and featu -## AWS AppConfig quotas - -Information about AWS AppConfig endpoints and service quotas along with other Systems Manager quotas is in the [Amazon Web Services General Reference](https://docs.aws.amazon.com/general/latest/gr/appconfig.html). - -###### Note - -For information about quotas for services that store AWS AppConfig configurations, see [Understanding configuration store quotas and limitations](./appconfig-creating-configuration-and-profile-quotas.html). - @@ -208 +146 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Setting up AWS AppConfig +AWS AppConfig quotas