Package software.amazon.awscdk.services.appconfig

Interface IApplication

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IApplication.Jsii$Default

All Known Implementing Classes:

Application, IApplication.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:56.550Z")
@Stability(Stable)
public interface IApplication
extends software.amazon.jsii.JsiiSerializable, IResource

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IApplication.Jsii$Default	Internal default implementation for IApplication.
static final class	IApplication.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
IEnvironment	addEnvironment(String id)	Adds an environment.
IEnvironment	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.
HostedConfiguration	addHostedConfiguration(String id, HostedConfigurationOptions options)	Adds a hosted configuration.
SourcedConfiguration	addSourcedConfiguration(String id, SourcedConfigurationOptions options)	Adds a sourced configuration.
List<IEnvironment>	environments()	Returns the list of associated environments.
String	getApplicationArn()	The Amazon Resource Name (ARN) of the application.
String	getApplicationId()	The ID of the application.
default String	getDescription()	The description of the application.
default String	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.

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

Method Details

getApplicationArn

@Stability(Stable)
@NotNull
String getApplicationArn()

The Amazon Resource Name (ARN) of the application.

getApplicationId

@Stability(Stable)
@NotNull
String getApplicationId()

The ID of the application.

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the application.

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the application.

addEnvironment

@Stability(Stable)
@NotNull
IEnvironment addEnvironment(@NotNull
 String id,
 @Nullable
 EnvironmentOptions options)

Adds an environment.

Parameters:

id - The name of the environment construct. This parameter is required.

options - The options for the environment construct.

addEnvironment

@Stability(Stable)
@NotNull
IEnvironment addEnvironment(@NotNull
 String id)

Adds an environment.

Parameters:

id - The name of the environment construct. This parameter is required.

addExistingEnvironment

@Stability(Stable)
void addExistingEnvironment(@NotNull
 IEnvironment environment)

Adds an existing environment.

Parameters:

environment - The environment. This parameter is required.

addExtension

@Stability(Stable)
void addExtension(@NotNull
 IExtension extension)

Adds an extension association to the application.

Parameters:

extension - The extension to create an association for. This parameter is required.

addHostedConfiguration

@Stability(Stable)
@NotNull
HostedConfiguration addHostedConfiguration(@NotNull
 String id,
 @NotNull
 HostedConfigurationOptions options)

Adds a hosted configuration.

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
SourcedConfiguration addSourcedConfiguration(@NotNull
 String id,
 @NotNull
 SourcedConfigurationOptions options)

Adds a sourced configuration.

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.

environments

@Stability(Stable)
@NotNull
List<IEnvironment> environments()

Returns the list of associated environments.

on

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

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

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

onDeploymentBaking

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

onDeploymentComplete

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

onDeploymentComplete

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

onDeploymentRolledBack

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

onDeploymentRolledBack

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

onDeploymentStart

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

onDeploymentStart

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

onDeploymentStep

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

onDeploymentStep

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

preCreateHostedConfigurationVersion

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

preCreateHostedConfigurationVersion

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

preStartDeployment

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.

options - Options for the extension.

preStartDeployment

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

Parameters:

eventDestination - The event that occurs during the extension. This parameter is required.