1.204.0

interface FargateTaskDefinitionProps

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

The properties for a task definition.

Example

const fargateTaskDefinition = new ecs.FargateTaskDefinition(this, 'TaskDef', {
  memoryLimitMiB: 512,
  cpu: 256,
});
const container = fargateTaskDefinition.addContainer("WebContainer", {
  // Use an image from DockerHub
  image: ecs.ContainerImage.fromRegistry("amazon/amazon-ecs-sample"),
  // ... other options here ...
});

Properties

NameTypeDescription
cpu?numberThe number of cpu units used by the task.
ephemeralStorageGiB?numberThe amount (in GiB) of ephemeral storage to be allocated to the task.
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.
memoryLimitMiB?numberThe amount (in MiB) of memory used by the task.
proxyConfiguration?ProxyConfigurationThe configuration details for the App Mesh proxy.
runtimePlatform?RuntimePlatformThe operating system that your task definitions are running on.
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.

cpu?

Type: number (optional, default: 256)

The number of cpu units used by the task.

For tasks using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the memory parameter:

256 (.25 vCPU) - Available memory values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)

512 (.5 vCPU) - Available memory values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)

1024 (1 vCPU) - Available memory values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)

2048 (2 vCPU) - Available memory values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)

4096 (4 vCPU) - Available memory values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)

ephemeralStorageGiB?

Type: number (optional, default: 20)

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

The maximum supported value is 200 GiB.

NOTE: This parameter is only supported for tasks hosted on AWS Fargate using platform version 1.4.0 or later.

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.

memoryLimitMiB?

Type: number (optional, default: 512)

The amount (in MiB) of memory used by the task.

For tasks using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the cpu parameter:

512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)

1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)

2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)

Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)

Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)

proxyConfiguration?

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

The configuration details for the App Mesh proxy.

runtimePlatform?

Type: RuntimePlatform (optional, default: Undefined.)

The operating system that your task definitions are running on.

A runtimePlatform is supported only for tasks using the Fargate launch type.

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 →