interface IApplication

Language	Type name
.NET	`Amazon.CDK.AWS.AppConfig.IApplication`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsappconfig#IApplication`
Java	`software.amazon.awscdk.services.appconfig.IApplication`
Python	`aws_cdk.aws_appconfig.IApplication`
TypeScript (source)	`aws-cdk-lib` » `aws_appconfig` » `IApplication`

Implemented by Application

Obtainable from Application.fromApplicationArn(), Application.fromApplicationId()

Properties

Name	Type	Description
applicationArn	`string`	The Amazon Resource Name (ARN) of the application.
applicationId	`string`	The ID of the application.
env	`ResourceEnvironment`	The environment this resource belongs to.
node	`Node`	The tree node.
stack	`Stack`	The stack in which this resource is defined.
description?	`string`	The description of the application.
name?	`string`	The name of the application.

applicationArn

Type: string

The Amazon Resource Name (ARN) of the application.

applicationId

Type: string

The ID of the application.

env

Type: ResourceEnvironment

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.

node

Type: Node

The tree node.

stack

Type: Stack

The stack in which this resource is defined.

description?

Type: string (optional)

The description of the application.

name?

Type: string (optional)

The name of the application.

Methods

Name	Description
addEnvironment(id, options?)	Adds an environment.
addExistingEnvironment(environment)	Adds an existing environment.
addExtension(extension)	Adds an extension association to the application.
addHostedConfiguration(id, options)	Adds a hosted configuration.
addSourcedConfiguration(id, options)	Adds a sourced configuration.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
environments()	Returns the list of associated environments.
on(actionPoint, eventDestination, options?)	Adds an extension defined by the action point and event destination and also creates an extension association to an application.
onDeploymentBaking(eventDestination, options?)	Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to an application.
onDeploymentComplete(eventDestination, options?)	Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to an application.
onDeploymentRolledBack(eventDestination, options?)	Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to an application.
onDeploymentStart(eventDestination, options?)	Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to an application.
onDeploymentStep(eventDestination, options?)	Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to an application.
preCreateHostedConfigurationVersion(eventDestination, options?)	Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to an application.
preStartDeployment(eventDestination, options?)	Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to an application.

addEnvironment(id, options?)

public addEnvironment(id: string, options?: EnvironmentOptions): IEnvironment

Parameters

id string — The name of the environment construct.
options EnvironmentOptions — The options for the environment construct.

Returns

IEnvironment

Adds an environment.

addExistingEnvironment(environment)

public addExistingEnvironment(environment: IEnvironment): void

Parameters

environment IEnvironment — The environment.

Adds an existing environment.

addExtension(extension)

public addExtension(extension: IExtension): void

Parameters

extension IExtension — The extension to create an association for.

Adds an extension association to the application.

addHostedConfiguration(id, options)

public addHostedConfiguration(id: string, options: HostedConfigurationOptions): HostedConfiguration

Parameters

id string — The name of the hosted configuration construct.
options HostedConfigurationOptions — The options for the hosted configuration construct.

Returns

HostedConfiguration

Adds a hosted configuration.

addSourcedConfiguration(id, options)

public addSourcedConfiguration(id: string, options: SourcedConfigurationOptions): SourcedConfiguration

Parameters

id string — The name of the sourced configuration construct.
options SourcedConfigurationOptions — The options for the sourced configuration construct.

Returns

SourcedConfiguration

Adds a sourced configuration.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

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

environments()

public environments(): IEnvironment[]

Returns

IEnvironment[]

Returns the list of associated environments.

on(actionPoint, eventDestination, options?)

public on(actionPoint: ActionPoint, eventDestination: IEventDestination, options?: ExtensionOptions): void

Parameters

actionPoint ActionPoint — The action point which triggers the event.
eventDestination IEventDestination — The event that occurs during the extension.
options ExtensionOptions — Options for the extension.

Adds an extension defined by the action point and event destination and also creates an extension association to an application.

onDeploymentBaking(eventDestination, options?)

public onDeploymentBaking(eventDestination: IEventDestination, options?: ExtensionOptions): void

Parameters

eventDestination IEventDestination — The event that occurs during the extension.
options ExtensionOptions — Options for the extension.

Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to an application.

onDeploymentComplete(eventDestination, options?)

public onDeploymentComplete(eventDestination: IEventDestination, options?: ExtensionOptions): void

Parameters

eventDestination IEventDestination — The event that occurs during the extension.
options ExtensionOptions — Options for the extension.

Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to an application.

onDeploymentRolledBack(eventDestination, options?)

public onDeploymentRolledBack(eventDestination: IEventDestination, options?: ExtensionOptions): void

Parameters

eventDestination IEventDestination — The event that occurs during the extension.
options ExtensionOptions — Options for the extension.

Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to an application.

onDeploymentStart(eventDestination, options?)

public onDeploymentStart(eventDestination: IEventDestination, options?: ExtensionOptions): void

Parameters

eventDestination IEventDestination — The event that occurs during the extension.
options ExtensionOptions — Options for the extension.

Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to an application.

onDeploymentStep(eventDestination, options?)

public onDeploymentStep(eventDestination: IEventDestination, options?: ExtensionOptions): void

Parameters

eventDestination IEventDestination — The event that occurs during the extension.
options ExtensionOptions — Options for the extension.

Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to an application.

preCreateHostedConfigurationVersion(eventDestination, options?)

public preCreateHostedConfigurationVersion(eventDestination: IEventDestination, options?: ExtensionOptions): void

Parameters

eventDestination IEventDestination — The event that occurs during the extension.
options ExtensionOptions — Options for the extension.

Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to an application.

preStartDeployment(eventDestination, options?)

public preStartDeployment(eventDestination: IEventDestination, options?: ExtensionOptions): void

Parameters

eventDestination IEventDestination — The event that occurs during the extension.
options ExtensionOptions — Options for the extension.

Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to an application.