# Ec2TaskDefinition

The details of a task definition run on an EC2 cluster.

Extends: Construct › Resource › TaskDefinition › Ec2TaskDefinition
Implements: IResource, IEc2TaskDefinition, ITaskDefinition, IEnvironmentAware, ITaskDefinitionRef, IConstruct, IDependable

- CloudFormation: [`AWS::ECS::TaskDefinition`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-ecs-taskdefinition.html)
- L1 type: [`CfnTaskDefinition`](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.CfnTaskDefinition.html)
- Source: [`aws-ecs/lib/ec2/ec2-task-definition.ts`](https://github.com/aws/aws-cdk/blob/v2.273.0/packages/aws-cdk-lib/aws-ecs/lib/ec2/ec2-task-definition.ts#L92)
- Type last changed: v2.196.0 · 16 May 2025

## Example

```ts
// Create a Task Definition for the container to start
const taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');
taskDefinition.addContainer('TheContainer', {
  image: ecs.ContainerImage.fromRegistry('example-image'),
  memoryLimitMiB: 256,
  logging: ecs.LogDrivers.awsLogs({
    streamPrefix: 'EventDemo',
    mode: ecs.AwsLogDriverMode.NON_BLOCKING,
    maxBufferSize: Size.mebibytes(25),
  }),
});
```

## Initializer

```ts
new Ec2TaskDefinition(scope: Construct, id: string, props?: Ec2TaskDefinitionProps)
```

## Construct Props

- `enableFaultInjection`: boolean = undefined - ECS default setting is false — Enables fault injection and allows for fault injection requests to be accepted from the task's containers.

  Fault injection only works with tasks using the {@link NetworkMode.AWS_VPC} or {@link NetworkMode.HOST} network modes.

  **Default:** undefined - ECS default setting is false

- `executionRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) = An execution role will be automatically created if you use ECR images in your task definition. — The name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf.

  The role will be used to retrieve container images from ECR and create CloudWatch log groups.

  **Default:** An execution role will be automatically created if you use ECR images in your task definition.

- `family`: string = Automatically generated name. — The name of a family that this task definition is registered to.

  A family groups multiple versions of a task definition.

- `inferenceAccelerators`: [InferenceAccelerator](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.InferenceAccelerator.html)[] = No inference accelerators. — The inference accelerators to use for the containers in the task.

  Not supported in Fargate.

- `ipcMode`: [IpcMode](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.IpcMode.html) = IpcMode used by the task is not specified — The IPC resource namespace to use for the containers in the task.

  Not supported in Fargate and Windows containers.

  **Default:** IpcMode used by the task is not specified

- `networkMode`: [NetworkMode](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.NetworkMode.html) = NetworkMode.BRIDGE for EC2 tasks, AWS_VPC for Fargate tasks. — The Docker networking mode to use for the containers in the task.

  The valid values are NONE, BRIDGE, AWS_VPC, and HOST.

  **Default:** NetworkMode.BRIDGE for EC2 tasks, AWS_VPC for Fargate tasks.

- `pidMode`: [PidMode](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.PidMode.html) = PidMode used by the task is not specified — The process namespace to use for the containers in the task.

  Not supported in Windows containers.

  **Default:** PidMode used by the task is not specified

- `placementConstraints`: [PlacementConstraint](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.PlacementConstraint.html)[] = No placement constraints. — An array of placement constraint objects to use for the task.

  You can
  specify a maximum of 10 constraints per task (this limit includes
  constraints in the task definition and those specified at run time).

- `proxyConfiguration`: [ProxyConfiguration](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ProxyConfiguration.html) = No proxy configuration. — The configuration details for the App Mesh proxy.

- `taskRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) = A task role is automatically created for you. — The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.

  **Default:** A task role is automatically created for you.

- `volumes`: [Volume](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.Volume.html)[] = No volumes are passed to the Docker daemon on a container instance. — The list of volume definitions for the task.

  For more information, see
  [Task Definition Parameter Volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide//task_definition_parameters.html#volumes).

  **Default:** No volumes are passed to the Docker daemon on a container instance.

## Properties

- `compatibility`: [Compatibility](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.Compatibility.html) (required) — The task launch type compatibility requirement.

- `defaultContainer`: [ContainerDefinition](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ContainerDefinition.html) — Default container for this task.

  Load balancers will send traffic to this container. The first
  essential container that is added to this task will become the default
  container.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `ephemeralStorageGiB`: number — The amount (in GiB) of ephemeral storage to be allocated to the task.

  Only supported in Fargate platform version 1.4.0 or later for Linux tasks,
  and platform version 1.0.0 or later for Windows tasks.

- `executionRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) — Execution role for this task definition.

- `family`: string (required) — The name of a family that this task definition is registered to.

  A family groups multiple versions of a task definition.

- `inferenceAccelerators`: [InferenceAccelerator](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.InferenceAccelerator.html)[] (required) — Public getter method to access list of inference accelerators attached to the instance.

- `isEc2Compatible`: boolean (required) — Return true if the task definition can be run on an EC2 cluster.

- `isExternalCompatible`: boolean (required) — Return true if the task definition can be run on a ECS anywhere cluster.

- `isFargateCompatible`: boolean (required) — Return true if the task definition can be run on a Fargate cluster.

- `isManagedInstancesCompatible`: boolean (required) — Return true if the task definition can be run on Managed Instances.

- `networkMode`: [NetworkMode](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.NetworkMode.html) (required) — The networking mode to use for the containers in the task.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `pidMode`: [PidMode](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.PidMode.html) — The process namespace to use for the containers in the task.

  Only supported for tasks that are hosted on AWS Fargate if the tasks
  are using platform version 1.4.0 or later (Linux). Not supported in
  Windows containers. If pidMode is specified for a Fargate task,
  then runtimePlatform.operatingSystemFamily must also be specified.  For more
  information, see [Task Definition Parameters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_definition_pidmode).

- `PROPERTY_INJECTION_ID`: string (required) (static) — Uniquely identifies this class.

- `referencesSecretJsonField`: boolean — Whether this task definition has at least a container that references a specific JSON field of a secret stored in Secrets Manager.

- `runtimePlatform`: [RuntimePlatform](/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.RuntimePlatform.html) — The runtime platform (operating system family and CPU architecture) for the task definition, or `undefined` if none was configured.

  Intentionally public: `runtimePlatform` is already public API as an input prop and on the
  underlying L1 `CfnTaskDefinition`, so reading it back from the L2 is deliberate read-parity.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined.

- `taskDefinitionArn`: string (required) — The full Amazon Resource Name (ARN) of the task definition.

- `taskDefinitionRef`: [TaskDefinitionReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_ecs.TaskDefinitionReference.html) (required) — A reference to this task definition.

- `taskRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) (required) — The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.

## Methods

- `addContainer(id: string, props: ContainerDefinitionOptions): ContainerDefinition` — Tasks running in AWSVPC networking mode requires an additional environment variable for the region to be sourced.

  This override adds in the additional environment variable as required

- `addExtension(extension: ITaskDefinitionExtension): void` — Adds the specified extension to the task definition.

  Extension can be used to apply a packaged modification to
  a task definition.

- `addFirelensLogRouter(id: string, props: FirelensLogRouterDefinitionOptions): FirelensLogRouter` — Adds a firelens log router to the task definition.

- `addInferenceAccelerator(inferenceAccelerator: InferenceAccelerator): void` — ECS TaskDefinition's inferenceAccelerator is EOL since April 2024

- `addPlacementConstraint(constraint: PlacementConstraint): void` — Adds the specified placement constraint to the task definition.

- `addToExecutionRolePolicy(statement: PolicyStatement): void` — Adds a policy statement to the task execution IAM role.

- `addToTaskRolePolicy(statement: PolicyStatement): void` — Adds a policy statement to the task IAM role.

- `addVolume(volume: Volume): void` — Adds a volume to the task definition.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — 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`).

- `findContainer(containerName: string): ContainerDefinition` — Returns the container that match the provided containerName.

- `findPortMappingByName(name: string): PortMapping` — Determine the existing port mapping for the provided name.

  **Parameters**

  - `name` — : port mapping name.

  **Returns:** PortMapping for the provided name, if it exists.

- `fromEc2TaskDefinitionArn(scope: Construct, id: string, ec2TaskDefinitionArn: string): IEc2TaskDefinition` (static) — Imports a task definition from the specified task definition ARN.

- `fromEc2TaskDefinitionAttributes(scope: Construct, id: string, attrs: Ec2TaskDefinitionAttributes): IEc2TaskDefinition` (static) — Imports an existing Ec2 task definition from its attributes.

- `fromTaskDefinitionArn(scope: Construct, id: string, taskDefinitionArn: string): ITaskDefinition` (static) — Imports a task definition from the specified task definition ARN.

  The task will have a compatibility of EC2+Fargate.

- `fromTaskDefinitionAttributes(scope: Construct, id: string, attrs: TaskDefinitionAttributes): ITaskDefinition` (static) — Create a task definition from a task definition reference.

- `grantRun(grantee: IGrantable): Grant` — Grants permissions to run this task definition.

  This will grant the following permissions:

    - ecs:RunTask
    - iam:PassRole

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — Principal to grant consume rights to.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `obtainExecutionRole(): IRole` — Creates the task execution IAM role if it doesn't already exist.

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.