Package software.amazon.awscdk.services.appconfig

Interface IApplication.Jsii$Default

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

  • 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 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
      Specified by:
      getEnv in interface IEnvironmentAware.Jsii$Default
      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

    • getApplicationArn

      @Stability(Stable) @NotNull default String getApplicationArn()
      The Amazon Resource Name (ARN) of the application.
      Specified by:
      getApplicationArn in interface IApplication

    • getApplicationId

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

    • getDescription

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

    • getName

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

    • 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.

    • addEnvironment

      @Stability(Stable) @NotNull default IEnvironment addEnvironment(@NotNull String id, @Nullable EnvironmentOptions options)
      Adds an environment.

      Specified by:
      addEnvironment in interface IApplication
      Parameters:
      id - The name of the environment construct. This parameter is required.
      options - The options for the environment construct.

    • addExistingEnvironment

      @Stability(Stable) default void addExistingEnvironment(@NotNull IEnvironment environment)
      Adds an existing environment.

      Specified by:
      addExistingEnvironment in interface IApplication
      Parameters:
      environment - The environment. This parameter is required.

    • addExtension

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

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

    • addHostedConfiguration

      @Stability(Stable) @NotNull default HostedConfiguration addHostedConfiguration(@NotNull String id, @NotNull HostedConfigurationOptions options)
      Adds a hosted configuration.

      Specified by:
      addHostedConfiguration in interface IApplication
      Parameters:
      id - The name of the hosted configuration construct. This parameter is required.
      options - The options for the hosted configuration construct. This parameter is required.

    • addSourcedConfiguration

      @Stability(Stable) @NotNull default SourcedConfiguration addSourcedConfiguration(@NotNull String id, @NotNull SourcedConfigurationOptions options)
      Adds a sourced configuration.

      Specified by:
      addSourcedConfiguration in interface IApplication
      Parameters:
      id - The name of the sourced configuration construct. This parameter is required.
      options - The options for the sourced configuration construct. This parameter is required.

    • atDeploymentTick

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

    • environments

      @Stability(Stable) @NotNull default List<IEnvironment> environments()
      Returns the list of associated environments.
      Specified by:
      environments in interface IApplication

    • 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 an application.

      Specified by:
      on in interface IApplication
      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 an application.

      Specified by:
      onDeploymentBaking in interface IApplication
      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 an application.

      Specified by:
      onDeploymentComplete in interface IApplication
      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 an application.

      Specified by:
      onDeploymentRolledBack in interface IApplication
      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 an application.

      Specified by:
      onDeploymentStart in interface IApplication
      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 an application.

      Specified by:
      onDeploymentStep in interface IApplication
      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 an application.

      Specified by:
      preCreateHostedConfigurationVersion in interface IApplication
      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 an application.

      Specified by:
      preStartDeployment in interface IApplication
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.