aws-cdk-lib.aws_ecs.ExternalTaskDefinition

class ExternalTaskDefinition (construct)

LanguageType name
.NETAmazon.CDK.AWS.ECS.ExternalTaskDefinition
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsecs#ExternalTaskDefinition
Javasoftware.amazon.awscdk.services.ecs.ExternalTaskDefinition
Pythonaws_cdk.aws_ecs.ExternalTaskDefinition
TypeScript (source)aws-cdk-lib » aws_ecs » ExternalTaskDefinition

Implements IConstruct, IDependable, IResource, ITaskDefinition, IExternalTaskDefinition

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

Example

const externalTaskDefinition = new ecs.ExternalTaskDefinition(this, 'TaskDef');

const container = externalTaskDefinition.addContainer("WebContainer", {
  // Use an image from DockerHub
  image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
  memoryLimitMiB: 1024,
  // ... other options here ...
});

Initializer

new ExternalTaskDefinition(scope: Construct, id: string, props?: ExternalTaskDefinitionProps)

Parameters

  • scope Construct
  • id string
  • props ExternalTaskDefinitionProps

Constructs a new instance of the ExternalTaskDefinition class.

Construct Props

NameTypeDescription
executionRole?IRoleThe name of the IAM task execution role that grants the ECS agent permission to call AWS APIs on your behalf.
family?stringThe name of a family that this task definition is registered to.
networkMode?NetworkModeThe networking mode to use for the containers in the task.
proxyConfiguration?ProxyConfigurationThe configuration details for the App Mesh proxy.
taskRole?IRoleThe name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.
volumes?Volume[]The list of volume definitions for the task.

executionRole?

Type: IRole (optional, default: 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.


family?

Type: string (optional, default: Automatically generated name.)

The name of a family that this task definition is registered to.

A family groups multiple versions of a task definition.


networkMode?

Type: NetworkMode (optional, default: NetworkMode.BRIDGE)

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

With ECS Anywhere, supported modes are bridge, host and none.


proxyConfiguration?

Type: ProxyConfiguration (optional, default: No proxy configuration.)

The configuration details for the App Mesh proxy.


taskRole?

Type: IRole (optional, default: 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.


volumes?

Type: Volume[] (optional, default: 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.

Properties

NameTypeDescription
compatibilityCompatibilityThe task launch type compatibility requirement.
envResourceEnvironmentThe environment this resource belongs to.
familystringThe name of a family that this task definition is registered to.
inferenceAcceleratorsInferenceAccelerator[]Public getter method to access list of inference accelerators attached to the instance.
isEc2CompatiblebooleanReturn true if the task definition can be run on an EC2 cluster.
isExternalCompatiblebooleanReturn true if the task definition can be run on a ECS anywhere cluster.
isFargateCompatiblebooleanReturn true if the task definition can be run on a Fargate cluster.
networkModeNetworkModeThe networking mode to use for the containers in the task.
nodeNodeThe tree node.
stackStackThe stack in which this resource is defined.
taskDefinitionArnstringThe full Amazon Resource Name (ARN) of the task definition.
taskRoleIRoleThe name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.
defaultContainer?ContainerDefinitionDefault container for this task.
ephemeralStorageGiB?numberThe amount (in GiB) of ephemeral storage to be allocated to the task.
executionRole?IRoleExecution role for this task definition.
referencesSecretJsonField?booleanWhether this task definition has at least a container that references a specific JSON field of a secret stored in Secrets Manager.

compatibility

Type: Compatibility

The task launch type compatibility requirement.


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.


family

Type: string

The name of a family that this task definition is registered to.

A family groups multiple versions of a task definition.


inferenceAccelerators

Type: InferenceAccelerator[]

Public getter method to access list of inference accelerators attached to the instance.


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: Node

The tree node.


stack

Type: Stack

The stack in which this resource is defined.


taskDefinitionArn

Type: string

The full Amazon Resource Name (ARN) of the 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.


defaultContainer?

Type: ContainerDefinition (optional)

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.


ephemeralStorageGiB?

Type: number (optional)

The amount (in GiB) of ephemeral storage to be allocated to the task.

Only supported in Fargate platform version 1.4.0 or later.


executionRole?

Type: IRole (optional)

Execution role for this task definition.


referencesSecretJsonField?

Type: boolean (optional)

Whether this task definition has at least a container that references a specific JSON field of a secret stored in Secrets Manager.

Methods

NameDescription
addContainer(id, props)Adds a new container to the task definition.
addExtension(extension)Adds the specified extension to the task definition.
addFirelensLogRouter(id, props)Adds a firelens log router to the task definition.
addInferenceAccelerator(_inferenceAccelerator)Overriden method to throw error as interface accelerators are not supported for external tasks.
addPlacementConstraint(constraint)Adds the specified placement constraint to the task definition.
addToExecutionRolePolicy(statement)Adds a policy statement to the task execution IAM role.
addToTaskRolePolicy(statement)Adds a policy statement to the task IAM role.
addVolume(volume)Adds a volume to the task definition.
applyRemovalPolicy(policy)Apply the given removal policy to this resource.
findContainer(containerName)Returns the container that match the provided containerName.
findPortMappingByName(name)Determine the existing port mapping for the provided name.
grantRun(grantee)Grants permissions to run this task definition.
obtainExecutionRole()Creates the task execution IAM role if it doesn't already exist.
toString()Returns a string representation of this construct.
static fromEc2TaskDefinitionArn(scope, id, externalTaskDefinitionArn)Imports a task definition from the specified task definition ARN.
static fromExternalTaskDefinitionAttributes(scope, id, attrs)Imports an existing External task definition from its attributes.

addContainer(id, props)

public addContainer(id: string, props: ContainerDefinitionOptions): ContainerDefinition

Parameters

  • id string
  • props ContainerDefinitionOptions

Returns

  • ContainerDefinition

Adds a new container to the task definition.


addExtension(extension)

public addExtension(extension: ITaskDefinitionExtension): void

Parameters

  • extension ITaskDefinitionExtension

Adds the specified extension to the task definition.

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


addFirelensLogRouter(id, props)

public addFirelensLogRouter(id: string, props: FirelensLogRouterDefinitionOptions): FirelensLogRouter

Parameters

  • id string
  • props FirelensLogRouterDefinitionOptions

Returns

  • FirelensLogRouter

Adds a firelens log router to the task definition.


addInferenceAccelerator(_inferenceAccelerator)

public addInferenceAccelerator(_inferenceAccelerator: InferenceAccelerator): void

Parameters

  • _inferenceAccelerator InferenceAccelerator

Overriden method to throw error as interface accelerators are not supported for external tasks.


addPlacementConstraint(constraint)

public addPlacementConstraint(constraint: PlacementConstraint): void

Parameters

  • constraint PlacementConstraint

Adds the specified placement constraint to the task definition.


addToExecutionRolePolicy(statement)

public addToExecutionRolePolicy(statement: PolicyStatement): void

Parameters

  • statement PolicyStatement

Adds a policy statement to the task execution IAM role.


addToTaskRolePolicy(statement)

public addToTaskRolePolicy(statement: PolicyStatement): void

Parameters

  • statement PolicyStatement

Adds a policy statement to the task IAM role.


addVolume(volume)

public addVolume(volume: Volume): void

Parameters

  • volume Volume

Adds a volume to the task definition.


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


findContainer(containerName)

public findContainer(containerName: string): ContainerDefinition

Parameters

  • containerName string

Returns

  • ContainerDefinition

Returns the container that match the provided containerName.


findPortMappingByName(name)

public findPortMappingByName(name: string): PortMapping

Parameters

  • name string — : port mapping name.

Returns

  • PortMapping

Determine the existing port mapping for the provided name.


grantRun(grantee)

public grantRun(grantee: IGrantable): Grant

Parameters

  • grantee IGrantable — Principal to grant consume rights to.

Returns

  • Grant

Grants permissions to run this task definition.

This will grant the following permissions:

  • ecs:RunTask
  • iam:PassRole

obtainExecutionRole()

public obtainExecutionRole(): IRole

Returns

  • IRole

Creates the task execution IAM role if it doesn't already exist.


toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromEc2TaskDefinitionArn(scope, id, externalTaskDefinitionArn)

public static fromEc2TaskDefinitionArn(scope: Construct, id: string, externalTaskDefinitionArn: string): IExternalTaskDefinition

Parameters

  • scope Construct
  • id string
  • externalTaskDefinitionArn string

Returns

  • IExternalTaskDefinition

Imports a task definition from the specified task definition ARN.


static fromExternalTaskDefinitionAttributes(scope, id, attrs)

public static fromExternalTaskDefinitionAttributes(scope: Construct, id: string, attrs: ExternalTaskDefinitionAttributes): IExternalTaskDefinition

Parameters

  • scope Construct
  • id string
  • attrs ExternalTaskDefinitionAttributes

Returns

  • IExternalTaskDefinition

Imports an existing External task definition from its attributes.