Package software.amazon.awscdk.services.appconfig

Interface IEnvironment

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IEnvironmentRef, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IEnvironment.Jsii$Default

All Known Implementing Classes:

Environment, IEnvironment.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:04.528Z")
@Stability(Stable)
public interface IEnvironment
extends software.amazon.jsii.JsiiSerializable, IResource, IEnvironmentRef

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IEnvironment.Jsii$Default	Internal default implementation for IEnvironment.
static final class	IEnvironment.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
void	addDeployment(IConfiguration configuration)	Creates a deployment of the supplied configuration to this environment.
void	addDeployments(IConfiguration... configurations)	Creates a deployment for each of the supplied configurations to this environment.
void	addExtension(IExtension extension)	Adds an extension association to the environment.
void	atDeploymentTick(IEventDestination eventDestination)	Adds an AT_DEPLOYMENT_TICK extension with the provided event destination and also creates an extension association to an application.
void	atDeploymentTick(IEventDestination eventDestination, ExtensionOptions options)	Adds an AT_DEPLOYMENT_TICK extension with the provided event destination and also creates an extension association to an application.
default IApplication	getApplication()	The application associated with the environment.
String	getApplicationId()	The ID of the application associated to the environment.
default String	getDescription()	The description of the environment.
ResourceEnvironment	getEnv()	The environment this resource belongs to.
String	getEnvironmentArn()	The Amazon Resource Name (ARN) of the environment.
String	getEnvironmentId()	The ID of the environment.
default List<Monitor>	getMonitors()	The monitors for the environment.
default String	getName()	The name of the environment.
software.constructs.Node	getNode()	The tree node.
Grant	grant(IGrantable grantee, String... actions)	Adds an IAM policy statement associated with this environment to an IAM principal's policy.
Grant	grantReadConfig(IGrantable grantee)	Permits an IAM principal to perform read operations on this environment's configurations.
void	on(ActionPoint actionPoint, IEventDestination eventDestination)	Adds an extension defined by the action point and event destination and also creates an extension association to the environment.
void	on(ActionPoint actionPoint, IEventDestination eventDestination, ExtensionOptions options)	Adds an extension defined by the action point and event destination and also creates an extension association to the environment.
void	onDeploymentBaking(IEventDestination eventDestination)	Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the environment.
void	onDeploymentBaking(IEventDestination eventDestination, ExtensionOptions options)	Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the environment.
void	onDeploymentComplete(IEventDestination eventDestination)	Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the environment.
void	onDeploymentComplete(IEventDestination eventDestination, ExtensionOptions options)	Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the environment.
void	onDeploymentRolledBack(IEventDestination eventDestination)	Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the environment.
void	onDeploymentRolledBack(IEventDestination eventDestination, ExtensionOptions options)	Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the environment.
void	onDeploymentStart(IEventDestination eventDestination)	Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the environment.
void	onDeploymentStart(IEventDestination eventDestination, ExtensionOptions options)	Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the environment.
void	onDeploymentStep(IEventDestination eventDestination)	Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the environment.
void	onDeploymentStep(IEventDestination eventDestination, ExtensionOptions options)	Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the environment.
void	preCreateHostedConfigurationVersion(IEventDestination eventDestination)	Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the environment.
void	preCreateHostedConfigurationVersion(IEventDestination eventDestination, ExtensionOptions options)	Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the environment.
void	preStartDeployment(IEventDestination eventDestination)	Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the environment.
void	preStartDeployment(IEventDestination eventDestination, ExtensionOptions options)	Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the environment.

Methods inherited from interface software.amazon.awscdk.interfaces.appconfig.IEnvironmentRef

getEnvironmentRef

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

@Stability(Stable)
@NotNull
String getApplicationId()

The ID of the application associated to the environment.

getEnvironmentArn

@Stability(Stable)
@NotNull
String getEnvironmentArn()

The Amazon Resource Name (ARN) of the environment.

getEnvironmentId

@Stability(Stable)
@NotNull
String getEnvironmentId()

The ID of the environment.

getApplication

@Stability(Stable)
@Nullable
default IApplication getApplication()

The application associated with the environment.

getDescription

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

The description of the environment.

getMonitors

@Stability(Stable)
@Nullable
default List<Monitor> getMonitors()

The monitors for the environment.

getName

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

The name of the environment.

addDeployment

@Stability(Stable)
void addDeployment(@NotNull
 IConfiguration configuration)

Creates a deployment of the supplied configuration to this environment.

Note that you can only deploy one configuration at a time to an environment. However, you can deploy one configuration each to different environments at the same time. If more than one deployment is requested for this environment, they will occur in the same order they were provided.

Parameters:

configuration - The configuration that will be deployed to this environment. This parameter is required.

addDeployments

@Stability(Stable)
void addDeployments(@NotNull
 IConfiguration... configurations)

Creates a deployment for each of the supplied configurations to this environment.

These configurations will be deployed in the same order as the input array.

Parameters:

configurations - The configurations that will be deployed to this environment. This parameter is required.

addExtension

@Stability(Stable)
void addExtension(@NotNull
 IExtension extension)

Adds an extension association to the environment.

Parameters:

extension - The extension to create an association for. This parameter is required.

atDeploymentTick

@Stability(Stable)
void atDeploymentTick(@NotNull
 IEventDestination eventDestination,
 @Nullable
 ExtensionOptions options)

Adds an AT_DEPLOYMENT_TICK extension with the provided event destination and also creates an extension association to an application.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

atDeploymentTick

@Stability(Stable)
void atDeploymentTick(@NotNull
 IEventDestination eventDestination)

Adds an AT_DEPLOYMENT_TICK extension with the provided event destination and also creates an extension association to an application.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

grant

@Stability(Stable)
@NotNull
Grant grant(@NotNull
 IGrantable grantee,
 @NotNull
 String... actions)

Adds an IAM policy statement associated with this environment to an IAM principal's policy.

Parameters:

grantee - the principal (no-op if undefined). This parameter is required.

actions - the set of actions to allow (i.e., 'appconfig:GetLatestConfiguration', 'appconfig:StartConfigurationSession', etc.). This parameter is required.

grantReadConfig

@Stability(Stable)
@NotNull
Grant grantReadConfig(@NotNull
 IGrantable grantee)

Permits an IAM principal to perform read operations on this environment's configurations.

Actions: GetLatestConfiguration, StartConfigurationSession.

Parameters:

grantee - Principal to grant read rights to. This parameter is required.

on

@Stability(Stable)
void on(@NotNull
 ActionPoint actionPoint,
 @NotNull
 IEventDestination eventDestination,
 @Nullable
 ExtensionOptions options)

Adds an extension defined by the action point and event destination and also creates an extension association to the environment.

Parameters:

actionPoint - The action point which triggers the event. This parameter is required.

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

on

@Stability(Stable)
void on(@NotNull
 ActionPoint actionPoint,
 @NotNull
 IEventDestination eventDestination)

Adds an extension defined by the action point and event destination and also creates an extension association to the environment.

Parameters:

actionPoint - The action point which triggers the event. This parameter is required.

eventDestination - The event that occurs during the extension. This parameter is required.

onDeploymentBaking

@Stability(Stable)
void onDeploymentBaking(@NotNull
 IEventDestination eventDestination,
 @Nullable
 ExtensionOptions options)

Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

onDeploymentBaking

@Stability(Stable)
void onDeploymentBaking(@NotNull
 IEventDestination eventDestination)

Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

onDeploymentComplete

@Stability(Stable)
void onDeploymentComplete(@NotNull
 IEventDestination eventDestination,
 @Nullable
 ExtensionOptions options)

Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

onDeploymentComplete

@Stability(Stable)
void onDeploymentComplete(@NotNull
 IEventDestination eventDestination)

Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

onDeploymentRolledBack

@Stability(Stable)
void onDeploymentRolledBack(@NotNull
 IEventDestination eventDestination,
 @Nullable
 ExtensionOptions options)

Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

onDeploymentRolledBack

@Stability(Stable)
void onDeploymentRolledBack(@NotNull
 IEventDestination eventDestination)

Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

onDeploymentStart

@Stability(Stable)
void onDeploymentStart(@NotNull
 IEventDestination eventDestination,
 @Nullable
 ExtensionOptions options)

Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

onDeploymentStart

@Stability(Stable)
void onDeploymentStart(@NotNull
 IEventDestination eventDestination)

Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

onDeploymentStep

@Stability(Stable)
void onDeploymentStep(@NotNull
 IEventDestination eventDestination,
 @Nullable
 ExtensionOptions options)

Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

onDeploymentStep

@Stability(Stable)
void onDeploymentStep(@NotNull
 IEventDestination eventDestination)

Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

preCreateHostedConfigurationVersion

@Stability(Stable)
void preCreateHostedConfigurationVersion(@NotNull
 IEventDestination eventDestination,
 @Nullable
 ExtensionOptions options)

Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

preCreateHostedConfigurationVersion

@Stability(Stable)
void preCreateHostedConfigurationVersion(@NotNull
 IEventDestination eventDestination)

Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

preStartDeployment

@Stability(Stable)
void preStartDeployment(@NotNull
 IEventDestination eventDestination,
 @Nullable
 ExtensionOptions options)

Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

preStartDeployment

@Stability(Stable)
void preStartDeployment(@NotNull
 IEventDestination eventDestination)

Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the environment.

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

getNode

@Stability(Stable)
@NotNull
software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

getEnv

@Stability(Stable)
@NotNull
ResourceEnvironment getEnv()

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Specified by:

getEnv in interface IEnvironmentAware