AWS ECS Fargate Task Definition Terraform Module

This Terraform module creates an AWS ECS Fargate task definition.

Usage

Check versions for this module on:

Github Releases: https://github.com/cn-terraform/terraform-aws-ecs-fargate-task-definition/releases
Terraform Module Registry: https://registry.terraform.io/modules/cn-terraform/ecs-fargate-task-definition/aws

Install pre commit hooks.

Pleas run this command right after cloning the repository.

    pre-commit install

For that you may need to install the folowwing tools:

In order to run all checks at any point run the following command:

    pre-commit run --all-files

Requirements

Name	Version
terraform	>= 0.13
aws	>= 4

Providers

Name	Version
aws	4.0.0

Modules

Name	Source	Version
container_definition	cloudposse/ecs-container-definition/aws	0.58.1

Resources

Name	Type
aws_ecs_task_definition.td	resource
aws_iam_policy.ecs_task_execution_role_custom_policy	resource
aws_iam_role.ecs_task_execution_role	resource
aws_iam_role_policy_attachment.ecs_task_execution_role_custom_policy	resource
aws_iam_role_policy_attachment.ecs_task_execution_role_policy_attach	resource

Inputs

Name	Description	Type	Default	Required
command	The command that is passed to the container	`list(string)`	`null`	no
container_cpu	(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	`number`	`1024`	no
container_definition	Container definition overrides which allows for extra keys or overriding existing keys.	`map(any)`	`{}`	no
container_depends_on	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	list(object({ containerName = string condition = string }))	`[]`	no
container_image	The image used to start the container. Images in the Docker Hub registry available by default	`string`	`null`	no
container_memory	(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	`number`	`4096`	no
container_memory_reservation	(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	`number`	`2048`	no
container_name	The name of the container. Up to 255 characters ([a-z], [A-Z], [0-9], -, _ allowed)	`string`	`null`	no
containers	Container definitions to use for the task. If this is used, all other container options will be ignored.	`list(any)`	`[]`	no
disable_networking	When this parameter is true, networking is disabled within the container.	`bool`	`null`	no
dns_search_domains	Container DNS search domains. A list of DNS search domains that are presented to the container	`list(string)`	`[]`	no
dns_servers	Container DNS servers. This is a list of strings specifying the IP addresses of the DNS servers	`list(string)`	`[]`	no
docker_labels	The configuration options to send to the `docker_labels`	`map(string)`	`null`	no
docker_security_options	A list of strings to provide custom labels for SELinux and AppArmor multi-level security systems.	`list(string)`	`[]`	no
ecs_task_execution_role_custom_policies	(Optional) Custom policies to attach to the ECS task execution role. For example for reading secrets from AWS Systems Manager Parameter Store or Secrets Manager	`list(string)`	`[]`	no
entrypoint	The entry point that is passed to the container	`list(string)`	`null`	no
environment	The environment variables to pass to the container. This is a list of maps. map_environment overrides environment	list(object({ name = string value = string }))	`[]`	no
environment_files	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	list(object({ value = string type = string }))	`[]`	no
ephemeral_storage_size	The number of GBs to provision for ephemeral storage on Fargate tasks. Must be greater than or equal to 21 and less than or equal to 200	`number`	`0`	no
essential	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	`bool`	`true`	no
extra_hosts	A 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({ ipAddress = string hostname = string }))	`null`	no
firelens_configuration	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	object({ type = string options = map(string) })	`null`	no
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)	object({ command = list(string) retries = number timeout = number interval = number startPeriod = number })	`null`	no
hostname	The hostname to use for your container.	`string`	`null`	no
iam_partition	IAM partition to use when referencing standard policies. GovCloud and some other regions use different partitions	`string`	`"aws"`	no
interactive	When this parameter is true, this allows you to deploy containerized applications that require stdin or a tty to be allocated.	`bool`	`null`	no
links	List of container names this container can communicate with without port mappings	`list(string)`	`[]`	no
linux_parameters	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	object({ capabilities = object({ add = list(string) drop = list(string) }) devices = list(object({ containerPath = string hostPath = string permissions = list(string) })) initProcessEnabled = bool maxSwap = number sharedMemorySize = number swappiness = number tmpfs = list(object({ containerPath = string mountOptions = list(string) size = number })) })	`null`	no
log_configuration	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	`any`	`null`	no
map_environment	The environment variables to pass to the container. This is a map of string: {key: value}. map_environment overrides environment	`map(string)`	`null`	no
mount_points	Container mount points. This is a list of maps, where each map should contain a `containerPath` and `sourceVolume`. The `readOnly` key is optional.	`list(any)`	`[]`	no
name_prefix	Name prefix for resources on AWS	`any`	n/a	yes
permissions_boundary	(Optional) The ARN of the policy that is used to set the permissions boundary for the `ecs_task_execution_role` role.	`string`	`null`	no
placement_constraints	(Optional) A set of placement constraints rules that are taken into consideration during task placement. Maximum number of placement_constraints is 10. This is a list of maps, where each map should contain "type" and "expression"	`list(any)`	`[]`	no
port_mappings	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	list(object({ containerPort = number hostPort = number protocol = string }))	[ { "containerPort": 80, "hostPort": 80, "protocol": "tcp" } ]	no
privileged	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.	`bool`	`null`	no
proxy_configuration	(Optional) The proxy configuration details for the App Mesh proxy. This is a list of maps, where each map should contain "container_name", "properties" and "type"	`list(any)`	`[]`	no
pseudo_terminal	When this parameter is true, a TTY is allocated.	`bool`	`null`	no
readonly_root_filesystem	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	`bool`	`false`	no
repository_credentials	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	`map(string)`	`null`	no
secrets	The secrets to pass to the container. This is a list of maps	list(object({ name = string valueFrom = string }))	`[]`	no
start_timeout	Time duration (in seconds) to wait before giving up on resolving dependencies for a container	`number`	`null`	no
stop_timeout	Time duration (in seconds) to wait before the container is forcefully killed if it doesn't exit normally on its own	`number`	`null`	no
system_controls	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 = ""}	`list(map(string))`	`[]`	no
tags	Resource tags	`map(string)`	`{}`	no
task_role_arn	(Optional) The ARN of IAM role that allows your Amazon ECS container task to make calls to other AWS services. If not specified, `aws_iam_role.ecs_task_execution_role.arn` is used	`string`	`null`	no
ulimits	Container ulimit settings. This is a list of maps, where each map should contain "name", "hardLimit" and "softLimit"	list(object({ name = string hardLimit = number softLimit = number }))	`null`	no
user	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.	`string`	`null`	no
volumes	(Optional) A set of volume blocks that containers in your task may use	list(object({ host_path = string name = string docker_volume_configuration = list(object({ autoprovision = bool driver = string driver_opts = map(string) labels = map(string) scope = string })) efs_volume_configuration = list(object({ file_system_id = string root_directory = string transit_encryption = string transit_encryption_port = string authorization_config = list(object({ access_point_id = string iam = string })) })) }))	`[]`	no
volumes_from	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)	list(object({ sourceContainer = string readOnly = bool }))	`[]`	no
working_directory	The working directory to run commands inside the container	`string`	`null`	no

Outputs

Name	Description
aws_ecs_task_definition_td_arn	Full ARN of the Task Definition (including both family and revision).
aws_ecs_task_definition_td_family	The family of the Task Definition.
aws_ecs_task_definition_td_revision	The revision of the task in a particular family.
aws_iam_role_ecs_task_execution_role_arn	The Amazon Resource Name (ARN) specifying the role.
aws_iam_role_ecs_task_execution_role_create_date	The creation date of the IAM role.
aws_iam_role_ecs_task_execution_role_description	The description of the role.
aws_iam_role_ecs_task_execution_role_id	The ID of the role.
aws_iam_role_ecs_task_execution_role_name	The name of the role.
aws_iam_role_ecs_task_execution_role_unique_id	The stable and unique string identifying the role.
container_name	Name of the container

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

cn-terraform / terraform-aws-ecs-fargate-task-definition

Programming Languages

Labels

Projects that are alternatives of or similar to terraform-aws-ecs-fargate-task-definition