interface CfnEnvironmentMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.AppConfig.Mixins.CfnEnvironmentMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsappconfig/mixins#CfnEnvironmentMixinProps
Java	software.amazon.awscdk.mixins.preview.services.appconfig.mixins.CfnEnvironmentMixinProps
Python	aws_cdk.mixins_preview.aws_appconfig.mixins.CfnEnvironmentMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_appconfig » mixins » CfnEnvironmentMixinProps

Properties for CfnEnvironmentPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as appconfig_mixins } from '@aws-cdk/mixins-preview/aws-appconfig';
const cfnEnvironmentMixinProps: appconfig_mixins.CfnEnvironmentMixinProps = {
  applicationId: 'applicationId',
  deletionProtectionCheck: 'deletionProtectionCheck',
  description: 'description',
  monitors: [{
    alarmArn: 'alarmArn',
    alarmRoleArn: 'alarmRoleArn',
  }],
  name: 'name',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
applicationId?	string	The application ID.
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.
name?	string	A name for the environment.
tags?	CfnTag[]	Metadata to assign to the environment.

---

applicationId?

Type: string (optional)

The application ID.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-applicationid

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-deletionprotectioncheck

---

description?

Type: string (optional)

A description of the environment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-description

---

monitors?

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

Amazon CloudWatch alarms to monitor during the deployment process.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-monitors

---

name?

Type: string (optional)

A name for the environment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-name

---

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html#cfn-appconfig-environment-tags