interface ITaskDefinition

Language	Type name
.NET	Amazon.CDK.AWS.ECS.ITaskDefinition
Java	software.amazon.awscdk.services.ecs.ITaskDefinition
Python	aws_cdk.aws_ecs.ITaskDefinition
TypeScript (source)	@aws-cdk/aws-ecs » ITaskDefinition

Implemented by Ec2TaskDefinition, ExternalTaskDefinition, FargateTaskDefinition, TaskDefinition

Obtainable from TaskDefinition.fromTaskDefinitionArn(), TaskDefinition.fromTaskDefinitionAttributes()

The interface for all task definitions.

Properties

Name	Type	Description
compatibility	Compatibility	What launch types this task definition should be compatible with.
env	ResourceEnvironment	The environment this resource belongs to.
isEc2Compatible	boolean	Return true if the task definition can be run on an EC2 cluster.
isExternalCompatible	boolean	Return true if the task definition can be run on a ECS Anywhere cluster.
isFargateCompatible	boolean	Return true if the task definition can be run on a Fargate cluster.
networkMode	NetworkMode	The networking mode to use for the containers in the task.
node	ConstructNode	The construct tree node for this construct.
stack	Stack	The stack in which this resource is defined.
taskDefinitionArn	string	ARN of this task definition.
taskRole	IRole	The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.
executionRole?	IRole	Execution role for this task definition.

---

compatibility

Type: Compatibility

What launch types this task definition should be compatible with.

---

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.

---

isEc2Compatible

Type: boolean

Return true if the task definition can be run on an EC2 cluster.

---

isExternalCompatible

Type: boolean

Return true if the task definition can be run on a ECS Anywhere cluster.

---

isFargateCompatible

Type: boolean

Return true if the task definition can be run on a Fargate cluster.

---

networkMode

Type: NetworkMode

The networking mode to use for the containers in the task.

---

node

Type: ConstructNode

The construct tree node for this construct.

---

stack

Type: Stack

The stack in which this resource is defined.

---

taskDefinitionArn

Type: string

ARN of this task definition.

---

taskRole

Type: IRole

The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.

---

executionRole?

Type: IRole (optional)

Execution role for this task definition.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

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