AWS::AppConfig::EnvironmentCfnEnvironment
The `AWS::AppConfig::Environment` resource creates an environment, which is a logical deployment group of AWS AppConfig targets, such as applications in a `Beta` or `Production` environment. You define one or more environments for each AWS AppConfig application. 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. AWS AppConfig requires that you create resources and deploy a configuration in the following order: - Create an application - Create an environment - Create a configuration profile - Choose a pre-defined deployment strategy or create your own - Deploy the configuration For more information, see [AWS AppConfig](https://docs.aws.amazon.com/appconfig/latest/userguide/what-is-appconfig.html) in the *AWS AppConfig User Guide* .
Import
import { CfnEnvironment } from 'aws-cdk-lib/aws-appconfig';Or use the module namespace:
import * as appconfig from 'aws-cdk-lib/aws-appconfig';
// appconfig.CfnEnvironmentProperties
Configuration passed to the constructor as CfnEnvironmentProps.
applicationIdRequiredstring | IApplicationRefThe application ID.
nameRequiredstringA name for the environment.
deletionProtectionCheckOptionalstringA parameter to configure deletion protection. Deletion protection prevents a user from deleting an environment if your application called either [GetLatestConfiguration](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_appconfigdata_GetLatestConfiguration.html) or [GetConfiguration](https://docs.aws.amazon.com/appconfig/2019-10-09/APIReference/API_GetConfiguration.html) in the environment during the specified interval. This parameter supports the following values: - `BYPASS` : Instructs AWS AppConfig to bypass the deletion protection check and delete a configuration profile even if deletion protection would have otherwise prevented it. - `APPLY` : Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. `APPLY` also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks. - `ACCOUNT_DEFAULT` : The default setting, which instructs AWS AppConfig to implement the deletion protection value specified in the `UpdateAccountSettings` API.
descriptionOptionalstringA description of the environment.
monitorsOptionalIResolvable | IResolvable | MonitorsProperty[]Amazon CloudWatch alarms to monitor during the deployment process.
tagsOptionalCfnTag[]Metadata to assign to the environment. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-appconfigAWS::AppConfig::Environment