Class Application
An AWS AppConfig application.
Inherited Members
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class Application : Resource, IApplication, IResource, IExtensible
Syntax (vb)
Public Class Application
Inherits Resource
Implements IApplication, IResource, IExtensible
Remarks
See: https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-application.html
Resource: AWS::AppConfig::Application
ExampleMetadata: infused
Examples
var app = new Application(this, "MyApp");
var env = new Environment(this, "MyEnv", new EnvironmentProps {
Application = app
});
new HostedConfiguration(this, "MyHostedConfig", new HostedConfigurationProps {
Application = app,
DeployTo = new [] { env },
Content = ConfigurationContent.FromInlineText("This is my configuration content.")
});
Synopsis
Constructors
Application(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
Application(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Application(Construct, String, IApplicationProps) |
Properties
ApplicationArn | The Amazon Resource Name (ARN) of the application. |
ApplicationId | The ID of the application. |
Description | The description of the application. |
Extensible | |
Name | The name of the application. |
Methods
AddAgentToEcs(TaskDefinition) | Adds the AWS AppConfig Agent as a container to the provided ECS task definition. |
AddEnvironment(String, IEnvironmentOptions) | Adds an environment. |
AddExistingEnvironment(IEnvironment) | 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. |
Environments() | Returns the list of associated environments. |
FromApplicationArn(Construct, String, String) | Imports an AWS AppConfig application into the CDK using its Amazon Resource Name (ARN). |
FromApplicationId(Construct, String, String) | Imports an AWS AppConfig application into the CDK using its ID. |
GetLambdaLayerVersionArn(String, Nullable<Platform>) | Retrieves the Lambda layer version Amazon Resource Name (ARN) for the AWS AppConfig Lambda extension. |
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. |
Constructors
Application(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected Application(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
Application(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected Application(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Application(Construct, String, IApplicationProps)
public Application(Construct scope, string id, IApplicationProps props = null)
Parameters
- scope Constructs.Construct
- id System.String
- props IApplicationProps
Properties
ApplicationArn
The Amazon Resource Name (ARN) of the application.
public virtual string ApplicationArn { get; }
Property Value
System.String
Remarks
Attribute: true
ApplicationId
The ID of the application.
public virtual string ApplicationId { get; }
Property Value
System.String
Remarks
Attribute: true
Description
The description of the application.
public virtual string Description { get; }
Property Value
System.String
Extensible
Name
The name of the application.
public virtual string Name { get; }
Property Value
System.String
Methods
AddAgentToEcs(TaskDefinition)
Adds the AWS AppConfig Agent as a container to the provided ECS task definition.
public static void AddAgentToEcs(TaskDefinition taskDef)
Parameters
- taskDef TaskDefinition
The ECS task definition [disable-awslint:ref-via-interface].
AddEnvironment(String, IEnvironmentOptions)
Adds an environment.
public virtual IEnvironment AddEnvironment(string id, IEnvironmentOptions options = null)
Parameters
- id System.String
- options IEnvironmentOptions
Returns
AddExistingEnvironment(IEnvironment)
Adds an existing environment.
public virtual void AddExistingEnvironment(IEnvironment environment)
Parameters
- environment IEnvironment
AddExtension(IExtension)
Adds an extension association to the application.
public virtual void AddExtension(IExtension extension)
Parameters
- extension IExtension
The extension to create an association for.
AddHostedConfiguration(String, IHostedConfigurationOptions)
Adds a hosted configuration.
public virtual HostedConfiguration AddHostedConfiguration(string id, IHostedConfigurationOptions options)
Parameters
- id System.String
- options IHostedConfigurationOptions
Returns
AddSourcedConfiguration(String, ISourcedConfigurationOptions)
Adds a sourced configuration.
public virtual SourcedConfiguration AddSourcedConfiguration(string id, ISourcedConfigurationOptions options)
Parameters
- id System.String
- options ISourcedConfigurationOptions
Returns
Environments()
Returns the list of associated environments.
public virtual IEnvironment[] Environments()
Returns
FromApplicationArn(Construct, String, String)
Imports an AWS AppConfig application into the CDK using its Amazon Resource Name (ARN).
public static IApplication FromApplicationArn(Construct scope, string id, string applicationArn)
Parameters
- scope Constructs.Construct
The parent construct.
- id System.String
The name of the application construct.
- applicationArn System.String
The Amazon Resource Name (ARN) of the application.
Returns
FromApplicationId(Construct, String, String)
Imports an AWS AppConfig application into the CDK using its ID.
public static IApplication FromApplicationId(Construct scope, string id, string applicationId)
Parameters
- scope Constructs.Construct
The parent construct.
- id System.String
The name of the application construct.
- applicationId System.String
The ID of the application.
Returns
GetLambdaLayerVersionArn(String, Nullable<Platform>)
Retrieves the Lambda layer version Amazon Resource Name (ARN) for the AWS AppConfig Lambda extension.
public static string GetLambdaLayerVersionArn(string region, Nullable<Platform> platform = null)
Parameters
- region System.String
The region for the Lambda layer (for example, 'us-east-1').
- platform System.Nullable<Platform>
The platform for the Lambda layer (default is Platform.X86_64).
Returns
System.String
Lambda layer version ARN
On(ActionPoint, IEventDestination, IExtensionOptions)
Adds an extension defined by the action point and event destination and also creates an extension association to an application.
public virtual 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.
public virtual 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.
public virtual 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.
public virtual 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.
public virtual 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.
public virtual 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.
public virtual 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.
public virtual void PreStartDeployment(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
- eventDestination IEventDestination
The event that occurs during the extension.
- options IExtensionOptions
Options for the extension.