aws_ecs_task_definition

Provides an ECS task definition to be used in aws_ecs_service.

Example Usage

resource "aws_ecs_task_definition" "service" {
  family                = "service"
  container_definitions = "${file("task-definitions/service.json")}"

  volume {
    name      = "service-storage"
    host_path = "/ecs/service-storage"
  }

  placement_constraints {
    type       = "memberOf"
    expression = "attribute:ecs.availability-zone in [us-west-2a, us-west-2b]"
  }
}

The referenced task-definitions/service.json file contains a valid JSON document, which is shown below, and its content is going to be passed directly into the container_definitions attribute as a string. Please note that this example contains only a small subset of the available parameters.

[
  {
    "name": "first",
    "image": "service-first",
    "cpu": 10,
    "memory": 512,
    "essential": true,
    "portMappings": [
      {
        "containerPort": 80,
        "hostPort": 80
      }
    ]
  },
  {
    "name": "second",
    "image": "service-second",
    "cpu": 10,
    "memory": 256,
    "essential": true,
    "portMappings": [
      {
        "containerPort": 443,
        "hostPort": 443
      }
    ]
  }
]

Argument Reference

Top-Level Arguments

• family - (Required) A unique name for your task definition.
• container_definitions - (Required) A list of valid container definitions provided as a single valid JSON document. Please note that you should only provide values that are part of the container definition document. For a detailed description of what parameters are available, see the Task Definition Parameters section from the official Developer Guide.

NOTE: Proper escaping is required for JSON field values containing quotes (") such as environment values. If directly setting the JSON, they should be escaped as \" in the JSON, e.g. "value": "I \"love\" escaped quotes". If using a Terraform variable value, they should be escaped as \\\" in the variable, e.g. value = "I \\\"love\\\" escaped quotes" in the variable and "value": "${var.myvariable}" in the JSON.

• task_role_arn - (Optional) The ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services.
• execution_role_arn - (Optional) The Amazon Resource Name (ARN) of the task execution role that the Amazon ECS container agent and the Docker daemon can assume.
• network_mode - (Optional) The Docker networking mode to use for the containers in the task. The valid values are none, bridge, awsvpc, and host.
• volume - (Optional) A set of volume blocks that containers in your task may use.
• placement_constraints - (Optional) A set of placement constraints rules that are taken into consideration during task placement. Maximum number of placement_constraints is 10.
• cpu - (Optional) The number of cpu units used by the task. If the requires_compatibilities is FARGATE this field is required.
• memory - (Optional) The amount (in MiB) of memory used by the task. If the requires_compatibilities is FARGATE this field is required.
• requires_compatibilities - (Optional) A set of launch types required by the task. The valid values are EC2 and FARGATE.

Volume Block Arguments

• name - (Required) The name of the volume. This name is referenced in the sourceVolume parameter of container definition in the mountPoints section.
• host_path - (Optional) The path on the host container instance that is presented to the container. If not set, ECS will create a nonpersistent data volume that starts empty and is deleted after the task has finished.

Placement Constraints Arguments

• type - (Required) The type of constraint. Use memberOf to restrict selection to a group of valid candidates. Note that distinctInstance is not supported in task definitions.
• expression - (Optional) Cluster Query Language expression to apply to the constraint. For more information, see Cluster Query Language in the Amazon EC2 Container Service Developer Guide.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• arn - Full ARN of the Task Definition (including both family and revision).
• family - The family of the Task Definition.
• revision - The revision of the task in a particular family.