Interface IApplication

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Stack

IApplicationRef.ApplicationRef

IEnvironmentAware.Env

Namespace: Amazon.CDK.AWS.AppConfig

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IApplication : IResource, IApplicationRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Interface IApplication Inherits IResource, IApplicationRef, IConstruct, IDependable, IEnvironmentAware

Synopsis

Properties

ApplicationArn	The Amazon Resource Name (ARN) of the application.
ApplicationId	The ID of the application.
Description	The description of the application.
Name	The name of the application.

Methods

AddEnvironment(string, IEnvironmentOptions?)	Adds an environment.
AddExistingEnvironment(IEnvironmentRef)	Adds an existing environment.
AddExtension(IExtension)	Adds an extension association to the application.
AddHostedConfiguration(string, IHostedConfigurationOptions)	Adds a hosted configuration.
AddSourcedConfiguration(string, ISourcedConfigurationOptions)	Adds a sourced configuration.
AtDeploymentTick(IEventDestination, IExtensionOptions?)	Adds an AT_DEPLOYMENT_TICK extension with the provided event destination and also creates an extension association to an application.
Environments()	Returns the list of associated environments.
On(ActionPoint, IEventDestination, IExtensionOptions?)	Adds an extension defined by the action point and event destination and also creates an extension association to an application.
OnDeploymentBaking(IEventDestination, IExtensionOptions?)	Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to an application.
OnDeploymentComplete(IEventDestination, IExtensionOptions?)	Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to an application.
OnDeploymentRolledBack(IEventDestination, IExtensionOptions?)	Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to an application.
OnDeploymentStart(IEventDestination, IExtensionOptions?)	Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to an application.
OnDeploymentStep(IEventDestination, IExtensionOptions?)	Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to an application.
PreCreateHostedConfigurationVersion(IEventDestination, IExtensionOptions?)	Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to an application.
PreStartDeployment(IEventDestination, IExtensionOptions?)	Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to an application.

Properties

ApplicationArn

The Amazon Resource Name (ARN) of the application.

string ApplicationArn { get; }

Property Value

string

Remarks

Attribute: true

ApplicationId

The ID of the application.

string ApplicationId { get; }

Property Value

string

Remarks

Attribute: true

Description

The description of the application.

string? Description { get; }

Property Value

string

Name

The name of the application.

string? Name { get; }

Property Value

string

Methods

AddEnvironment(string, IEnvironmentOptions?)

Adds an environment.

IEnvironment AddEnvironment(string id, IEnvironmentOptions? options = null)

Parameters

id string

The name of the environment construct.

options IEnvironmentOptions

The options for the environment construct.

Returns

IEnvironment

AddExistingEnvironment(IEnvironmentRef)

Adds an existing environment.

void AddExistingEnvironment(IEnvironmentRef environment)

Parameters

environment IEnvironmentRef

The environment.

AddExtension(IExtension)

Adds an extension association to the application.

void AddExtension(IExtension extension)

Parameters

extension IExtension

The extension to create an association for.

AddHostedConfiguration(string, IHostedConfigurationOptions)

Adds a hosted configuration.

HostedConfiguration AddHostedConfiguration(string id, IHostedConfigurationOptions options)

Parameters

id string

The name of the hosted configuration construct.

options IHostedConfigurationOptions

The options for the hosted configuration construct.

Returns

HostedConfiguration

AddSourcedConfiguration(string, ISourcedConfigurationOptions)

Adds a sourced configuration.

SourcedConfiguration AddSourcedConfiguration(string id, ISourcedConfigurationOptions options)

Parameters

id string

The name of the sourced configuration construct.

options ISourcedConfigurationOptions

The options for the sourced configuration construct.

Returns

SourcedConfiguration

AtDeploymentTick(IEventDestination, IExtensionOptions?)

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

void AtDeploymentTick(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

Environments()

Returns the list of associated environments.

IEnvironment[] Environments()

Returns

IEnvironment[]

On(ActionPoint, IEventDestination, IExtensionOptions?)

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, IExtensionOptions? options = null)

Parameters

actionPoint ActionPoint

The action point which triggers the event.

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentBaking(IEventDestination, IExtensionOptions?)

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

void OnDeploymentBaking(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentComplete(IEventDestination, IExtensionOptions?)

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

void OnDeploymentComplete(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentRolledBack(IEventDestination, IExtensionOptions?)

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, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentStart(IEventDestination, IExtensionOptions?)

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

void OnDeploymentStart(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentStep(IEventDestination, IExtensionOptions?)

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

void OnDeploymentStep(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

PreCreateHostedConfigurationVersion(IEventDestination, IExtensionOptions?)

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, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

PreStartDeployment(IEventDestination, IExtensionOptions?)

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

void PreStartDeployment(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.