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:
-
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.amazon.awscdk.services.appconfig.IApplication
IApplication.Jsii$Default, IApplication.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appconfig.IExtensible
IExtensible.Jsii$Default, IExtensible.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource
IResource.Jsii$Default
-
Constructor Summary
ModifierConstructorDescriptionprotected
Application
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
Application
(software.amazon.jsii.JsiiObjectRef objRef) Application
(software.constructs.Construct scope, String id) Application
(software.constructs.Construct scope, String id, ApplicationProps props) -
Method Summary
Modifier and TypeMethodDescriptionstatic void
addAgentToEcs
(TaskDefinition taskDef) Adds the AWS AppConfig Agent as a container to the provided ECS task definition.addEnvironment
(String id) Adds an environment.addEnvironment
(String id, EnvironmentOptions options) Adds an environment.void
addExistingEnvironment
(IEnvironment environment) Adds an existing environment.void
addExtension
(IExtension extension) Adds an extension association to the application.addHostedConfiguration
(String id, HostedConfigurationOptions options) Adds a hosted configuration.addSourcedConfiguration
(String id, SourcedConfigurationOptions options) Adds a sourced configuration.Returns the list of associated environments.static IApplication
fromApplicationArn
(software.constructs.Construct scope, String id, String applicationArn) Imports an AWS AppConfig application into the CDK using its Amazon Resource Name (ARN).static IApplication
fromApplicationId
(software.constructs.Construct scope, String id, String applicationId) Imports an AWS AppConfig application into the CDK using its ID.The Amazon Resource Name (ARN) of the application.The ID of the application.The description of the application.protected ExtensibleBase
static String
getLambdaLayerVersionArn
(String region) Retrieves the Lambda layer version Amazon Resource Name (ARN) for the AWS AppConfig Lambda extension.static String
getLambdaLayerVersionArn
(String region, Platform platform) Retrieves the Lambda layer version Amazon Resource Name (ARN) for the AWS AppConfig Lambda extension.getName()
The name of the application.void
on
(ActionPoint actionPoint, IEventDestination eventDestination) Adds an extension defined by the action point and event destination and also creates an extension association to an application.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 an application.void
onDeploymentBaking
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to an application.void
onDeploymentBaking
(IEventDestination eventDestination, ExtensionOptions options) Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to an application.void
onDeploymentComplete
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to an application.void
onDeploymentComplete
(IEventDestination eventDestination, ExtensionOptions options) Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to an application.void
onDeploymentRolledBack
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to an application.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 an application.void
onDeploymentStart
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to an application.void
onDeploymentStart
(IEventDestination eventDestination, ExtensionOptions options) Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to an application.void
onDeploymentStep
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to an application.void
onDeploymentStep
(IEventDestination eventDestination, ExtensionOptions options) Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to an application.void
preCreateHostedConfigurationVersion
(IEventDestination eventDestination) Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to an application.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 an application.void
preStartDeployment
(IEventDestination eventDestination) Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to an application.void
preStartDeployment
(IEventDestination eventDestination, ExtensionOptions options) Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to an application.protected void
setExtensible
(ExtensibleBase value) Methods inherited from class software.amazon.awscdk.Resource
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource
Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString
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, wait, wait, wait
Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.awscdk.IResource
applyRemovalPolicy, getEnv, getStack
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
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
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
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 interfaceIApplication
- Parameters:
id
- This parameter is required.options
-
-
addEnvironment
Adds an environment.- Specified by:
addEnvironment
in interfaceIApplication
- Parameters:
id
- This parameter is required.
-
addExistingEnvironment
Adds an existing environment.- Specified by:
addExistingEnvironment
in interfaceIApplication
- Parameters:
environment
- This parameter is required.
-
addExtension
Adds an extension association to the application.- Specified by:
addExtension
in interfaceIApplication
- Specified by:
addExtension
in interfaceIExtensible
- 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 interfaceIApplication
- 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 interfaceIApplication
- Parameters:
id
- This parameter is required.options
- This parameter is required.
-
environments
Returns the list of associated environments.- Specified by:
environments
in interfaceIApplication
-
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 interfaceIApplication
- Specified by:
on
in interfaceIExtensible
- 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 interfaceIApplication
- Specified by:
on
in interfaceIExtensible
- 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 interfaceIApplication
- Specified by:
onDeploymentBaking
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
onDeploymentBaking
Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to an application.- Specified by:
onDeploymentBaking
in interfaceIApplication
- Specified by:
onDeploymentBaking
in interfaceIExtensible
- 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 interfaceIApplication
- Specified by:
onDeploymentComplete
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
onDeploymentComplete
Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to an application.- Specified by:
onDeploymentComplete
in interfaceIApplication
- Specified by:
onDeploymentComplete
in interfaceIExtensible
- 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 interfaceIApplication
- Specified by:
onDeploymentRolledBack
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
onDeploymentRolledBack
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 interfaceIApplication
- Specified by:
onDeploymentRolledBack
in interfaceIExtensible
- 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 interfaceIApplication
- Specified by:
onDeploymentStart
in interfaceIExtensible
- 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 an application.- Specified by:
onDeploymentStart
in interfaceIApplication
- Specified by:
onDeploymentStart
in interfaceIExtensible
- 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 interfaceIApplication
- Specified by:
onDeploymentStep
in interfaceIExtensible
- 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 an application.- Specified by:
onDeploymentStep
in interfaceIApplication
- Specified by:
onDeploymentStep
in interfaceIExtensible
- 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 interfaceIApplication
- Specified by:
preCreateHostedConfigurationVersion
in interfaceIExtensible
- 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 interfaceIApplication
- Specified by:
preCreateHostedConfigurationVersion
in interfaceIExtensible
- 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 interfaceIApplication
- Specified by:
preStartDeployment
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
preStartDeployment
Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to an application.- Specified by:
preStartDeployment
in interfaceIApplication
- Specified by:
preStartDeployment
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
getApplicationArn
The Amazon Resource Name (ARN) of the application.- Specified by:
getApplicationArn
in interfaceIApplication
-
getApplicationId
The ID of the application.- Specified by:
getApplicationId
in interfaceIApplication
-
getDescription
The description of the application.- Specified by:
getDescription
in interfaceIApplication
-
getName
The name of the application.- Specified by:
getName
in interfaceIApplication
-
getExtensible
-
setExtensible
-