Skip to content
v2.274.0

EnvironmentOptions Struct ​

Options for the Environment construct.

Example ​

ts
// 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 ​

deletionProtectionCheckoptionalDeletionProtectionCheckdeletion_protection_checkoptionalDeletionProtectionCheckdeletionProtectionCheckoptionalDeletionProtectionCheckDeletionProtectionCheckoptionalDeletionProtectionCheckDeletionProtectionCheckoptionalDeletionProtectionCheck#
A property to prevent accidental deletion of active environments.

Default: undefined - AppConfig default is ACCOUNT_DEFAULT

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the environment.

Default: No description.

environmentNameoptionalstringenvironment_nameoptionalstrenvironmentNameoptionalStringEnvironmentNameoptionalstringEnvironmentNameoptional*string#
The name of the environment.

Default: A name is generated.

monitorsoptionalMonitor[]monitorsoptionaltyping.List[Monitor]monitorsoptionalList<Monitor>MonitorsoptionalMonitor[]Monitorsoptional*[]Monitor#
The monitors for the environment.

Default: No monitors.