Module: ecs-container-definition

Terraform module to generate well-formed JSON documents that are passed to the aws_ecs_task_definition Terraform resource as container definitions.

Usage

This module is meant to be used as output only, meaning it will be used to create outputs which are consumed as a parameter by Terraform resources or other modules.

Caution: This module, unlike nearly all other Cloud Posse Terraform modules, does not use terraform-null-label. Furthermore, it has an input named environment which has a completely different meaning than the one in terraform-null-label. Do not call this module with the conventional context = module.this.context. See the documentation below for the usage of environment.

For complete examples, see

• multi-port mappings
• multi-type env vars
• multiple definitions
• string env vars

For a complete example with automated tests, see examples/complete with bats and Terratest for the example test.

module "container_definition" {
  source = "cloudposse/ecs-container-definition/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  container_name  = "geodesic"
  container_image = "cloudposse/geodesic"
}

The output of this module can then be used with one of our other modules.

module "ecs_alb_service_task" {
  source = "cloudposse/ecs-alb-service-task/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  # ...
  container_definition_json = module.container_definition.json_map_encoded_list
  # ...
}

Variables

Required Variables

container_image (string) required

The image used to start the container. Images in the Docker Hub registry available by default

container_name (string) required

The name of the container. Up to 255 characters ([a-z], [A-Z], [0-9], -, _ allowed)

Optional Variables

command (list(string)) optional

The command that is passed to the container

Default value: null

container_cpu (number) optional

The number of cpu units to reserve for the container. This is optional for tasks using Fargate launch type and the total amount of container_cpu of all containers in a task will need to be lower than the task-level cpu value

Default value: 0

container_definition optional

Container definition overrides which allows for extra keys or overriding existing keys.

Type:

object({
command = optional(list(string))
cpu     = optional(number)
dependsOn = optional(list(object({
  condition     = string
  containerName = string
})))
disableNetworking     = optional(bool)
dnsSearchDomains      = optional(list(string))
dnsServers            = optional(list(string))
dockerLabels          = optional(map(string))
dockerSecurityOptions = optional(list(string))
entryPoint            = optional(list(string))
environment = optional(list(object({
  name  = string
  value = string
})))
environmentFiles = optional(list(object({
  type  = string
  value = string
})))
essential = optional(bool)
extraHosts = optional(list(object({
  hostname  = string
  ipAddress = string
})))
firelensConfiguration = optional(object({
  options = optional(map(string))
  type    = string
}))
healthCheck = optional(object({
  command     = list(string)
  interval    = optional(number)
  retries     = optional(number)
  startPeriod = optional(number)
  timeout     = optional(number)
}))
hostname    = optional(string)
image       = optional(string)
interactive = optional(bool)
links       = optional(list(string))
linuxParameters = optional(object({
  capabilities = optional(object({
    add  = optional(list(string))
    drop = optional(list(string))
  }))
  devices = optional(list(object({
    containerPath = string
    hostPath      = string
    permissions   = optional(list(string))
  })))
  initProcessEnabled = optional(bool)
  maxSwap            = optional(number)
  sharedMemorySize   = optional(number)
  swappiness         = optional(number)
  tmpfs = optional(list(object({
    containerPath = string
    mountOptions  = optional(list(string))
    size          = number
  })))
}))
logConfiguration = optional(object({
  logDriver = string
  options   = optional(map(string))
  secretOptions = optional(list(object({
    name      = string
    valueFrom = string
  })))
}))
memory            = optional(number)
memoryReservation = optional(number)
mountPoints = optional(list(object({
  containerPath = optional(string)
  readOnly      = optional(bool)
  sourceVolume  = optional(string)
})))
name = optional(string)
portMappings = optional(list(object({
  containerPort = number
  hostPort      = optional(number)
  protocol      = optional(string)
  name          = optional(string)
  appProtocol   = optional(string)
})))
privileged             = optional(bool)
pseudoTerminal         = optional(bool)
readonlyRootFilesystem = optional(bool)
repositoryCredentials = optional(object({
  credentialsParameter = string
}))
resourceRequirements = optional(list(object({
  type  = string
  value = string
})))
restartPolicy = optional(object({
  enabled              = bool
  ignoredExitCodes     = optional(list(number))
  restartAttemptPeriod = optional(number)
}))
secrets = optional(list(object({
  name      = string
  valueFrom = string
})))
startTimeout = optional(number)
stopTimeout  = optional(number)
systemControls = optional(list(object({
  namespace = string
  value     = string
})))
ulimits = optional(list(object({
  hardLimit = number
  name      = string
  softLimit = number
})))
user               = optional(string)
versionConsistency = optional(string)
volumesFrom = optional(list(object({
  readOnly        = optional(bool)
  sourceContainer = string
})))
workingDirectory = optional(string)
})

Default value: { }

container_depends_on optional

The dependencies defined for container startup and shutdown. A container can contain multiple dependencies. When a dependency is defined for container startup, for container shutdown it is reversed. The condition can be one of START, COMPLETE, SUCCESS or HEALTHY

Type:

list(object({
condition     = string
containerName = string
}))

Default value: null

container_memory (number) optional

The amount of memory (in MiB) to allow the container to use. This is a hard limit, if the container attempts to exceed the container_memory, the container is killed. This field is optional for Fargate launch type and the total amount of container_memory of all containers in a task will need to be lower than the task memory value

Default value: null

container_memory_reservation (number) optional

The amount of memory (in MiB) to reserve for the container. If container needs to exceed this threshold, it can do so up to the set container_memory hard limit

Default value: null

disable_networking (bool) optional

When this parameter is true, networking is disabled within the container.

Default value: null

dns_search_domains (list(string)) optional

Container DNS search domains. A list of DNS search domains that are presented to the container

Default value: null

dns_servers (list(string)) optional

Container DNS servers. This is a list of strings specifying the IP addresses of the DNS servers

Default value: null

docker_labels (map(string)) optional

The configuration options to send to the docker_labels

Default value: null

docker_security_options (list(string)) optional

A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.

Default value: null

entrypoint (list(string)) optional

The entry point that is passed to the container

Default value: null

environment_files optional

One or more files containing the environment variables to pass to the container. This maps to the --env-file option to docker run. The file must be hosted in Amazon S3. This option is only available to tasks using the EC2 launch type. This is a list of maps

Type:

list(object({
type  = string
value = string
}))

Default value: null

essential (bool) optional

Determines whether all other containers in a task are stopped, if this container fails or stops for any reason. Due to how Terraform type casts booleans in json it is required to double quote this value

Default value: true

extra_hosts optional

A list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This is a list of maps

Type:

list(object({
hostname  = string
ipAddress = string
}))

Default value: null

firelens_configuration optional

The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more details, see https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_FirelensConfiguration.html

Type:

object({
options = optional(map(string))
type    = string
})

Default value: null

healthcheck optional

A map containing command (string), timeout, interval (duration in seconds), retries (1-10, number of times to retry before marking container unhealthy), and startPeriod (0-300, optional grace period to wait, in seconds, before failed healthchecks count toward retries)

Type:

object({
command     = list(string)
interval    = optional(number)
retries     = optional(number)
startPeriod = optional(number)
timeout     = optional(number)
})

Default value: null

hostname (string) optional

The hostname to use for your container.

Default value: null

interactive (bool) optional

When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated.

Default value: null

links (list(string)) optional

List of container names this container can communicate with without port mappings

Default value: null

linux_parameters optional

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more details, see https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LinuxParameters.html

Type:

object({
capabilities = optional(object({
  add  = optional(list(string))
  drop = optional(list(string))
}))
devices = optional(list(object({
  containerPath = string
  hostPath      = string
  permissions   = optional(list(string))
})))
initProcessEnabled = optional(bool)
maxSwap            = optional(number)
sharedMemorySize   = optional(number)
swappiness         = optional(number)
tmpfs = optional(list(object({
  containerPath = string
  mountOptions  = optional(list(string))
  size          = number
})))
})

Default value: null

log_configuration optional

Log configuration options to send to a custom log driver for the container. For more details, see https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html

Type:

object({
logDriver = string
options   = optional(map(string))
secretOptions = optional(list(object({
  name      = string
  valueFrom = string
})))
})

Default value: null

map_environment (map(string)) optional

The environment variables to pass to the container. This is a map of string: {key: value}. map_environment overrides environment

Default value: null

map_secrets (map(string)) optional

The secrets variables to pass to the container. This is a map of string: {key: value}. map_secrets overrides secrets

Default value: null

mount_points optional

Container mount points. This is a list of maps, where each map should contain containerPath, sourceVolume and readOnly

Type:

list(object({
containerPath = optional(string)
readOnly      = optional(bool)
sourceVolume  = optional(string)
}))

Default value: null

port_mappings optional

The port mappings to configure for the container. This is a list of maps. Each map should contain "containerPort", "hostPort", and "protocol", where "protocol" is one of "tcp" or "udp". If using containers in a task with the awsvpc or host network mode, the hostPort can either be left blank or set to the same value as the containerPort

Type:

list(object({
containerPort = number
hostPort      = optional(number)
protocol      = optional(string)
name          = optional(string)
appProtocol   = optional(string)
}))

Default value: null

privileged (bool) optional

When this variable is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter is not supported for Windows containers or tasks using the Fargate launch type.

Default value: null

pseudo_terminal (bool) optional

When this parameter is true, a TTY is allocated.

Default value: null

readonly_root_filesystem (bool) optional

Determines whether a container is given read-only access to its root filesystem. Due to how Terraform type casts booleans in json it is required to double quote this value

Default value: false

repository_credentials optional

Container repository credentials; required when using a private repo. This map currently supports a single key; "credentialsParameter", which should be the ARN of a Secrets Manager's secret holding the credentials

Type:

object({
credentialsParameter = string
})

Default value: null

resource_requirements optional

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

Type:

list(object({
type  = string
value = string
}))

Default value: null

restart_policy optional

The restart policy for a container. When you set up a restart policy, Amazon ECS can restart the container without needing to replace the task.

Type:

object({
enabled              = bool
ignoredExitCodes     = optional(list(number))
restartAttemptPeriod = optional(number)
})

Default value: null

secrets optional

The secrets to pass to the container. This is a list of maps

Type:

list(object({
name      = string
valueFrom = string
}))

Default value: null

start_timeout (number) optional

Time duration (in seconds) to wait before giving up on resolving dependencies for a container

Default value: null

stop_timeout (number) optional

Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own

Default value: null

system_controls optional

A list of namespaced kernel parameters to set in the container, mapping to the --sysctl option to docker run. This is a list of maps: { namespace = "", value = ""}

Type:

list(object({
namespace = string
value     = string
}))

Default value: null

ulimits optional

Container ulimit settings. This is a list of maps, where each map should contain "name", "hardLimit" and "softLimit"

Type:

list(object({
hardLimit = number
name      = string
softLimit = number
}))

Default value: null

user (string) optional

The user to run as inside the container. Can be any of these formats: user, user:group, uid, uid:gid, user:gid, uid:group. The default (null) will use the container's configured USER directive or root if not set.

Default value: null

version_consistency (string) optional

Specifies whether Amazon ECS will resolve the container image tag provided in the container definition to an image digest.

Default value: null

volumes_from optional

A list of VolumesFrom maps which contain "sourceContainer" (name of the container that has the volumes to mount) and "readOnly" (whether the container can write to the volume)

Type:

list(object({
readOnly        = optional(bool)
sourceContainer = string
}))

Default value: null

working_directory (string) optional

The working directory to run commands inside the container

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

environment optional

The environment variables to pass to the container. This is a list of maps. map_environment overrides environment
Required: No

Type:

list(object({
name  = string
value = string
}))

Default value: null

Outputs

json_map_encoded

JSON string encoded container definitions for use with other terraform resources such as aws_ecs_task_definition

json_map_encoded_list

JSON string encoded list of container definitions for use with other terraform resources such as aws_ecs_task_definition

json_map_object

JSON map encoded container definition

sensitive_json_map_encoded

JSON string encoded container definitions for use with other terraform resources such as aws_ecs_task_definition (sensitive)

sensitive_json_map_encoded_list

JSON string encoded list of container definitions for use with other terraform resources such as aws_ecs_task_definition (sensitive)

sensitive_json_map_object

JSON map encoded container definition (sensitive)

Dependencies

Requirements

• terraform, version: >= 1.3.0
• local, version: >= 1.2