Skip to main content
版本:预览版

AWS ECS-CONTAINER-DEFINITION

描述

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

参数说明

属性

名称描述类型是否必须默认值
commandThe command that is passed to the containerlist(string)false
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 valuenumberfalse
container_definitionContainer definition overrides which allows for extra keys or overriding existing keys.map(any)false
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 HEALTHYlist(object({\n containerName = string\n condition = string\n }))false
container_imageThe image used to start the container. Images in the Docker Hub registry available by defaultstringtrue
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 valuenumberfalse
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 limitnumberfalse
container_nameThe name of the container. Up to 255 characters ([a-z], [A-Z], [0-9], -, _ allowed)stringtrue
disable_networkingWhen this parameter is true, networking is disabled within the container.boolfalse
dns_search_domainsContainer DNS search domains. A list of DNS search domains that are presented to the containerlist(string)false
dns_serversContainer DNS servers. This is a list of strings specifying the IP addresses of the DNS serverslist(string)false
docker_labelsThe configuration options to send to the docker_labelsmap(string)false
docker_security_optionsA list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.list(string)false
entrypointThe entry point that is passed to the containerlist(string)false
environmentThe environment variables to pass to the container. This is a list of maps. map_environment overrides environmentlist(object({\n name = string\n value = string\n }))false
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 mapslist(object({\n value = string\n type = string\n }))false
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 valueboolfalse
extra_hostsA list of hostnames and IP address mappings to append to the /etc/hosts file on the container. This is a list of mapslist(object({\n ipAddress = string\n hostname = string\n }))false
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.htmlobject({\n type = string\n options = map(string)\n })false
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({\n command = list(string)\n retries = number\n timeout = number\n interval = number\n startPeriod = number\n })false
hostnameThe hostname to use for your container.stringfalse
interactiveWhen this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated.boolfalse
linksList of container names this container can communicate with without port mappingslist(string)false
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.htmlobject({\n capabilities = object({\n add = list(string)\n drop = list(string)\n })\n devices = list(object({\n containerPath = string\n hostPath = string\n permissions = list(string)\n }))\n initProcessEnabled = bool\n maxSwap = number\n sharedMemorySize = number\n swappiness = number\n tmpfs = list(object({\n containerPath = string\n mountOptions = list(string)\n size = number\n }))\n })false
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.htmlanyfalse
map_environmentThe environment variables to pass to the container. This is a map of string: {key: value}. map_environment overrides environmentmap(string)false
map_secretsThe secrets variables to pass to the container. This is a map of string: {key: value}. map_secrets overrides secretsmap(string)false
mount_pointsContainer mount points. This is a list of maps, where each map should contain containerPath, sourceVolume and readOnlylist(object({\n containerPath = string\n sourceVolume = string\n readOnly = bool\n }))false
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 containerPortlist(object({\n containerPort = number\n hostPort = number\n protocol = string\n }))false
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.boolfalse
pseudo_terminalWhen this parameter is true, a TTY is allocated.boolfalse
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 valueboolfalse
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 credentialsmap(string)false
resource_requirementsThe type and amount of a resource to assign to a container. The only supported resource is a GPU.list(object({\n type = string\n value = string\n }))false
secretsThe secrets to pass to the container. This is a list of mapslist(object({\n name = string\n valueFrom = string\n }))false
start_timeoutTime duration (in seconds) to wait before giving up on resolving dependencies for a containernumberfalse
stop_timeoutTime duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its ownnumberfalse
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(map(string))false
ulimitsContainer ulimit settings. This is a list of maps, where each map should contain "name", "hardLimit" and "softLimit"list(object({\n name = string\n hardLimit = number\n softLimit = number\n }))false
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.stringfalse
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({\n sourceContainer = string\n readOnly = bool\n }))false
working_directoryThe working directory to run commands inside the containerstringfalse
writeConnectionSecretToRefThe secret which the cloud resource connection will be written towriteConnectionSecretToReffalse

writeConnectionSecretToRef

名称描述类型是否必须默认值
nameThe secret name which the cloud resource connection will be written tostringtrue
namespaceThe secret namespace which the cloud resource connection will be written tostringfalse