Skip to main content

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

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
  # ...
}

Requirements​

NameVersion
terraform>= 1.3.0
local>= 1.2

Providers​

No providers.

Modules​

No modules.

Resources​

No resources.

Inputs​

NameDescriptionTypeDefaultRequired
commandThe command that is passed to the containerlist(string)nullno
container_cpuThe 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 valuenumber0no
container_definitionContainer definition overrides which allows for extra keys or overriding existing keys.
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
    })))
    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)
    volumesFrom = optional(list(object({
      readOnly        = optional(bool)
      sourceContainer = string
    })))
    workingDirectory = optional(string)
  })
{}no
container_depends_onThe 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
list(object({
    condition     = string
    containerName = string
  }))
nullno
container_imageThe image used to start the container. Images in the Docker Hub registry available by defaultstringn/ayes
container_memoryThe 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 valuenumbernullno
container_memory_reservationThe 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 limitnumbernullno
container_nameThe name of the container. Up to 255 characters ([a-z], [A-Z], [0-9], -, _ allowed)stringn/ayes
disable_networkingWhen this parameter is true, networking is disabled within the container.boolnullno
dns_search_domainsContainer DNS search domains. A list of DNS search domains that are presented to the containerlist(string)nullno
dns_serversContainer DNS servers. This is a list of strings specifying the IP addresses of the DNS serverslist(string)nullno
docker_labelsThe configuration options to send to the docker_labelsmap(string)nullno
docker_security_optionsA list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.list(string)nullno
entrypointThe entry point that is passed to the containerlist(string)nullno
environmentThe environment variables to pass to the container. This is a list of maps. map_environment overrides environment
list(object({
    name  = string
    value = string
  }))
nullno
environment_filesOne 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
list(object({
    type  = string
    value = string
  }))
nullno
essentialDetermines 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 valuebooltrueno
extra_hostsA list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This is a list of maps
list(object({
    hostname  = string
    ipAddress = string
  }))
nullno
firelens_configurationThe 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
object({
    options = optional(map(string))
    type    = string
  })
nullno
healthcheckA 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)
object({
    command     = list(string)
    interval    = optional(number)
    retries     = optional(number)
    startPeriod = optional(number)
    timeout     = optional(number)
  })
nullno
hostnameThe hostname to use for your container.stringnullno
interactiveWhen this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated.boolnullno
linksList of container names this container can communicate with without port mappingslist(string)nullno
linux_parametersLinux-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
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
    })))
  })
nullno
log_configurationLog 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
object({
    logDriver = string
    options   = optional(map(string))
    secretOptions = optional(list(object({
      name      = string
      valueFrom = string
    })))
  })
nullno
map_environmentThe environment variables to pass to the container. This is a map of string: {key: value}. map_environment overrides environmentmap(string)nullno
map_secretsThe secrets variables to pass to the container. This is a map of string: {key: value}. map_secrets overrides secretsmap(string)nullno
mount_pointsContainer mount points. This is a list of maps, where each map should contain containerPath, sourceVolume and readOnly
list(object({
    containerPath = optional(string)
    readOnly      = optional(bool)
    sourceVolume  = optional(string)
  }))
nullno
port_mappingsThe 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
list(object({
    containerPort = number
    hostPort      = optional(number)
    protocol      = optional(string)
    name          = optional(string)
    appProtocol   = optional(string)
  }))
nullno
privilegedWhen 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.boolnullno
pseudo_terminalWhen this parameter is true, a TTY is allocated.boolnullno
readonly_root_filesystemDetermines 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 valueboolfalseno
repository_credentialsContainer 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
object({
    credentialsParameter = string
  })
nullno
resource_requirementsThe type and amount of a resource to assign to a container. The only supported resource is a GPU.
list(object({
    type  = string
    value = string
  }))
nullno
secretsThe secrets to pass to the container. This is a list of maps
list(object({
    name      = string
    valueFrom = string
  }))
nullno
start_timeoutTime duration (in seconds) to wait before giving up on resolving dependencies for a containernumbernullno
stop_timeoutTime duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its ownnumbernullno
system_controlsA 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 = ""}
list(object({
    namespace = string
    value     = string
  }))
nullno
ulimitsContainer ulimit settings. This is a list of maps, where each map should contain "name", "hardLimit" and "softLimit"
list(object({
    hardLimit = number
    name      = string
    softLimit = number
  }))
nullno
userThe 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.stringnullno
volumes_fromA 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)
list(object({
    readOnly        = optional(bool)
    sourceContainer = string
  }))
nullno
working_directoryThe working directory to run commands inside the containerstringnullno

Outputs​

NameDescription
json_map_encodedJSON string encoded container definitions for use with other terraform resources such as aws_ecs_task_definition
json_map_encoded_listJSON string encoded list of container definitions for use with other terraform resources such as aws_ecs_task_definition
json_map_objectJSON map encoded container definition
sensitive_json_map_encodedJSON string encoded container definitions for use with other terraform resources such as aws_ecs_task_definition (sensitive)
sensitive_json_map_encoded_listJSON string encoded list of container definitions for use with other terraform resources such as aws_ecs_task_definition (sensitive)
sensitive_json_map_objectJSON map encoded container definition (sensitive)