TaskDefinitionProps

class aws_cdk.aws_ecs.TaskDefinitionProps(*, execution_role=None, family=None, proxy_configuration=None, task_role=None, volumes=None, compatibility, cpu=None, memory_mib=None, network_mode=None, placement_constraints=None)

Bases: aws_cdk.aws_ecs.CommonTaskDefinitionProps

__init__(*, execution_role=None, family=None, proxy_configuration=None, task_role=None, volumes=None, compatibility, cpu=None, memory_mib=None, network_mode=None, placement_constraints=None)

The properties for task definitions.

Parameters
  • execution_role (Optional[IRole]) – The name of the IAM task execution role that grants the ECS agent 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 (Optional[str]) – The name of a family that this task definition is registered to. A family groups multiple versions of a task definition. Default: - Automatically generated name.

  • proxy_configuration (Optional[ProxyConfiguration]) – The configuration details for the App Mesh proxy. Default: - No proxy configuration.

  • task_role (Optional[IRole]) – 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 (Optional[List[Volume]]) – The list of volume definitions for the task. For more information, see Task Definition Parameter Volumes. Default: - No volumes are passed to the Docker daemon on a container instance.

  • compatibility (Compatibility) – The task launch type compatiblity requirement.

  • cpu (Optional[str]) – The number of cpu units used by the task. If you are using the EC2 launch type, this field is optional and any value can be used. If you are 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) Default: - CPU units are not specified.

  • memory_mib (Optional[str]) – The amount (in MiB) of memory used by the task. If using the EC2 launch type, this field is optional and any value can be used. If 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) Default: - Memory used by task is not specified.

  • network_mode (Optional[NetworkMode]) – The networking mode to use for the containers in the task. On Fargate, the only supported networking mode is AwsVpc. Default: - NetworkMode.Bridge for EC2 tasks, AwsVpc for Fargate tasks.

  • placement_constraints (Optional[List[PlacementConstraint]]) – The placement constraints to use for tasks in the service. You can specify a maximum of 10 constraints per task (this limit includes constraints in the task definition and those specified at run time). Not supported in Fargate. Default: - No placement constraints.

Attributes

compatibility

The task launch type compatiblity requirement.

Return type

Compatibility

cpu

The number of cpu units used by the task.

If you are using the EC2 launch type, this field is optional and any value can be used. If you are 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)

default :default: - CPU units are not specified.

Return type

Optional[str]

execution_role

The name of the IAM task execution role that grants the ECS agent to call AWS APIs on your behalf.

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

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

Return type

Optional[IRole]

family

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

A family groups multiple versions of a task definition.

default :default: - Automatically generated name.

Return type

Optional[str]

memory_mib

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

If using the EC2 launch type, this field is optional and any value can be used. If 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)

default :default: - Memory used by task is not specified.

Return type

Optional[str]

network_mode

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

On Fargate, the only supported networking mode is AwsVpc.

default :default: - NetworkMode.Bridge for EC2 tasks, AwsVpc for Fargate tasks.

Return type

Optional[NetworkMode]

placement_constraints

The placement constraints to use for tasks in the service.

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

Not supported in Fargate.

default :default: - No placement constraints.

Return type

Optional[List[PlacementConstraint]]

proxy_configuration

The configuration details for the App Mesh proxy.

default :default: - No proxy configuration.

Return type

Optional[ProxyConfiguration]

task_role

The name of the IAM role that grants containers in the task permission to call AWS APIs on your behalf.

default :default: - A task role is automatically created for you.

Return type

Optional[IRole]

volumes

The list of volume definitions for the task.

For more information, see Task Definition Parameter Volumes.

default :default: - No volumes are passed to the Docker daemon on a container instance.

Return type

Optional[List[Volume]]