Class IEnvironment.Jsii$Proxy
- All Implemented Interfaces:
IResource
,IResource.Jsii$Default
,IEnvironment
,IEnvironment.Jsii$Default
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IConstruct.Jsii$Default
,software.constructs.IDependable
,software.constructs.IDependable.Jsii$Default
- Enclosing interface:
IEnvironment
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IDependable
software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appconfig.IEnvironment
IEnvironment.Jsii$Default, IEnvironment.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default, IResource.Jsii$Proxy
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
addDeployment
(IConfiguration configuration) Creates a deployment of the supplied configuration to this environment.final void
addDeployments
(@NotNull IConfiguration... configurations) Creates a deployment for each of the supplied configurations to this environment.final void
addExtension
(IExtension extension) Adds an extension association to the environment.final void
applyRemovalPolicy
(RemovalPolicy policy) Apply the given removal policy to this resource.final IApplication
The application associated with the environment.final String
The ID of the application associated to the environment.final String
The description of the environment.final ResourceEnvironment
getEnv()
The environment this resource belongs to.final String
The Amazon Resource Name (ARN) of the environment.final String
The ID of the environment.The monitors for the environment.final String
getName()
The name of the environment.final software.constructs.Node
getNode()
The tree node.final Stack
getStack()
The stack in which this resource is defined.final Grant
grant
(IGrantable grantee, @NotNull String... actions) Adds an IAM policy statement associated with this environment to an IAM principal's policy.final Grant
grantReadConfig
(IGrantable grantee) Permits an IAM principal to perform read operations on this environment's configurations.final 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.final 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.final void
onDeploymentBaking
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the environment.final 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.final void
onDeploymentComplete
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the environment.final 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.final 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.final 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.final void
onDeploymentStart
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the environment.final 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.final void
onDeploymentStep
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the environment.final 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.final 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.final 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.final void
preStartDeployment
(IEventDestination eventDestination) Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the environment.final 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 class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
-
-
Method Details
-
getNode
@Stability(Stable) @NotNull public final software.constructs.Node getNode()The tree node.- Specified by:
getNode
in interfacesoftware.constructs.IConstruct
- Specified by:
getNode
in interfacesoftware.constructs.IConstruct.Jsii$Default
- Specified by:
getNode
in interfaceIEnvironment.Jsii$Default
- Specified by:
getNode
in interfaceIResource.Jsii$Default
-
getEnv
The environment this resource belongs to.For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
- Specified by:
getEnv
in interfaceIEnvironment.Jsii$Default
- Specified by:
getEnv
in interfaceIResource
- Specified by:
getEnv
in interfaceIResource.Jsii$Default
-
getStack
The stack in which this resource is defined.- Specified by:
getStack
in interfaceIEnvironment.Jsii$Default
- Specified by:
getStack
in interfaceIResource
- Specified by:
getStack
in interfaceIResource.Jsii$Default
-
getApplicationId
The ID of the application associated to the environment.- Specified by:
getApplicationId
in interfaceIEnvironment
- Specified by:
getApplicationId
in interfaceIEnvironment.Jsii$Default
-
getEnvironmentArn
The Amazon Resource Name (ARN) of the environment.- Specified by:
getEnvironmentArn
in interfaceIEnvironment
- Specified by:
getEnvironmentArn
in interfaceIEnvironment.Jsii$Default
-
getEnvironmentId
The ID of the environment.- Specified by:
getEnvironmentId
in interfaceIEnvironment
- Specified by:
getEnvironmentId
in interfaceIEnvironment.Jsii$Default
-
getApplication
The application associated with the environment.- Specified by:
getApplication
in interfaceIEnvironment
- Specified by:
getApplication
in interfaceIEnvironment.Jsii$Default
-
getDescription
The description of the environment.- Specified by:
getDescription
in interfaceIEnvironment
- Specified by:
getDescription
in interfaceIEnvironment.Jsii$Default
-
getMonitors
The monitors for the environment.- Specified by:
getMonitors
in interfaceIEnvironment
- Specified by:
getMonitors
in interfaceIEnvironment.Jsii$Default
-
getName
The name of the environment.- Specified by:
getName
in interfaceIEnvironment
- Specified by:
getName
in interfaceIEnvironment.Jsii$Default
-
applyRemovalPolicy
Apply the given removal policy to this resource.The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Specified by:
applyRemovalPolicy
in interfaceIEnvironment.Jsii$Default
- Specified by:
applyRemovalPolicy
in interfaceIResource
- Specified by:
applyRemovalPolicy
in interfaceIResource.Jsii$Default
- Parameters:
policy
- This parameter is required.
-
addDeployment
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.
- Specified by:
addDeployment
in interfaceIEnvironment
- Specified by:
addDeployment
in interfaceIEnvironment.Jsii$Default
- Parameters:
configuration
- The configuration that will be deployed to this environment. This parameter is required.
-
addDeployments
@Stability(Stable) public final void addDeployments(@NotNull @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.
- Specified by:
addDeployments
in interfaceIEnvironment
- Specified by:
addDeployments
in interfaceIEnvironment.Jsii$Default
- Parameters:
configurations
- The configurations that will be deployed to this environment. This parameter is required.
-
addExtension
Adds an extension association to the environment.- Specified by:
addExtension
in interfaceIEnvironment
- Specified by:
addExtension
in interfaceIEnvironment.Jsii$Default
- Parameters:
extension
- The extension to create an association for. This parameter is required.
-
grant
@Stability(Stable) @NotNull public final Grant grant(@NotNull IGrantable grantee, @NotNull @NotNull String... actions) Adds an IAM policy statement associated with this environment to an IAM principal's policy.- Specified by:
grant
in interfaceIEnvironment
- Specified by:
grant
in interfaceIEnvironment.Jsii$Default
- 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
Permits an IAM principal to perform read operations on this environment's configurations.Actions: GetLatestConfiguration, StartConfigurationSession.
- Specified by:
grantReadConfig
in interfaceIEnvironment
- Specified by:
grantReadConfig
in interfaceIEnvironment.Jsii$Default
- Parameters:
grantee
- Principal to grant read rights to. This parameter is required.
-
on
@Stability(Stable) public final 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.- Specified by:
on
in interfaceIEnvironment
- Specified by:
on
in interfaceIEnvironment.Jsii$Default
- 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) public final 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.- Specified by:
on
in interfaceIEnvironment
- 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) public final 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.- Specified by:
onDeploymentBaking
in interfaceIEnvironment
- Specified by:
onDeploymentBaking
in interfaceIEnvironment.Jsii$Default
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
onDeploymentBaking
@Stability(Stable) public final 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.- Specified by:
onDeploymentBaking
in interfaceIEnvironment
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
onDeploymentComplete
@Stability(Stable) public final 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.- Specified by:
onDeploymentComplete
in interfaceIEnvironment
- Specified by:
onDeploymentComplete
in interfaceIEnvironment.Jsii$Default
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
onDeploymentComplete
@Stability(Stable) public final 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.- Specified by:
onDeploymentComplete
in interfaceIEnvironment
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
onDeploymentRolledBack
@Stability(Stable) public final 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.- Specified by:
onDeploymentRolledBack
in interfaceIEnvironment
- Specified by:
onDeploymentRolledBack
in interfaceIEnvironment.Jsii$Default
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
onDeploymentRolledBack
@Stability(Stable) public final 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.- Specified by:
onDeploymentRolledBack
in interfaceIEnvironment
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
onDeploymentStart
@Stability(Stable) public final 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.- Specified by:
onDeploymentStart
in interfaceIEnvironment
- Specified by:
onDeploymentStart
in interfaceIEnvironment.Jsii$Default
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
onDeploymentStart
Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the environment.- Specified by:
onDeploymentStart
in interfaceIEnvironment
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
onDeploymentStep
@Stability(Stable) public final 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.- Specified by:
onDeploymentStep
in interfaceIEnvironment
- Specified by:
onDeploymentStep
in interfaceIEnvironment.Jsii$Default
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
onDeploymentStep
Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the environment.- Specified by:
onDeploymentStep
in interfaceIEnvironment
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
preCreateHostedConfigurationVersion
@Stability(Stable) public final 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.- Specified by:
preCreateHostedConfigurationVersion
in interfaceIEnvironment
- Specified by:
preCreateHostedConfigurationVersion
in interfaceIEnvironment.Jsii$Default
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
preCreateHostedConfigurationVersion
@Stability(Stable) public final 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.- Specified by:
preCreateHostedConfigurationVersion
in interfaceIEnvironment
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
preStartDeployment
@Stability(Stable) public final 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.- Specified by:
preStartDeployment
in interfaceIEnvironment
- Specified by:
preStartDeployment
in interfaceIEnvironment.Jsii$Default
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
preStartDeployment
@Stability(Stable) public final 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.- Specified by:
preStartDeployment
in interfaceIEnvironment
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-