1.204.0

interface Ec2TaskDefinitionProps

LanguageType name
.NETAmazon.CDK.AWS.ECS.Ec2TaskDefinitionProps
Javasoftware.amazon.awscdk.services.ecs.Ec2TaskDefinitionProps
Pythonaws_cdk.aws_ecs.Ec2TaskDefinitionProps
TypeScript (source)@aws-cdk/aws-ecs » Ec2TaskDefinitionProps

The properties for a task definition run on an EC2 cluster.

Example

const ec2TaskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef', {
  networkMode: ecs.NetworkMode.BRIDGE,
});

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

Properties

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.
inferenceAccelerators?InferenceAccelerator[]The inference accelerators to use for the containers in the task.
ipcMode?IpcModeThe IPC resource namespace to use for the containers in the task.
networkMode?NetworkModeThe Docker networking mode to use for the containers in the task.
pidMode?PidModeThe process namespace to use for the containers in the task.
placementConstraints?PlacementConstraint[]An array of placement constraint objects to use for 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.

inferenceAccelerators?

Type: InferenceAccelerator[] (optional, default: No inference accelerators.)

The inference accelerators to use for the containers in the task.

Not supported in Fargate.

ipcMode?

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

networkMode?

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

pidMode?

Type: PidMode (optional, default: PidMode used by the task is not specified)

The process namespace to use for the containers in the task.

Not supported in Fargate and Windows containers.

placementConstraints?

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

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.

← PreviousNext →