Package software.amazon.awscdk.services.appconfig

Interface IEnvironment.Jsii$Default

All Superinterfaces:
software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironment, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IEnvironment.Jsii$Proxy
Enclosing interface:
IEnvironment
@Internal public static interface IEnvironment.Jsii$Default extends IEnvironment, IResource.Jsii$Default
Internal default implementation for IEnvironment.

  • Method Details

    • getNode

      @Stability(Stable) @NotNull default 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 IResource.Jsii$Default

    • getEnv

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

    • getStack

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

    • getApplicationId

      @Stability(Stable) @NotNull default String getApplicationId()
      The ID of the application associated to the environment.
      Specified by:
      getApplicationId in interface IEnvironment

    • getEnvironmentArn

      @Stability(Stable) @NotNull default String getEnvironmentArn()
      The Amazon Resource Name (ARN) of the environment.
      Specified by:
      getEnvironmentArn in interface IEnvironment

    • getEnvironmentId

      @Stability(Stable) @NotNull default String getEnvironmentId()
      The ID of the environment.
      Specified by:
      getEnvironmentId in interface IEnvironment

    • getApplication

      @Stability(Stable) @Nullable default IApplication getApplication()
      The application associated with the environment.
      Specified by:
      getApplication in interface IEnvironment

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the environment.
      Specified by:
      getDescription in interface IEnvironment

    • getMonitors

      @Stability(Stable) @Nullable default List<Monitor> getMonitors()
      The monitors for the environment.
      Specified by:
      getMonitors in interface IEnvironment

    • getName

      @Stability(Stable) @Nullable default String getName()
      The name of the environment.
      Specified by:
      getName in interface IEnvironment

    • applyRemovalPolicy

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

    • addDeployment

      @Stability(Stable) default 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
      Parameters:
      configuration - The configuration that will be deployed to this environment. This parameter is required.

    • addDeployments

      @Stability(Stable) default 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 interface IEnvironment
      Parameters:
      configurations - The configurations that will be deployed to this environment. This parameter is required.

    • addExtension

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

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

    • grant

      @Stability(Stable) @NotNull default 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 interface IEnvironment
      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 default 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
      Parameters:
      grantee - Principal to grant read rights to. This parameter is required.

    • on

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

    • onDeploymentBaking

      @Stability(Stable) default 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
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • onDeploymentComplete

      @Stability(Stable) default 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
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • onDeploymentRolledBack

      @Stability(Stable) default 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
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • onDeploymentStart

      @Stability(Stable) default 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
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • onDeploymentStep

      @Stability(Stable) default 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
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • preCreateHostedConfigurationVersion

      @Stability(Stable) default 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
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • preStartDeployment

      @Stability(Stable) default 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
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.