Package software.amazon.awscdk.services.appconfig

Class IEnvironment.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.appconfig.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
@Internal public static final class IEnvironment.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements IEnvironment.Jsii$Default
A proxy class which represents a concrete javascript instance of this type.

  • 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

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    addDeployment(IConfiguration configuration)
    Creates a deployment of the supplied configuration to this environment.
    final void
    addDeployments(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 void
    atDeploymentTick(IEventDestination eventDestination)
    Adds an AT_DEPLOYMENT_TICK extension with the provided event destination and also creates an extension association to an application.
    final 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.
    final IApplication
    getApplication()
    The application associated with the environment.
    final String
    getApplicationId()
    The ID of the application associated to the environment.
    final String
    getDescription()
    The description of the environment.
    final ResourceEnvironment
    getEnv()
    The environment this resource belongs to.
    final String
    getEnvironmentArn()
    The Amazon Resource Name (ARN) of the environment.
    final String
    getEnvironmentId()
    The ID of the environment.
    final List<Monitor>
    getMonitors()
    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, 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 interface software.constructs.IConstruct
      Specified by:
      getNode in interface software.constructs.IConstruct.Jsii$Default
      Specified by:
      getNode in interface IEnvironment.Jsii$Default
      Specified by:
      getNode in interface IResource.Jsii$Default

    • getEnv

      @Stability(Stable) @NotNull public final ResourceEnvironment 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 interface IEnvironment.Jsii$Default
      Specified by:
      getEnv in interface IResource
      Specified by:
      getEnv in interface IResource.Jsii$Default

    • getStack

      @Stability(Stable) @NotNull public final Stack getStack()
      The stack in which this resource is defined.
      Specified by:
      getStack in interface IEnvironment.Jsii$Default
      Specified by:
      getStack in interface IResource
      Specified by:
      getStack in interface IResource.Jsii$Default

    • getApplicationId

      @Stability(Stable) @NotNull public final String getApplicationId()
      The ID of the application associated to the environment.
      Specified by:
      getApplicationId in interface IEnvironment
      Specified by:
      getApplicationId in interface IEnvironment.Jsii$Default

    • getEnvironmentArn

      @Stability(Stable) @NotNull public final String getEnvironmentArn()
      The Amazon Resource Name (ARN) of the environment.
      Specified by:
      getEnvironmentArn in interface IEnvironment
      Specified by:
      getEnvironmentArn in interface IEnvironment.Jsii$Default

    • getEnvironmentId

      @Stability(Stable) @NotNull public final String getEnvironmentId()
      The ID of the environment.
      Specified by:
      getEnvironmentId in interface IEnvironment
      Specified by:
      getEnvironmentId in interface IEnvironment.Jsii$Default

    • getApplication

      @Stability(Stable) @Nullable public final IApplication getApplication()
      The application associated with the environment.
      Specified by:
      getApplication in interface IEnvironment
      Specified by:
      getApplication in interface IEnvironment.Jsii$Default

    • getDescription

      @Stability(Stable) @Nullable public final String getDescription()
      The description of the environment.
      Specified by:
      getDescription in interface IEnvironment
      Specified by:
      getDescription in interface IEnvironment.Jsii$Default

    • getMonitors

      @Stability(Stable) @Nullable public final List<Monitor> getMonitors()
      The monitors for the environment.
      Specified by:
      getMonitors in interface IEnvironment
      Specified by:
      getMonitors in interface IEnvironment.Jsii$Default

    • getName

      @Stability(Stable) @Nullable public final String getName()
      The name of the environment.
      Specified by:
      getName in interface IEnvironment
      Specified by:
      getName in interface IEnvironment.Jsii$Default

    • applyRemovalPolicy

      @Stability(Stable) public final void applyRemovalPolicy(@NotNull RemovalPolicy policy)
      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 interface IEnvironment.Jsii$Default
      Specified by:
      applyRemovalPolicy in interface IResource
      Specified by:
      applyRemovalPolicy in interface IResource.Jsii$Default
      Parameters:
      policy - This parameter is required.

    • addDeployment

      @Stability(Stable) public final 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.

      Specified by:
      addDeployment in interface IEnvironment
      Specified by:
      addDeployment in interface IEnvironment.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 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 interface IEnvironment
      Specified by:
      addDeployments in interface IEnvironment.Jsii$Default
      Parameters:
      configurations - The configurations that will be deployed to this environment. This parameter is required.

    • addExtension

      @Stability(Stable) public final void addExtension(@NotNull IExtension extension)
      Adds an extension association to the environment.

      Specified by:
      addExtension in interface IEnvironment
      Specified by:
      addExtension in interface IEnvironment.Jsii$Default
      Parameters:
      extension - The extension to create an association for. This parameter is required.

    • atDeploymentTick

      @Stability(Stable) public final 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.

      Specified by:
      atDeploymentTick in interface IEnvironment
      Specified by:
      atDeploymentTick in interface IEnvironment.Jsii$Default
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • atDeploymentTick

      @Stability(Stable) public final 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.

      Specified by:
      atDeploymentTick in interface IEnvironment
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.

    • grant

      @Stability(Stable) @NotNull public final Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      Adds an IAM policy statement associated with this environment to an IAM principal's policy.

      Specified by:
      grant in interface IEnvironment
      Specified by:
      grant in interface IEnvironment.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

      @Stability(Stable) @NotNull public final Grant grantReadConfig(@NotNull IGrantable grantee)
      Permits an IAM principal to perform read operations on this environment's configurations.

      Actions: GetLatestConfiguration, StartConfigurationSession.

      Specified by:
      grantReadConfig in interface IEnvironment
      Specified by:
      grantReadConfig in interface IEnvironment.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 interface IEnvironment
      Specified by:
      on in interface IEnvironment.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 interface IEnvironment
      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 interface IEnvironment
      Specified by:
      onDeploymentBaking in interface IEnvironment.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 interface IEnvironment
      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 interface IEnvironment
      Specified by:
      onDeploymentComplete in interface IEnvironment.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 interface IEnvironment
      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 interface IEnvironment
      Specified by:
      onDeploymentRolledBack in interface IEnvironment.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 interface IEnvironment
      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 interface IEnvironment
      Specified by:
      onDeploymentStart in interface IEnvironment.Jsii$Default
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • onDeploymentStart

      @Stability(Stable) public final 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.

      Specified by:
      onDeploymentStart in interface IEnvironment
      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 interface IEnvironment
      Specified by:
      onDeploymentStep in interface IEnvironment.Jsii$Default
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • onDeploymentStep

      @Stability(Stable) public final 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.

      Specified by:
      onDeploymentStep in interface IEnvironment
      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 interface IEnvironment
      Specified by:
      preCreateHostedConfigurationVersion in interface IEnvironment.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 interface IEnvironment
      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 interface IEnvironment
      Specified by:
      preStartDeployment in interface IEnvironment.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 interface IEnvironment
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.