interface CfnTaskDefinitionProps

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

Properties for defining a CfnTaskDefinition.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ecs from '@aws-cdk/aws-ecs';
const cfnTaskDefinitionProps: ecs.CfnTaskDefinitionProps = {
  containerDefinitions: [{
    image: 'image',
    name: 'name',

    // the properties below are optional
    command: ['command'],
    cpu: 123,
    dependsOn: [{
      condition: 'condition',
      containerName: 'containerName',
    }],
    disableNetworking: false,
    dnsSearchDomains: ['dnsSearchDomains'],
    dnsServers: ['dnsServers'],
    dockerLabels: {
      dockerLabelsKey: 'dockerLabels',
    },
    dockerSecurityOptions: ['dockerSecurityOptions'],
    entryPoint: ['entryPoint'],
    environment: [{
      name: 'name',
      value: 'value',
    }],
    environmentFiles: [{
      type: 'type',
      value: 'value',
    }],
    essential: false,
    extraHosts: [{
      hostname: 'hostname',
      ipAddress: 'ipAddress',
    }],
    firelensConfiguration: {
      options: {
        optionsKey: 'options',
      },
      type: 'type',
    },
    healthCheck: {
      command: ['command'],
      interval: 123,
      retries: 123,
      startPeriod: 123,
      timeout: 123,
    },
    hostname: 'hostname',
    interactive: false,
    links: ['links'],
    linuxParameters: {
      capabilities: {
        add: ['add'],
        drop: ['drop'],
      },
      devices: [{
        containerPath: 'containerPath',
        hostPath: 'hostPath',
        permissions: ['permissions'],
      }],
      initProcessEnabled: false,
      maxSwap: 123,
      sharedMemorySize: 123,
      swappiness: 123,
      tmpfs: [{
        size: 123,

        // the properties below are optional
        containerPath: 'containerPath',
        mountOptions: ['mountOptions'],
      }],
    },
    logConfiguration: {
      logDriver: 'logDriver',

      // the properties below are optional
      options: {
        optionsKey: 'options',
      },
      secretOptions: [{
        name: 'name',
        valueFrom: 'valueFrom',
      }],
    },
    memory: 123,
    memoryReservation: 123,
    mountPoints: [{
      containerPath: 'containerPath',
      readOnly: false,
      sourceVolume: 'sourceVolume',
    }],
    portMappings: [{
      appProtocol: 'appProtocol',
      containerPort: 123,
      containerPortRange: 'containerPortRange',
      hostPort: 123,
      name: 'name',
      protocol: 'protocol',
    }],
    privileged: false,
    pseudoTerminal: false,
    readonlyRootFilesystem: false,
    repositoryCredentials: {
      credentialsParameter: 'credentialsParameter',
    },
    resourceRequirements: [{
      type: 'type',
      value: 'value',
    }],
    secrets: [{
      name: 'name',
      valueFrom: 'valueFrom',
    }],
    startTimeout: 123,
    stopTimeout: 123,
    systemControls: [{
      namespace: 'namespace',
      value: 'value',
    }],
    ulimits: [{
      hardLimit: 123,
      name: 'name',
      softLimit: 123,
    }],
    user: 'user',
    volumesFrom: [{
      readOnly: false,
      sourceContainer: 'sourceContainer',
    }],
    workingDirectory: 'workingDirectory',
  }],
  cpu: 'cpu',
  ephemeralStorage: {
    sizeInGiB: 123,
  },
  executionRoleArn: 'executionRoleArn',
  family: 'family',
  inferenceAccelerators: [{
    deviceName: 'deviceName',
    deviceType: 'deviceType',
  }],
  ipcMode: 'ipcMode',
  memory: 'memory',
  networkMode: 'networkMode',
  pidMode: 'pidMode',
  placementConstraints: [{
    type: 'type',

    // the properties below are optional
    expression: 'expression',
  }],
  proxyConfiguration: {
    containerName: 'containerName',

    // the properties below are optional
    proxyConfigurationProperties: [{
      name: 'name',
      value: 'value',
    }],
    type: 'type',
  },
  requiresCompatibilities: ['requiresCompatibilities'],
  runtimePlatform: {
    cpuArchitecture: 'cpuArchitecture',
    operatingSystemFamily: 'operatingSystemFamily',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  taskRoleArn: 'taskRoleArn',
  volumes: [{
    dockerVolumeConfiguration: {
      autoprovision: false,
      driver: 'driver',
      driverOpts: {
        driverOptsKey: 'driverOpts',
      },
      labels: {
        labelsKey: 'labels',
      },
      scope: 'scope',
    },
    efsVolumeConfiguration: {
      filesystemId: 'filesystemId',

      // the properties below are optional
      authorizationConfig: {
        accessPointId: 'accessPointId',
        iam: 'iam',
      },
      rootDirectory: 'rootDirectory',
      transitEncryption: 'transitEncryption',
      transitEncryptionPort: 123,
    },
    host: {
      sourcePath: 'sourcePath',
    },
    name: 'name',
  }],
};

Properties

Name	Type	Description
containerDefinitions?	`IResolvable` `\|` `ContainerDefinitionProperty` `\|` `IResolvable[]`	A list of container definitions in JSON format that describe the different containers that make up your task.
cpu?	`string`	The number of `cpu` units used by the task.
ephemeralStorage?	`IResolvable` `\|` `EphemeralStorageProperty`	The ephemeral storage settings to use for tasks run with the task definition.
executionRoleArn?	`string`	The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf.
family?	`string`	The name of a family that this task definition is registered to.
inferenceAccelerators?	`IResolvable` `\|` `IResolvable` `\|` `InferenceAcceleratorProperty[]`	The Elastic Inference accelerators to use for the containers in the task.
ipcMode?	`string`	The IPC resource namespace to use for the containers in the task.
memory?	`string`	The amount (in MiB) of memory used by the task.
networkMode?	`string`	The Docker networking mode to use for the containers in the task.
pidMode?	`string`	The process namespace to use for the containers in the task.
placementConstraints?	`IResolvable` `\|` `IResolvable` `\|` `TaskDefinitionPlacementConstraintProperty[]`	An array of placement constraint objects to use for tasks.
proxyConfiguration?	`ProxyConfigurationProperty` `\|` `IResolvable`	The configuration details for the App Mesh proxy.
requiresCompatibilities?	`string[]`	The task launch types the task definition was validated against.
runtimePlatform?	`IResolvable` `\|` `RuntimePlatformProperty`	The operating system that your tasks definitions run on.
tags?	`CfnTag[]`	The metadata that you apply to the task definition to help you categorize and organize them.
taskRoleArn?	`string`	The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf.
volumes?	`IResolvable` `\|` `IResolvable` `\|` `VolumeProperty[]`	The list of data volume definitions for the task.

containerDefinitions?

Type: IResolvable | ContainerDefinitionProperty | IResolvable[] (optional)

A list of container definitions in JSON format that describe the different containers that make up your task.

For more information about container definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide .

cpu?

Type: string (optional)

The number of cpu units used by the task.

If you use the EC2 launch type, this field is optional. Any value can be used. If you use the Fargate launch type, this field is required. You must use one of the following values. The value that you choose determines your range of valid values for the memory parameter.

The CPU units cannot be less than 1 vCPU when you use Windows containers on Fargate.

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: 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory values: 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
8192 (8 vCPU) - Available memory values: 16 GB and 60 GB in 4 GB increments

This option requires Linux platform 1.4.0 or later.

16384 (16vCPU) - Available memory values: 32GB and 120 GB in 8 GB increments

This option requires Linux platform 1.4.0 or later.

ephemeralStorage?

Type: IResolvable | EphemeralStorageProperty (optional)

The ephemeral storage settings to use for tasks run with the task definition.

executionRoleArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent permission to make AWS API calls on your behalf.

The task execution IAM role is required depending on the requirements of your task. For more information, see Amazon ECS task execution IAM role in the Amazon Elastic Container Service Developer Guide .

family?

Type: string (optional)

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

Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

A family groups multiple versions of a task definition. Amazon ECS gives the first task definition that you registered to a family a revision number of 1. Amazon ECS gives sequential revision numbers to each task definition that you add.

To use revision numbers when you update a task definition, specify this property. If you don't specify a value, AWS CloudFormation generates a new task definition each time that you update it.

inferenceAccelerators?

Type: IResolvable | IResolvable | InferenceAcceleratorProperty[] (optional)

The Elastic Inference accelerators to use for the containers in the task.

ipcMode?

Type: string (optional)

The IPC resource namespace to use for the containers in the task.

The valid values are host , task , or none . If host is specified, then all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same IPC resources. If none is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference .

If the host IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see Docker security .

If you are setting namespaced kernel parameters using systemControls for the containers in the task, the following will apply to your IPC resource namespace. For more information, see System Controls in the Amazon Elastic Container Service Developer Guide .

For tasks that use the host IPC mode, IPC namespace related systemControls are not supported.
For tasks that use the task IPC mode, IPC namespace related systemControls will apply to all containers within a task.

This parameter is not supported for Windows containers or tasks run on AWS Fargate .

memory?

Type: string (optional)

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

If your tasks runs on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified, the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see ContainerDefinition .

If your tasks runs on AWS Fargate , this field is required. You must use one of the following values. The value you choose 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)
Between 16 GB and 60 GB in 4 GB increments - Available cpu values: 8192 (8 vCPU)

This option requires Linux platform 1.4.0 or later.

Between 32GB and 120 GB in 8 GB increments - Available cpu values: 16384 (16 vCPU)

This option requires Linux platform 1.4.0 or later.

networkMode?

Type: string (optional)

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

The valid values are none , bridge , awsvpc , and host . If no network mode is specified, the default is bridge .

For Amazon ECS tasks on Fargate, the awsvpc network mode is required. For Amazon ECS tasks on Amazon EC2 Linux instances, any network mode can be used. For Amazon ECS tasks on Amazon EC2 Windows instances, <default> or awsvpc can be used. If the network mode is set to none , you cannot specify port mappings in your container definitions, and the tasks containers do not have external connectivity. The host and awsvpc network modes offer the highest networking performance for containers because they use the EC2 network stack instead of the virtualized network stack provided by the bridge mode.

With the host and awsvpc network modes, exposed container ports are mapped directly to the corresponding host port (for the host network mode) or the attached elastic network interface port (for the awsvpc network mode), so you cannot take advantage of dynamic host port mappings.

When using the host network mode, you should not run containers using the root user (UID 0). It is considered best practice to use a non-root user.

If the network mode is awsvpc , the task is allocated an elastic network interface, and you must specify a NetworkConfiguration value when you create a service or run a task with the task definition. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide .

If the network mode is host , you cannot run multiple instantiations of the same task on a single container instance when port mappings are used.

For more information, see Network settings in the Docker run reference .

pidMode?

Type: string (optional)

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

The valid values are host or task . If host is specified, then all containers within the tasks that specified the host PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If task is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see PID settings in the Docker run reference .

If the host PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see Docker security .

This parameter is not supported for Windows containers or tasks run on AWS Fargate .

placementConstraints?

Type: IResolvable | IResolvable | TaskDefinitionPlacementConstraintProperty[] (optional)

An array of placement constraint objects to use for tasks.

This parameter isn't supported for tasks run on AWS Fargate .

proxyConfiguration?

Type: ProxyConfigurationProperty | IResolvable (optional)

The configuration details for the App Mesh proxy.

Your Amazon ECS container instances require at least version 1.26.0 of the container agent and at least version 1.26.0-1 of the ecs-init package to use a proxy configuration. If your container instances are launched from the Amazon ECS optimized AMI version 20190301 or later, they contain the required versions of the container agent and ecs-init . For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide .

requiresCompatibilities?

Type: string[] (optional)

The task launch types the task definition was validated against.

For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide .

runtimePlatform?

Type: IResolvable | RuntimePlatformProperty (optional)

The operating system that your tasks definitions run on.

A platform family is specified only for tasks using the Fargate launch type.

When you specify a task definition in a service, this value must match the runtimePlatform value of the service.

tags?

Type: CfnTag[] (optional)

The metadata that you apply to the task definition to help you categorize and organize them.

Each tag consists of a key and an optional value. You define both of them.

The following basic restrictions apply to tags:

Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

taskRoleArn?

Type: string (optional)

The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management role that grants containers in the task permission to call AWS APIs on your behalf.

For more information, see Amazon ECS Task Role in the Amazon Elastic Container Service Developer Guide .

IAM roles for tasks on Windows require that the -EnableTaskIAMRole option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code to use the feature. For more information, see Windows IAM roles for tasks in the Amazon Elastic Container Service Developer Guide .

volumes?

Type: IResolvable | IResolvable | VolumeProperty[] (optional)

The list of data volume definitions for the task.

For more information, see Using data volumes in tasks in the Amazon Elastic Container Service Developer Guide .

The host and sourcePath parameters aren't supported for tasks run on AWS Fargate .