Skip to content
v2.274.0

EnvironmentProps Struct ​

Properties for the Environment construct.

Example ​

ts
const app = new appconfig.Application(this, 'MyApp');
const env = new appconfig.Environment(this, 'MyEnv', {
  application: app,
});

new appconfig.HostedConfiguration(this, 'MyFirstHostedConfig', {
  application: app,
  deployTo: [env],
  content: appconfig.ConfigurationContent.fromInlineText('This is my first configuration content.'),
});

new appconfig.HostedConfiguration(this, 'MySecondHostedConfig', {
  application: app,
  deployTo: [env],
  content: appconfig.ConfigurationContent.fromInlineText('This is my second configuration content.'),
});

Properties ​

applicationIApplicationapplicationIApplicationapplicationIApplicationApplicationIApplicationApplicationIApplicationrequired#
The application to be associated with the environment.
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.