class Application (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.AppConfig.Alpha.Application |
Go | github.com/aws/aws-cdk-go/awscdkappconfigalpha/v2#Application |
Java | software.amazon.awscdk.services.appconfig.alpha.Application |
Python | aws_cdk.aws_appconfig_alpha.Application |
TypeScript (source) | @aws-cdk/aws-appconfig-alpha » Application |
⚠️ Deprecated: undefined
Implements
IConstruct
, IDependable
, IResource
, IApplication
, IExtensible
An AWS AppConfig application.
See also: https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appconfig_alpha from '@aws-cdk/aws-appconfig-alpha';
const application = new appconfig_alpha.Application(this, 'MyApplication', /* all optional props */ {
applicationName: 'applicationName',
description: 'description',
});
Initializer
new Application(scope: Construct, id: string, props?: ApplicationProps)
⚠️ Deprecated: undefined
Parameters
- scope
Construct
- id
string
- props
Application
Props
Construct Props
Name | Type | Description |
---|---|---|
application | string | The name of the application. |
description? | string | The description for the application. |
applicationName?
⚠️ Deprecated: undefined
Type:
string
(optional, default: A name is generated.)
The name of the application.
description?
⚠️ Deprecated: undefined
Type:
string
(optional, default: No description.)
The description for the application.
Properties
Name | Type | Description |
---|---|---|
application | string | The Amazon Resource Name (ARN) of the application. |
application | string | The ID of the application. |
env | Resource | The environment this resource belongs to. |
environments | IEnvironment [] | Returns the list of associated environments. |
extensible | Extensible | |
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
⚠️ Deprecated: undefined
Type:
string
The Amazon Resource Name (ARN) of the application.
applicationId
⚠️ Deprecated: undefined
Type:
string
The ID of the application.
env
⚠️ Deprecated: undefined
Type:
Resource
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.
environments
⚠️ Deprecated: undefined
Type:
IEnvironment
[]
Returns the list of associated environments.
extensible
⚠️ Deprecated: undefined
Type:
Extensible
node
⚠️ Deprecated: undefined
Type:
Node
The tree node.
stack
⚠️ Deprecated: undefined
Type:
Stack
The stack in which this resource is defined.
description?
⚠️ Deprecated: undefined
Type:
string
(optional)
The description of the application.
name?
⚠️ Deprecated: undefined
Type:
string
(optional)
The name of the application.
Methods
Name | Description |
---|---|
add | Adds an environment. |
add | Adds an existing environment. |
add | Adds an extension association to the application. |
add | Adds a hosted configuration. |
add | Adds a sourced configuration. |
apply | Apply the given removal policy to this resource. |
on(actionPoint, eventDestination, options?) | Adds an extension defined by the action point and event destination and also creates an extension association to an application. |
on | Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to an application. |
on | Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to an application. |
on | Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to an application. |
on | Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to an application. |
on | Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to an application. |
pre | Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to an application. |
pre | Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to an application. |
to | Returns a string representation of this construct. |
static add | Adds the AWS AppConfig Agent as a container to the provided ECS task definition. |
static from | Imports an AWS AppConfig application into the CDK using its Amazon Resource Name (ARN). |
static from | Imports an AWS AppConfig application into the CDK using its ID. |
static get | Retrieves the Lambda layer version Amazon Resource Name (ARN) for the AWS AppConfig Lambda extension. |
Environment(id, options?)
addpublic addEnvironment(id: string, options?: EnvironmentOptions): IEnvironment
⚠️ Deprecated: undefined
Parameters
- id
string
- options
Environment
Options
Returns
Adds an environment.
ExistingEnvironment(environment)
addpublic addExistingEnvironment(environment: IEnvironment): void
⚠️ Deprecated: undefined
Parameters
- environment
IEnvironment
Adds an existing environment.
Extension(extension)
addpublic addExtension(extension: IExtension): void
⚠️ Deprecated: undefined
Parameters
- extension
IExtension
— The extension to create an association for.
Adds an extension association to the application.
HostedConfiguration(id, options)
addpublic addHostedConfiguration(id: string, options: HostedConfigurationOptions): HostedConfiguration
⚠️ Deprecated: undefined
Parameters
- id
string
- options
Hosted
Configuration Options
Returns
Adds a hosted configuration.
SourcedConfiguration(id, options)
addpublic addSourcedConfiguration(id: string, options: SourcedConfigurationOptions): SourcedConfiguration
⚠️ Deprecated: undefined
Parameters
- id
string
- options
Sourced
Configuration Options
Returns
Adds a sourced configuration.
RemovalPolicy(policy)
applypublic applyRemovalPolicy(policy: RemovalPolicy): void
⚠️ Deprecated: undefined
Parameters
- policy
Removal
Policy
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
).
on(actionPoint, eventDestination, options?)
public on(actionPoint: ActionPoint, eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- actionPoint
Action
— The action point which triggers the event.Point - eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an extension defined by the action point and event destination and also creates an extension association to an application.
DeploymentBaking(eventDestination, options?)
onpublic onDeploymentBaking(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to an application.
DeploymentComplete(eventDestination, options?)
onpublic onDeploymentComplete(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to an application.
DeploymentRolledBack(eventDestination, options?)
onpublic onDeploymentRolledBack(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to an application.
DeploymentStart(eventDestination, options?)
onpublic onDeploymentStart(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to an application.
DeploymentStep(eventDestination, options?)
onpublic onDeploymentStep(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to an application.
CreateHostedConfigurationVersion(eventDestination, options?)
prepublic preCreateHostedConfigurationVersion(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to an application.
StartDeployment(eventDestination, options?)
prepublic preStartDeployment(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to an application.
String()
topublic toString(): string
⚠️ Deprecated: undefined
Returns
string
Returns a string representation of this construct.
AgentToEcs(taskDef)
static addpublic static addAgentToEcs(taskDef: TaskDefinition): void
⚠️ Deprecated: undefined
Parameters
- taskDef
Task
— The ECS task definition [disable-awslint:ref-via-interface].Definition
Adds the AWS AppConfig Agent as a container to the provided ECS task definition.
ApplicationArn(scope, id, applicationArn)
static frompublic static fromApplicationArn(scope: Construct, id: string, applicationArn: string): IApplication
⚠️ Deprecated: undefined
Parameters
- scope
Construct
— The parent construct. - id
string
— The name of the application construct. - applicationArn
string
— The Amazon Resource Name (ARN) of the application.
Returns
Imports an AWS AppConfig application into the CDK using its Amazon Resource Name (ARN).
ApplicationId(scope, id, applicationId)
static frompublic static fromApplicationId(scope: Construct, id: string, applicationId: string): IApplication
⚠️ Deprecated: undefined
Parameters
- scope
Construct
— The parent construct. - id
string
— The name of the application construct. - applicationId
string
— The ID of the application.
Returns
Imports an AWS AppConfig application into the CDK using its ID.
LambdaLayerVersionArn(region, platform?)
static getpublic static getLambdaLayerVersionArn(region: string, platform?: Platform): string
⚠️ Deprecated: undefined
Parameters
- region
string
— The region for the Lambda layer (for example, 'us-east-1'). - platform
Platform
— The platform for the Lambda layer (default is Platform.X86_64).
Returns
string
Retrieves the Lambda layer version Amazon Resource Name (ARN) for the AWS AppConfig Lambda extension.