Awesome

Terraform module to create an ECS Service for a web app (task), and an ALB target group to route requests.

[!TIP]

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. Works with Github Actions, Atlantis, or Spacelift.
<details> <summary>Watch demo of using Atmos with Terraform</summary> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/> Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial. </detalis>

Usage

For a complete example, see examples/complete.

For automated test of the complete example using bats and Terratest, see test.

provider "aws" {
  region = var.region
}

module "label" {
  source     = "git::https://github.com/cloudposse/terraform-null-label.git?ref=tags/0.15.0"
  namespace  = var.namespace
  name       = var.name
  stage      = var.stage
  delimiter  = var.delimiter
  attributes = var.attributes
  tags       = var.tags
}

module "vpc" {
  source     = "git::https://github.com/cloudposse/terraform-aws-vpc.git?ref=tags/0.8.1"
  namespace  = var.namespace
  stage      = var.stage
  name       = var.name
  delimiter  = var.delimiter
  attributes = var.attributes
  cidr_block = var.vpc_cidr_block
  tags       = var.tags
}

module "subnets" {
  source               = "git::https://github.com/cloudposse/terraform-aws-dynamic-subnets.git?ref=tags/0.16.1"
  availability_zones   = var.availability_zones
  namespace            = var.namespace
  stage                = var.stage
  name                 = var.name
  attributes           = var.attributes
  delimiter            = var.delimiter
  vpc_id               = module.vpc.vpc_id
  igw_id               = module.vpc.igw_id
  cidr_block           = module.vpc.vpc_cidr_block
  nat_gateway_enabled  = true
  nat_instance_enabled = false
  tags                 = var.tags
}

resource "aws_ecs_cluster" "default" {
  name = module.label.id
  tags = module.label.tags
}

module "container_definition" {
  source                       = "git::https://github.com/cloudposse/terraform-aws-ecs-container-definition.git?ref=tags/0.21.0"
  container_name               = var.container_name
  container_image              = var.container_image
  container_memory             = var.container_memory
  container_memory_reservation = var.container_memory_reservation
  container_cpu                = var.container_cpu
  essential                    = var.container_essential
  readonly_root_filesystem     = var.container_readonly_root_filesystem
  environment                  = var.container_environment
  port_mappings                = var.container_port_mappings
  log_configuration            = var.container_log_configuration
}

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"
  namespace                          = var.namespace
  stage                              = var.stage
  name                               = var.name
  attributes                         = var.attributes
  delimiter                          = var.delimiter
  alb_security_group                 = module.vpc.vpc_default_security_group_id
  container_definition_json          = module.container_definition.json
  ecs_cluster_arn                    = aws_ecs_cluster.default.arn
  launch_type                        = var.ecs_launch_type
  vpc_id                             = module.vpc.vpc_id
  security_group_ids                 = [module.vpc.vpc_default_security_group_id]
  subnet_ids                         = module.subnets.public_subnet_ids
  tags                               = var.tags
  ignore_changes_task_definition     = var.ignore_changes_task_definition
  network_mode                       = var.network_mode
  assign_public_ip                   = var.assign_public_ip
  propagate_tags                     = var.propagate_tags
  health_check_grace_period_seconds  = var.health_check_grace_period_seconds
  deployment_minimum_healthy_percent = var.deployment_minimum_healthy_percent
  deployment_maximum_percent         = var.deployment_maximum_percent
  deployment_controller_type         = var.deployment_controller_type
  desired_count                      = var.desired_count
  task_memory                        = var.task_memory
  task_cpu                           = var.task_cpu
}

The container_image in the container_definition module is the Docker image used to start a container.

The container_definition is a string of JSON-encoded container definitions. Normally, you would place only one container definition here as the example above demonstrates. However, there might be situations where more than one container per task is more appropriate such as optionally in Fargate or in other cases where sidecars may be required. With cloudposse/terraform-aws-ecs-container-definition multi-container task definitions can be created using:

module "ecs_alb_service_task" {
  ...
  container_definition_json = jsonencode([
    module.first_container.json_map_object,
    module.second_container.json_map_object,
  ])
  ...
}

Refer to the multiple definitions example in cloudposse/terraform-aws-ecs-container-definition for details on defining multiple definitions.

This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

When a new task starts, the Amazon ECS container agent pulls the latest version of the specified image and tag for the container to use. However, subsequent updates to a repository image are not propagated to already running tasks.

Images in Amazon ECR repositories can be specified by either using the full registry/repository:tag or registry/repository@digest. For example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>:latest or 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>@sha256:94afd1f2e64d908bc90dbca0035a5b567EXAMPLE.

Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

For more info, see Container Definition.

[!IMPORTANT] In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen

Requirements

Name	Version
<a name="requirement_terraform"></a> terraform	>= 0.14.0
<a name="requirement_aws"></a> aws	>= 5.77

Providers

Name	Version
<a name="provider_aws"></a> aws	>= 5.77

Modules

Name	Source	Version
<a name="module_exec_label"></a> exec_label	cloudposse/label/null	0.25.0
<a name="module_service_connect_label"></a> service_connect_label	cloudposse/label/null	0.25.0
<a name="module_service_label"></a> service_label	cloudposse/label/null	0.25.0
<a name="module_task_label"></a> task_label	cloudposse/label/null	0.25.0
<a name="module_this"></a> this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_ecs_service.default	resource
aws_ecs_service.ignore_changes_desired_count	resource
aws_ecs_service.ignore_changes_task_definition	resource
aws_ecs_service.ignore_changes_task_definition_and_desired_count	resource
aws_ecs_task_definition.default	resource
aws_iam_role.ecs_exec	resource
aws_iam_role.ecs_service	resource
aws_iam_role.ecs_service_connect_tls	resource
aws_iam_role.ecs_task	resource
aws_iam_role_policy.ecs_exec	resource
aws_iam_role_policy.ecs_service	resource
aws_iam_role_policy.ecs_ssm_exec	resource
aws_iam_role_policy_attachment.ecs_exec	resource
aws_iam_role_policy_attachment.ecs_service_connect_tls	resource
aws_iam_role_policy_attachment.ecs_task	resource
aws_security_group.ecs_service	resource
aws_security_group_rule.alb	resource
aws_security_group_rule.allow_all_egress	resource
aws_security_group_rule.allow_icmp_ingress	resource
aws_security_group_rule.nlb	resource
aws_iam_policy_document.ecs_exec	data source
aws_iam_policy_document.ecs_service	data source
aws_iam_policy_document.ecs_service_connect_tls	data source
aws_iam_policy_document.ecs_service_policy	data source
aws_iam_policy_document.ecs_ssm_exec	data source
aws_iam_policy_document.ecs_task	data source
aws_iam_policy_document.ecs_task_exec	data source

Inputs

Name	Description	Type	Default	Required
<a name="input_additional_tag_map"></a> additional_tag_map	Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration.	`map(string)`	`{}`	no
<a name="input_alb_security_group"></a> alb_security_group	Security group of the ALB	`string`	`""`	no
<a name="input_assign_public_ip"></a> assign_public_ip	Assign a public IP address to the ENI (Fargate launch type only). Valid values are `true` or `false`. Default `false`	`bool`	`false`	no
<a name="input_attributes"></a> attributes	ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the `delimiter`<br/>and treated as a single ID element.	`list(string)`	`[]`	no
<a name="input_availability_zone_rebalancing"></a> availability_zone_rebalancing	ECS automatically redistributes tasks within a service across Availability Zones (AZs) to mitigate the risk of impaired application availability due to underlying infrastructure failures and task lifecycle activities. The valid values are `ENABLED` and `DISABLED`.	`string`	`"DISABLED"`	no
<a name="input_bind_mount_volumes"></a> bind_mount_volumes	Task bind mount volume definitions as list of configuration objects. You can define multiple bind mount volumes on the same task definition. Requires `name` and optionally `host_path`	`list(any)`	`[]`	no
<a name="input_capacity_provider_strategies"></a> capacity_provider_strategies	The capacity provider strategies to use for the service. See `capacity_provider_strategy` configuration block: https://www.terraform.io/docs/providers/aws/r/ecs_service.html#capacity_provider_strategy	<pre>list(object({<br/> capacity_provider = string<br/> weight = number<br/> base = number<br/> }))</pre>	`[]`	no
<a name="input_circuit_breaker_deployment_enabled"></a> circuit_breaker_deployment_enabled	If `true`, enable the deployment circuit breaker logic for the service. If using `CODE_DEPLOY` for `deployment_controller_type`, this value will be ignored	`bool`	`false`	no
<a name="input_circuit_breaker_rollback_enabled"></a> circuit_breaker_rollback_enabled	If `true`, Amazon ECS will roll back the service if a service deployment fails. If using `CODE_DEPLOY` for `deployment_controller_type`, this value will be ignored	`bool`	`false`	no
<a name="input_container_definition_json"></a> container_definition_json	A string containing a JSON-encoded array of container definitions<br/>(`"[{ "name": "container1", ... }, { "name": "container2", ... }]"`).<br/>See API_ContainerDefinition,<br/>cloudposse/terraform-aws-ecs-container-definition, or<br/>ecs_task_definition#container_definitions	`string`	n/a	yes
<a name="input_container_port"></a> container_port	The port on the container to allow traffic from the ALB security group	`number`	`80`	no
<a name="input_context"></a> context	Single object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as `null` to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged.	`any`	<pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre>	no
<a name="input_delimiter"></a> delimiter	Delimiter to be used between ID elements.<br/>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
<a name="input_deployment_controller_type"></a> deployment_controller_type	Type of deployment controller. Valid values are `CODE_DEPLOY` and `ECS`	`string`	`"ECS"`	no
<a name="input_deployment_maximum_percent"></a> deployment_maximum_percent	The upper limit of the number of tasks (as a percentage of `desired_count`) that can be running in a service during a deployment	`number`	`200`	no
<a name="input_deployment_minimum_healthy_percent"></a> deployment_minimum_healthy_percent	The lower limit (as a percentage of `desired_count`) of the number of tasks that must remain running and healthy in a service during a deployment	`number`	`100`	no
<a name="input_descriptor_formats"></a> descriptor_formats	Describe additional descriptors to be output in the `descriptors` output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>`{<br/> format = string<br/> labels = list(string)<br/>}`<br/>(Type is `any` so the map values can later be enhanced to provide additional options.)<br/>`format` is a Terraform format string to be passed to the `format()` function.<br/>`labels` is a list of labels, in order, to pass to `format()` function.<br/>Label values will be normalized before being passed to `format()` so they will be<br/>identical to how they appear in `id`.<br/>Default is `{}` (`descriptors` output will be empty).	`any`	`{}`	no
<a name="input_desired_count"></a> desired_count	The number of instances of the task definition to place and keep running	`number`	`1`	no
<a name="input_docker_volumes"></a> docker_volumes	Task docker volume definitions as list of configuration objects. You can define multiple Docker volumes on the same task definition, but a single volume can only have one `docker_volume_configuration`.	<pre>list(object({<br/> host_path = string<br/> name = string<br/> docker_volume_configuration = list(object({<br/> autoprovision = bool<br/> driver = string<br/> driver_opts = map(string)<br/> labels = map(string)<br/> scope = string<br/> }))<br/> }))</pre>	`[]`	no
<a name="input_ecs_cluster_arn"></a> ecs_cluster_arn	The ARN of the ECS cluster where service will be provisioned	`string`	n/a	yes
<a name="input_ecs_load_balancers"></a> ecs_load_balancers	A list of load balancer config objects for the ECS service; see ecs_service#load_balancer docs	<pre>list(object({<br/> container_name = string<br/> container_port = number<br/> elb_name = optional(string)<br/> target_group_arn = string<br/> }))</pre>	`[]`	no
<a name="input_ecs_service_enabled"></a> ecs_service_enabled	Whether or not to create the aws_ecs_service resource	`bool`	`true`	no
<a name="input_efs_volumes"></a> efs_volumes	Task EFS volume definitions as list of configuration objects. You can define multiple EFS volumes on the same task definition, but a single volume can only have one `efs_volume_configuration`.	<pre>list(object({<br/> host_path = string<br/> name = string<br/> efs_volume_configuration = list(object({<br/> file_system_id = string<br/> root_directory = string<br/> transit_encryption = string<br/> transit_encryption_port = string<br/> authorization_config = list(object({<br/> access_point_id = string<br/> iam = string<br/> }))<br/> }))<br/> }))</pre>	`[]`	no
<a name="input_enable_all_egress_rule"></a> enable_all_egress_rule	A flag to enable/disable adding the all ports egress rule to the service security group	`bool`	`true`	no
<a name="input_enable_ecs_managed_tags"></a> enable_ecs_managed_tags	Specifies whether to enable Amazon ECS managed tags for the tasks within the service	`bool`	`false`	no
<a name="input_enable_icmp_rule"></a> enable_icmp_rule	Specifies whether to enable ICMP on the service security group	`bool`	`false`	no
<a name="input_enabled"></a> enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
<a name="input_environment"></a> environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
<a name="input_ephemeral_storage_size"></a> 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
<a name="input_exec_enabled"></a> exec_enabled	Specifies whether to enable Amazon ECS Exec for the tasks within the service	`bool`	`false`	no
<a name="input_force_new_deployment"></a> force_new_deployment	Enable to force a new task deployment of the service.	`bool`	`false`	no
<a name="input_fsx_volumes"></a> fsx_volumes	Task FSx volume definitions as list of configuration objects. You can define multiple FSx volumes on the same task definition, but a single volume can only have one `fsx_windows_file_server_volume_configuration`.	<pre>list(object({<br/> host_path = string<br/> name = string<br/> fsx_windows_file_server_volume_configuration = list(object({<br/> file_system_id = string<br/> root_directory = string<br/> authorization_config = list(object({<br/> credentials_parameter = string<br/> domain = string<br/> }))<br/> }))<br/> }))</pre>	`[]`	no
<a name="input_health_check_grace_period_seconds"></a> health_check_grace_period_seconds	Seconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 7200. Only valid for services configured to use load balancers	`number`	`0`	no
<a name="input_id_length_limit"></a> id_length_limit	Limit `id` to this many characters (minimum 6).<br/>Set to `0` for unlimited length.<br/>Set to `null` for keep the existing setting, which defaults to `0`.<br/>Does not affect `id_full`.	`number`	`null`	no
<a name="input_ignore_changes_desired_count"></a> ignore_changes_desired_count	Whether to ignore changes for desired count in the ECS service	`bool`	`false`	no
<a name="input_ignore_changes_task_definition"></a> ignore_changes_task_definition	Whether to ignore changes in container definition and task definition in the ECS service	`bool`	`true`	no
<a name="input_ipc_mode"></a> ipc_mode	The IPC resource namespace to be used for the containers in the task.<br/>The valid values are `host`, `task`, and `none`. If `host` is specified,<br/>then all containers within the tasks that specified the `host` IPC mode on<br/>the same container instance share the same IPC resources with the host<br/>Amazon EC2 instance. If `task` is specified, all containers within the<br/>specified task share the same IPC resources. If `none` is specified, then<br/>IPC resources within the containers of a task are private and not shared<br/>with other containers in a task or on the container instance. If no value<br/>is specified, then the IPC resource namespace sharing depends on the<br/>Docker daemon setting on the container instance. For more information, see<br/>IPC settings in the Docker documentation."	`string`	`null`	no
<a name="input_label_key_case"></a> label_key_case	Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper`.<br/>Default value: `title`.	`string`	`null`	no
<a name="input_label_order"></a> label_order	The order in which the labels (ID elements) appear in the `id`.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	`list(string)`	`null`	no
<a name="input_label_value_case"></a> label_value_case	Controls the letter case of ID elements (labels) as included in `id`,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the `tags` input.<br/>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br/>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br/>Default value: `lower`.	`string`	`null`	no
<a name="input_labels_as_tags"></a> labels_as_tags	Set of labels (ID elements) to include as tags in the `tags` output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the `tags` output.<br/>Set to `[]` to suppress all generated tags.<br/>Notes:<br/> The value of the `name` tag, if included, will be the `id`, not the `name`.<br/> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	<pre>[<br/> "default"<br/>]</pre>	no
<a name="input_launch_type"></a> launch_type	The launch type on which to run your service. Valid values are `EC2` and `FARGATE`	`string`	`"FARGATE"`	no
<a name="input_name"></a> name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a `tag`.<br/>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input.	`string`	`null`	no
<a name="input_namespace"></a> namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	`string`	`null`	no
<a name="input_network_mode"></a> network_mode	The network mode to use for the task. This is required to be `awsvpc` for `FARGATE` `launch_type` or `null` for `EC2` `launch_type`	`string`	`"awsvpc"`	no
<a name="input_nlb_cidr_blocks"></a> nlb_cidr_blocks	A list of CIDR blocks to add to the ingress rule for the NLB container port	`list(string)`	`[]`	no
<a name="input_nlb_container_port"></a> nlb_container_port	The port on the container to allow traffic from the NLB	`number`	`80`	no
<a name="input_ordered_placement_strategy"></a> ordered_placement_strategy	Service level strategy rules that are taken into consideration during task placement.<br/>List from top to bottom in order of precedence. The maximum number of ordered_placement_strategy blocks is 5.<br/>See `ordered_placement_strategy`	<pre>list(object({<br/> type = string<br/> field = string<br/> }))</pre>	`[]`	no
<a name="input_permissions_boundary"></a> permissions_boundary	A permissions boundary ARN to apply to the 3 roles that are created.	`string`	`""`	no
<a name="input_pid_mode"></a> pid_mode	The process namespace to use for the containers in the task. The valid<br/>values are `host` and `task`. If `host` is specified, then all containers<br/>within the tasks that specified the `host` PID mode on the same container<br/>instance share the same process namespace with the host Amazon EC2 instanc<br/>. If `task` is specified, all containers within the specified task share<br/>the same process namespace. If no value is specified, then the process<br/>namespace sharing depends on the Docker daemon setting on the container<br/>instance. For more information, see PID settings in the Docker documentation.	`string`	`null`	no
<a name="input_platform_version"></a> platform_version	The platform version on which to run your service. Only applicable for `launch_type` set to `FARGATE`.<br/>More information about Fargate platform versions can be found in the AWS ECS User Guide.	`string`	`"LATEST"`	no
<a name="input_propagate_tags"></a> propagate_tags	Specifies whether to propagate the tags from the task definition or the service to the tasks. The valid values are SERVICE and TASK_DEFINITION	`string`	`null`	no
<a name="input_proxy_configuration"></a> proxy_configuration	The proxy configuration details for the App Mesh proxy. See `proxy_configuration` docs https://www.terraform.io/docs/providers/aws/r/ecs_task_definition.html#proxy-configuration-arguments	<pre>object({<br/> type = string<br/> container_name = string<br/> properties = map(string)<br/> })</pre>	`null`	no
<a name="input_redeploy_on_apply"></a> redeploy_on_apply	Updates the service to the latest task definition on each apply	`bool`	`false`	no
<a name="input_regex_replace_chars"></a> regex_replace_chars	Terraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
<a name="input_role_tags_enabled"></a> role_tags_enabled	Whether or not to create tags on ECS roles	`bool`	`true`	no
<a name="input_runtime_platform"></a> runtime_platform	Zero or one runtime platform configurations that containers in your task may use.<br/>Map of strings with optional keys `operating_system_family` and `cpu_architecture`.<br/>See `runtime_platform` docs https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition#runtime_platform	`list(map(string))`	`[]`	no
<a name="input_scheduling_strategy"></a> scheduling_strategy	The scheduling strategy to use for the service. The valid values are `REPLICA` and `DAEMON`.<br/>Note that Fargate tasks do not support the DAEMON scheduling strategy.	`string`	`"REPLICA"`	no
<a name="input_security_group_description"></a> security_group_description	The description to assign to the service security group.<br/>Warning: Changing the description causes the security group to be replaced.	`string`	`"Allow ALL egress from ECS service"`	no
<a name="input_security_group_enabled"></a> security_group_enabled	Whether to create a security group for the service.	`bool`	`true`	no
<a name="input_security_group_ids"></a> security_group_ids	Security group IDs to allow in Service `network_configuration` if `var.network_mode = "awsvpc"`	`list(string)`	`[]`	no
<a name="input_service_connect_configurations"></a> service_connect_configurations	The list of Service Connect configurations.<br/>See `service_connect_configuration` docs https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_service#service_connect_configuration	<pre>list(object({<br/> enabled = bool<br/> namespace = optional(string, null)<br/> log_configuration = optional(object({<br/> log_driver = string<br/> options = optional(map(string), null)<br/> secret_option = optional(list(object({<br/> name = string<br/> value_from = string<br/> })), [])<br/> }), null)<br/> service = optional(list(object({<br/> client_alias = list(object({<br/> dns_name = string<br/> port = number<br/> }))<br/> timeout = optional(list(object({<br/> idle_timeout_seconds = optional(number, null)<br/> per_request_timeout_seconds = optional(number, null)<br/> })), [])<br/> tls = optional(list(object({<br/> kms_key = optional(string, null)<br/> role_arn = optional(string, null)<br/> issuer_cert_authority = object({<br/> aws_pca_authority_arn = string<br/> })<br/> })), [])<br/> discovery_name = optional(string, null)<br/> ingress_port_override = optional(number, null)<br/> port_name = string<br/> })), [])<br/> }))</pre>	`[]`	no
<a name="input_service_placement_constraints"></a> service_placement_constraints	The rules that are taken into consideration during task placement. Maximum number of placement_constraints is 10. See `placement_constraints` docs	<pre>list(object({<br/> type = string<br/> expression = string<br/> }))</pre>	`[]`	no
<a name="input_service_registries"></a> service_registries	Zero or one service discovery registries for the service.<br/>The currently supported service registry is Amazon Route 53 Auto Naming Service - `aws_service_discovery_service`;<br/>see `service_registries` docs https://www.terraform.io/docs/providers/aws/r/ecs_service.html#service_registries-1"<br/>Service registry is object with required key `registry_arn = string` and optional keys<br/> `port = number`<br/> `container_name = string`<br/> `container_port = number`	`list(any)`	`[]`	no
<a name="input_service_role_arn"></a> service_role_arn	ARN of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is required if you are using a load balancer with your service, but only if your task definition does not use the awsvpc network mode. If using awsvpc network mode, do not specify this role. If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here.	`string`	`null`	no
<a name="input_stage"></a> stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
<a name="input_subnet_ids"></a> subnet_ids	Subnet IDs used in Service `network_configuration` if `var.network_mode = "awsvpc"`	`list(string)`	`null`	no
<a name="input_tags"></a> tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br/>Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
<a name="input_task_cpu"></a> task_cpu	The number of CPU units used by the task. If using `FARGATE` launch type `task_cpu` must match supported memory values	`number`	`256`	no
<a name="input_task_definition"></a> task_definition	A `list(string)` of zero or one ARNs of task definitions, to reuse<br/>reuse an existing task definition family and revision for the ecs<br/>service instead of creating one<br/>DEPRECATED: you can also pass a `string` with the ARN, but that<br/>string must be known a "plan" time.	`any`	`[]`	no
<a name="input_task_exec_policy_arns"></a> task_exec_policy_arns	A list of IAM Policy ARNs to attach to the generated task execution role.<br/>Changes to the list will have ripple effects, so use `task_exec_policy_arns_map` if possible.	`list(string)`	`[]`	no
<a name="input_task_exec_policy_arns_map"></a> task_exec_policy_arns_map	A map of name to IAM Policy ARNs to attach to the generated task execution role.<br/>The names are arbitrary, but must be known at plan time. The purpose of the name<br/>is so that changes to one ARN do not cause a ripple effect on the other ARNs.<br/>If you cannot provide unique names known at plan time, use `task_exec_policy_arns` instead.	`map(string)`	`{}`	no
<a name="input_task_exec_role_arn"></a> task_exec_role_arn	A `list(string)` of zero or one ARNs of IAM roles that allows the<br/>ECS/Fargate agent to make calls to the ECS API on your behalf.<br/>If the list is empty, a role will be created for you.<br/>DEPRECATED: you can also pass a `string` with the ARN, but that<br/>string must be known a "plan" time.	`any`	`[]`	no
<a name="input_task_memory"></a> task_memory	The amount of memory (in MiB) used by the task. If using Fargate launch type `task_memory` must match supported cpu value	`number`	`512`	no
<a name="input_task_placement_constraints"></a> task_placement_constraints	A set of placement constraints rules that are taken into consideration during task placement.<br/>Maximum number of placement_constraints is 10. See `placement_constraints`	<pre>list(object({<br/> type = string<br/> expression = string<br/> }))</pre>	`[]`	no
<a name="input_task_policy_arns"></a> task_policy_arns	A list of IAM Policy ARNs to attach to the generated task role.<br/>Changes to the list will have ripple effects, so use `task_policy_arns_map` if possible.	`list(string)`	`[]`	no
<a name="input_task_policy_arns_map"></a> task_policy_arns_map	A map of name to IAM Policy ARNs to attach to the generated task role.<br/>The names are arbitrary, but must be known at plan time. The purpose of the name<br/>is so that changes to one ARN do not cause a ripple effect on the other ARNs.<br/>If you cannot provide unique names known at plan time, use `task_policy_arns` instead.	`map(string)`	`{}`	no
<a name="input_task_role_arn"></a> task_role_arn	A `list(string)` of zero or one ARNs of IAM roles that allows<br/>your Amazon ECS container task to make calls to other AWS services.<br/>If the list is empty, a role will be created for you.<br/>DEPRECATED: you can also pass a `string` with the ARN, but that<br/>string must be known a "plan" time.	`any`	`[]`	no
<a name="input_tenant"></a> tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
<a name="input_track_latest"></a> track_latest	Whether should track latest task definition or the one created with the resource.	`bool`	`false`	no
<a name="input_use_alb_security_group"></a> use_alb_security_group	A flag to enable/disable allowing traffic from the ALB security group to the service security group	`bool`	`false`	no
<a name="input_use_nlb_cidr_blocks"></a> use_nlb_cidr_blocks	A flag to enable/disable adding the NLB ingress rule to the service security group	`bool`	`false`	no
<a name="input_use_old_arn"></a> use_old_arn	A flag to enable/disable tagging the ecs resources that require the new arn format	`bool`	`false`	no
<a name="input_vpc_id"></a> vpc_id	The VPC ID where resources are created	`string`	n/a	yes
<a name="input_wait_for_steady_state"></a> wait_for_steady_state	If true, it will wait for the service to reach a steady state (like aws ecs wait services-stable) before continuing	`bool`	`false`	no

Outputs

Name	Description
<a name="output_ecs_exec_role_policy_id"></a> ecs_exec_role_policy_id	The ECS service role policy ID, in the form of `role_name:role_policy_name`
<a name="output_ecs_exec_role_policy_name"></a> ecs_exec_role_policy_name	ECS service role name
<a name="output_service_arn"></a> service_arn	ECS Service ARN
<a name="output_service_name"></a> service_name	ECS Service name
<a name="output_service_role_arn"></a> service_role_arn	ECS Service role ARN
<a name="output_service_security_group_id"></a> service_security_group_id	Security Group ID of the ECS task
<a name="output_task_definition_arn"></a> task_definition_arn	ECS task definition ARN
<a name="output_task_definition_arn_without_revision"></a> task_definition_arn_without_revision	ECS task definition ARN without revision
<a name="output_task_definition_family"></a> task_definition_family	ECS task definition family
<a name="output_task_definition_revision"></a> task_definition_revision	ECS task definition revision
<a name="output_task_exec_role_arn"></a> task_exec_role_arn	ECS Task exec role ARN
<a name="output_task_exec_role_id"></a> task_exec_role_id	ECS Task exec role id
<a name="output_task_exec_role_name"></a> task_exec_role_name	ECS Task role name
<a name="output_task_role_arn"></a> task_role_arn	ECS Task role ARN
<a name="output_task_role_id"></a> task_role_id	ECS Task role id
<a name="output_task_role_name"></a> task_role_name	ECS Task role name

Related Projects

Check out these related projects.

terraform-aws-alb - Terraform module to provision a standard ALB for HTTP/HTTP traffic
terraform-aws-alb-ingress - Terraform module to provision an HTTP style ingress rule based on hostname and path for an ALB
terraform-aws-codebuild - Terraform Module to easily leverage AWS CodeBuild for Continuous Integration
terraform-aws-ecr - Terraform Module to manage Docker Container Registries on AWS ECR
terraform-aws-ecs-web-app - Terraform module that implements a web app on ECS and supporting AWS resources
terraform-aws-ecs-codepipeline - Terraform Module for CI/CD with AWS Code Pipeline and Code Build for ECS
terraform-aws-ecs-cloudwatch-sns-alarms - Terraform module to create CloudWatch Alarms on ECS Service level metrics
terraform-aws-ecs-container-definition - Terraform module to generate well-formed JSON documents that are passed to the aws_ecs_task_definition Terraform resource
terraform-aws-lb-s3-bucket - Terraform module to provision an S3 bucket with built in IAM policy to allow AWS Load Balancers to ship access logs.

[!TIP]

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it together with your team. ✅ Your team owns everything. ✅ 100% Open Source and backed by fanatical support. 

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ecs-alb-service-task&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
<details><summary>📚 Learn More</summary> 
Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.

Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.

Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.

Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.

GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ecs-alb-service-task&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.

Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.

Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.

Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.

Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.

Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.

Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ecs-alb-service-task&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>
</details>

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ecs-alb-service-task&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

<details> <summary>Preamble to the Apache License, Version 2.0</summary>

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

</details>

Trademarks

All other trademarks referenced herein are the property of their respective owners.