aws-cdk-lib.aws_codedeploy.EcsApplication

class EcsApplication (construct)

LanguageType name
.NETAmazon.CDK.AWS.CodeDeploy.EcsApplication
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscodedeploy#EcsApplication
Javasoftware.amazon.awscdk.services.codedeploy.EcsApplication
Pythonaws_cdk.aws_codedeploy.EcsApplication
TypeScript (source)aws-cdk-lib » aws_codedeploy » EcsApplication

Implements IConstruct, IDependable, IResource, IEcsApplication

A CodeDeploy Application that deploys to an Amazon ECS service.

Example

const application = new codedeploy.EcsApplication(this, 'CodeDeployApplication', {
  applicationName: 'MyApplication', // optional property
});

Initializer

new EcsApplication(scope: Construct, id: string, props?: EcsApplicationProps)

Parameters

  • scope Construct
  • id string
  • props EcsApplicationProps

Construct Props

NameTypeDescription
applicationName?stringThe physical, human-readable name of the CodeDeploy Application.

applicationName?

Type: string (optional, default: an auto-generated name will be used)

The physical, human-readable name of the CodeDeploy Application.

Properties

NameTypeDescription
applicationArnstring
applicationNamestring
envResourceEnvironmentThe environment this resource belongs to.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.

applicationArn

Type: string


applicationName

Type: string


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.

Methods

NameDescription
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
toString()Returns a string representation of this construct.
static fromEcsApplicationArn(scope, id, ecsApplicationArn)Import an Application defined either outside the CDK, or in a different CDK Stack, by ARN.
static fromEcsApplicationName(scope, id, ecsApplicationName)Import an Application defined either outside the CDK, or in a different CDK Stack.

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


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromEcsApplicationArn(scope, id, ecsApplicationArn)

public static fromEcsApplicationArn(scope: Construct, id: string, ecsApplicationArn: string): IEcsApplication

Parameters

  • scope Construct — the parent Construct for this new Construct.
  • id string — the logical ID of this new Construct.
  • ecsApplicationArn string — the ARN of the application to import.

Returns

  • IEcsApplication

Import an Application defined either outside the CDK, or in a different CDK Stack, by ARN.


static fromEcsApplicationName(scope, id, ecsApplicationName)

public static fromEcsApplicationName(scope: Construct, id: string, ecsApplicationName: string): IEcsApplication

Parameters

  • scope Construct — the parent Construct for this new Construct.
  • id string — the logical ID of this new Construct.
  • ecsApplicationName string — the name of the application to import.

Returns

  • IEcsApplication

Import an Application defined either outside the CDK, or in a different CDK Stack.

The Application's account and region are assumed to be the same as the stack it is being imported into. If not, use fromEcsApplicationArn.