Package software.amazon.awscdk.services.appconfig

Interface CfnEnvironmentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:30.672Z")
@Stability(Stable)
public interface CfnEnvironmentProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.appconfig.*;
 CfnEnvironmentProps cfnEnvironmentProps = CfnEnvironmentProps.builder()
         .applicationId("applicationId")
         .name("name")
         // the properties below are optional
         .deletionProtectionCheck("deletionProtectionCheck")
         .description("description")
         .monitors(List.of(MonitorsProperty.builder()
                 .alarmArn("alarmArn")
                 .alarmRoleArn("alarmRoleArn")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEnvironmentProps.Builder	A builder for CfnEnvironmentProps
static final class	CfnEnvironmentProps.Jsii$Proxy	An implementation for CfnEnvironmentProps

Method Summary

Modifier and Type	Method	Description
static CfnEnvironmentProps.Builder	builder()
String	getApplicationId()	The application ID.
default String	getDeletionProtectionCheck()	A parameter to configure deletion protection.
default String	getDescription()	A description of the environment.
default Object	getMonitors()	Amazon CloudWatch alarms to monitor during the deployment process.
String	getName()	A name for the environment.
default List<CfnTag>	getTags()	Metadata to assign to the environment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

@Stability(Stable)
@NotNull
String getApplicationId()

The application ID.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

A name for the environment.

See Also:

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

getDeletionProtectionCheck

@Stability(Stable)
@Nullable
default String getDeletionProtectionCheck()

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the environment.

See Also:

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

getMonitors

@Stability(Stable)
@Nullable
default Object getMonitors()

Amazon CloudWatch alarms to monitor during the deployment process.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEnvironment.MonitorsProperty>

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

builder

@Stability(Stable)
static CfnEnvironmentProps.Builder builder()

Returns:

a CfnEnvironmentProps.Builder of CfnEnvironmentProps