interface EnvironmentOptions

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

Options for the Environment construct.

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';

declare const monitor: appconfig.Monitor;
const environmentOptions: appconfig.EnvironmentOptions = {
  deletionProtectionCheck: appconfig.DeletionProtectionCheck.ACCOUNT_DEFAULT,
  description: 'description',
  environmentName: 'environmentName',
  monitors: [monitor],
};

Properties

Name	Type	Description
deletionProtectionCheck?	`DeletionProtectionCheck`	A property to prevent accidental deletion of active environments.
description?	`string`	The description of the environment.
environmentName?	`string`	The name of the environment.
monitors?	`Monitor[]`	The monitors for the environment.

deletionProtectionCheck?

Type: DeletionProtectionCheck (optional, default: undefined - AppConfig default is ACCOUNT_DEFAULT)

A property to prevent accidental deletion of active environments.

description?

Type: string (optional, default: No description.)

The description of the environment.

environmentName?

Type: string (optional, default: A name is generated.)

The name of the environment.

monitors?

Type: Monitor[] (optional, default: No monitors.)

The monitors for the environment.