» aws_ecs_task_definition

Manages a revision of 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

  • 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.
  • ipc_mode - (Optional) The IPC resource namespace to be used for the containers in the task The valid values are host, task, and none.
  • pid_mode - (Optional) The process namespace to use for the containers in the task. The valid values are host and task.
  • 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.
  • tags - (Optional) Key-value mapping of resource tags

» 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.
  • docker_volume_configuration - (Optional) Used to configure a docker volume

» Docker Volume Configuration Arguments

For more information, see Specifying a Docker volume in your Task Definition Developer Guide

  • scope - (Optional) The scope for the Docker volume, which determines its lifecycle, either task or shared. Docker volumes that are scoped to a task are automatically provisioned when the task starts and destroyed when the task stops. Docker volumes that are scoped as shared persist after the task stops.
  • autoprovision - (Optional) If this value is true, the Docker volume is created if it does not already exist. Note: This field is only used if the scope is shared.
  • driver - (Optional) The Docker volume driver to use. The driver value must match the driver name provided by Docker because it is used for task placement.
  • driver_opts - (Optional) A map of Docker driver specific options.
  • labels - (Optional) A map of custom metadata to add to your Docker volume.
» Example Usage:
resource "aws_ecs_task_definition" "service" {
  family                = "service"
  container_definitions = "${file("task-definitions/service.json")}"

  volume {
    name = "service-storage"

    docker_volume_configuration {
      scope         = "shared"
      autoprovision = true
    }
  }
}

» Placement Constraints Arguments

» 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.