Package software.amazon.awscdk.services.appconfig

Class Application

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.appconfig.Application
All Implemented Interfaces:
IResource, IApplication, IExtensible, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-25T14:21:09.674Z") @Stability(Stable) public class Application extends Resource implements IApplication, IExtensible
An AWS AppConfig application.

Example: 

 Application app = new Application(this, "MyApp");
 Environment env = Environment.Builder.create(this, "MyEnv")
         .application(app)
         .build();
 HostedConfiguration.Builder.create(this, "MyHostedConfig")
         .application(app)
         .deployTo(List.of(env))
         .content(ConfigurationContent.fromInlineText("This is my configuration content."))
         .build();

See Also:

  • Constructor Details

    • Application

      protected Application(software.amazon.jsii.JsiiObjectRef objRef)

    • Application

      protected Application(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • Application

      @Stability(Stable) public Application(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ApplicationProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props -

    • Application

      @Stability(Stable) public Application(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.

  • Method Details

    • addAgentToEcs

      @Stability(Stable) public static void addAgentToEcs(@NotNull TaskDefinition taskDef)
      Adds the AWS AppConfig Agent as a container to the provided ECS task definition.

      Parameters:
      taskDef - The ECS task definition [disable-awslint:ref-via-interface]. This parameter is required.

    • fromApplicationArn

      @Stability(Stable) @NotNull public static IApplication fromApplicationArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String applicationArn)
      Imports an AWS AppConfig application into the CDK using its Amazon Resource Name (ARN).

      Parameters:
      scope - The parent construct. This parameter is required.
      id - The name of the application construct. This parameter is required.
      applicationArn - The Amazon Resource Name (ARN) of the application. This parameter is required.

    • fromApplicationId

      @Stability(Stable) @NotNull public static IApplication fromApplicationId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String applicationId)
      Imports an AWS AppConfig application into the CDK using its ID.

      Parameters:
      scope - The parent construct. This parameter is required.
      id - The name of the application construct. This parameter is required.
      applicationId - The ID of the application. This parameter is required.

    • getLambdaLayerVersionArn

      @Stability(Stable) @NotNull public static String getLambdaLayerVersionArn(@NotNull String region, @Nullable Platform platform)
      Retrieves the Lambda layer version Amazon Resource Name (ARN) for the AWS AppConfig Lambda extension.

      Parameters:
      region - The region for the Lambda layer (for example, 'us-east-1'). This parameter is required.
      platform - The platform for the Lambda layer (default is Platform.X86_64).
      Returns:
      Lambda layer version ARN

    • getLambdaLayerVersionArn

      @Stability(Stable) @NotNull public static String getLambdaLayerVersionArn(@NotNull String region)
      Retrieves the Lambda layer version Amazon Resource Name (ARN) for the AWS AppConfig Lambda extension.

      Parameters:
      region - The region for the Lambda layer (for example, 'us-east-1'). This parameter is required.
      Returns:
      Lambda layer version ARN

    • addEnvironment

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

      Specified by:
      addEnvironment in interface IApplication
      Parameters:
      id - This parameter is required.
      options -

    • addEnvironment

      @Stability(Stable) @NotNull public IEnvironment addEnvironment(@NotNull String id)
      Adds an environment.

      Specified by:
      addEnvironment in interface IApplication
      Parameters:
      id - This parameter is required.

    • addExistingEnvironment

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

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

    • addExtension

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

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

    • addHostedConfiguration

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

      Specified by:
      addHostedConfiguration in interface IApplication
      Parameters:
      id - This parameter is required.
      options - This parameter is required.

    • addSourcedConfiguration

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

      Specified by:
      addSourcedConfiguration in interface IApplication
      Parameters:
      id - This parameter is required.
      options - This parameter is required.

    • environments

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

    • on

      @Stability(Stable) public 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
      Specified by:
      on in interface IExtensible
      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 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 an application.

      Specified by:
      on in interface IApplication
      Specified by:
      on in interface IExtensible
      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 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
      Specified by:
      onDeploymentBaking in interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • onDeploymentBaking

      @Stability(Stable) public void onDeploymentBaking(@NotNull IEventDestination eventDestination)
      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
      Specified by:
      onDeploymentBaking in interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.

    • onDeploymentComplete

      @Stability(Stable) public 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
      Specified by:
      onDeploymentComplete in interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • onDeploymentComplete

      @Stability(Stable) public void onDeploymentComplete(@NotNull IEventDestination eventDestination)
      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
      Specified by:
      onDeploymentComplete in interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.

    • onDeploymentRolledBack

      @Stability(Stable) public 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
      Specified by:
      onDeploymentRolledBack in interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • onDeploymentRolledBack

      @Stability(Stable) public void onDeploymentRolledBack(@NotNull IEventDestination eventDestination)
      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
      Specified by:
      onDeploymentRolledBack in interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.

    • onDeploymentStart

      @Stability(Stable) public 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
      Specified by:
      onDeploymentStart in interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • onDeploymentStart

      @Stability(Stable) public void onDeploymentStart(@NotNull IEventDestination eventDestination)
      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
      Specified by:
      onDeploymentStart in interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.

    • onDeploymentStep

      @Stability(Stable) public 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
      Specified by:
      onDeploymentStep in interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • onDeploymentStep

      @Stability(Stable) public void onDeploymentStep(@NotNull IEventDestination eventDestination)
      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
      Specified by:
      onDeploymentStep in interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.

    • preCreateHostedConfigurationVersion

      @Stability(Stable) public 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
      Specified by:
      preCreateHostedConfigurationVersion in interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • preCreateHostedConfigurationVersion

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

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

    • preStartDeployment

      @Stability(Stable) public 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
      Specified by:
      preStartDeployment in interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.

    • preStartDeployment

      @Stability(Stable) public void preStartDeployment(@NotNull IEventDestination eventDestination)
      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
      Specified by:
      preStartDeployment in interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.

    • getApplicationArn

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

    • getApplicationId

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

    • getDescription

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

    • getName

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

    • getExtensible

      @Stability(Stable) @NotNull protected ExtensibleBase getExtensible()

    • setExtensible

      @Stability(Stable) protected void setExtensible(@NotNull ExtensibleBase value)