interface CfnEnvironmentProps

Language	Type name
.NET	`Amazon.CDK.AWS.AppConfig.CfnEnvironmentProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappconfig#CfnEnvironmentProps`
Java	`software.amazon.awscdk.services.appconfig.CfnEnvironmentProps`
Python	`aws_cdk.aws_appconfig.CfnEnvironmentProps`
TypeScript	`aws-cdk-lib` » `aws_appconfig` » `CfnEnvironmentProps`

Properties for defining a CfnEnvironment.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appconfig as appconfig } from 'aws-cdk-lib';
const cfnEnvironmentProps: appconfig.CfnEnvironmentProps = {
  applicationId: 'applicationId',
  name: 'name',

  // the properties below are optional
  deletionProtectionCheck: 'deletionProtectionCheck',
  description: 'description',
  monitors: [{
    alarmArn: 'alarmArn',
    alarmRoleArn: 'alarmRoleArn',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
applicationId	`string`	The application ID.
name	`string`	A name for the environment.
deletionProtectionCheck?	`string`	A parameter to configure deletion protection.
description?	`string`	A description of the environment.
monitors?	`IResolvable` `\|` `IResolvable` `\|` `MonitorsProperty[]`	Amazon CloudWatch alarms to monitor during the deployment process.
tags?	`CfnTag[]`	Metadata to assign to the environment.

applicationId

Type: string

The application ID.

name

Type: string

A name for the environment.

deletionProtectionCheck?

Type: string (optional)

A parameter to configure deletion protection.

Deletion protection prevents a user from deleting an environment if your application called either GetLatestConfiguration or GetConfiguration 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.

description?

Type: string (optional)

A description of the environment.

monitors?

Type: IResolvable | IResolvable | MonitorsProperty[] (optional)

Amazon CloudWatch alarms to monitor during the deployment process.

tags?

Type: CfnTag[] (optional)

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.