Awesome

This component is responsible for provisioning an ECS Cluster and associated load balancer.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component.

The following will create

ecs cluster
load balancer with an ACM cert placed on example.com
r53 record on all *.example.com which will point to the load balancer

components:
  terraform:
    ecs:
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        name: ecs
        enabled: true
        acm_certificate_domain: example.com
        route53_record_name: "*"
        # Create records will be created in each zone
        zone_names:
          - example.com
        capacity_providers_fargate: true
        capacity_providers_fargate_spot: true
        capacity_providers_ec2:
          default:
            instance_type: t3.medium
            max_size: 2

        alb_configuration:
          public:
            internal_enabled: false
            # resolves to *.public-platform.<environment>.<stage>.<tenant>.<domain>.<tld>
            route53_record_name: "*.public-platform"
            additional_certs:
              - "my-vanity-domain.com"
          private:
            internal_enabled: true
            route53_record_name: "*.private-platform"
            additional_certs:
              - "my-vanity-domain.com"

Requirements

Name	Version
<a name="requirement_terraform"></a> terraform	>= 1.3.0
<a name="requirement_aws"></a> aws	>= 4.0

Providers

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

Modules

Name	Source	Version
<a name="module_alb"></a> alb	cloudposse/alb/aws	1.11.1
<a name="module_cluster"></a> cluster	cloudposse/ecs-cluster/aws	0.4.1
<a name="module_dns_delegated"></a> dns_delegated	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
<a name="module_iam_roles"></a> iam_roles	../account-map/modules/iam-roles	n/a
<a name="module_target_group_label"></a> target_group_label	cloudposse/label/null	0.25.0
<a name="module_this"></a> this	cloudposse/label/null	0.25.0
<a name="module_vpc"></a> vpc	cloudposse/stack-config/yaml//modules/remote-state	1.5.0

Resources

Name	Type
aws_lb_listener_certificate.additional_certs	resource
aws_route53_record.default	resource
aws_security_group.default	resource
aws_security_group_rule.egress	resource
aws_security_group_rule.ingress_cidr	resource
aws_security_group_rule.ingress_security_groups	resource
aws_acm_certificate.additional_certs	data source
aws_acm_certificate.default	data source

Inputs

Name	Description	Type	Default	Required
<a name="input_acm_certificate_domain"></a> acm_certificate_domain	Domain to get the ACM cert to use on the ALB.	`string`	`null`	no
<a name="input_acm_certificate_domain_suffix"></a> acm_certificate_domain_suffix	Domain suffix to use with dns delegated HZ to get the ACM cert to use on the ALB	`string`	`null`	no
<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_configuration"></a> alb_configuration	Map of multiple ALB configurations.	`map(any)`	`{}`	no
<a name="input_alb_ingress_cidr_blocks_http"></a> alb_ingress_cidr_blocks_http	List of CIDR blocks allowed to access environment over HTTP	`list(string)`	<pre>[<br/> "0.0.0.0/0"<br/>]</pre>	no
<a name="input_alb_ingress_cidr_blocks_https"></a> alb_ingress_cidr_blocks_https	List of CIDR blocks allowed to access environment over HTTPS	`list(string)`	<pre>[<br/> "0.0.0.0/0"<br/>]</pre>	no
<a name="input_allowed_cidr_blocks"></a> allowed_cidr_blocks	List of CIDR blocks to be allowed to connect to the ECS cluster	`list(string)`	`[]`	no
<a name="input_allowed_security_groups"></a> allowed_security_groups	List of Security Group IDs to be allowed to connect to the ECS cluster	`list(string)`	`[]`	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_capacity_providers_ec2"></a> capacity_providers_ec2	EC2 autoscale groups capacity providers	<pre>map(object({<br/> instance_type = string<br/> max_size = number<br/> security_group_ids = optional(list(string), [])<br/> min_size = optional(number, 0)<br/> image_id = optional(string)<br/> instance_initiated_shutdown_behavior = optional(string, "terminate")<br/> key_name = optional(string, "")<br/> user_data = optional(string, "")<br/> enable_monitoring = optional(bool, true)<br/> instance_warmup_period = optional(number, 300)<br/> maximum_scaling_step_size = optional(number, 1)<br/> minimum_scaling_step_size = optional(number, 1)<br/> target_capacity_utilization = optional(number, 100)<br/> ebs_optimized = optional(bool, false)<br/> block_device_mappings = optional(list(object({<br/> device_name = string<br/> no_device = bool<br/> virtual_name = string<br/> ebs = object({<br/> delete_on_termination = bool<br/> encrypted = bool<br/> iops = number<br/> kms_key_id = string<br/> snapshot_id = string<br/> volume_size = number<br/> volume_type = string<br/> })<br/> })), [])<br/> instance_market_options = optional(object({<br/> market_type = string<br/> spot_options = object({<br/> block_duration_minutes = number<br/> instance_interruption_behavior = string<br/> max_price = number<br/> spot_instance_type = string<br/> valid_until = string<br/> })<br/> }))<br/> instance_refresh = optional(object({<br/> strategy = string<br/> preferences = optional(object({<br/> instance_warmup = optional(number, null)<br/> min_healthy_percentage = optional(number, null)<br/> skip_matching = optional(bool, null)<br/> auto_rollback = optional(bool, null)<br/> }), null)<br/> triggers = optional(list(string), [])<br/> }))<br/> mixed_instances_policy = optional(object({<br/> instances_distribution = object({<br/> on_demand_allocation_strategy = string<br/> on_demand_base_capacity = number<br/> on_demand_percentage_above_base_capacity = number<br/> spot_allocation_strategy = string<br/> spot_instance_pools = number<br/> spot_max_price = string<br/> })<br/> }), {<br/> instances_distribution = null<br/> })<br/> placement = optional(object({<br/> affinity = string<br/> availability_zone = string<br/> group_name = string<br/> host_id = string<br/> tenancy = string<br/> }))<br/> credit_specification = optional(object({<br/> cpu_credits = string<br/> }))<br/> elastic_gpu_specifications = optional(object({<br/> type = string<br/> }))<br/> disable_api_termination = optional(bool, false)<br/> default_cooldown = optional(number, 300)<br/> health_check_grace_period = optional(number, 300)<br/> force_delete = optional(bool, false)<br/> termination_policies = optional(list(string), ["Default"])<br/> suspended_processes = optional(list(string), [])<br/> placement_group = optional(string, "")<br/> metrics_granularity = optional(string, "1Minute")<br/> enabled_metrics = optional(list(string), [<br/> "GroupMinSize",<br/> "GroupMaxSize",<br/> "GroupDesiredCapacity",<br/> "GroupInServiceInstances",<br/> "GroupPendingInstances",<br/> "GroupStandbyInstances",<br/> "GroupTerminatingInstances",<br/> "GroupTotalInstances",<br/> "GroupInServiceCapacity",<br/> "GroupPendingCapacity",<br/> "GroupStandbyCapacity",<br/> "GroupTerminatingCapacity",<br/> "GroupTotalCapacity",<br/> "WarmPoolDesiredCapacity",<br/> "WarmPoolWarmedCapacity",<br/> "WarmPoolPendingCapacity",<br/> "WarmPoolTerminatingCapacity",<br/> "WarmPoolTotalCapacity",<br/> "GroupAndWarmPoolDesiredCapacity",<br/> "GroupAndWarmPoolTotalCapacity",<br/> ])<br/> wait_for_capacity_timeout = optional(string, "10m")<br/> service_linked_role_arn = optional(string, "")<br/> metadata_http_endpoint_enabled = optional(bool, true)<br/> metadata_http_put_response_hop_limit = optional(number, 2)<br/> metadata_http_tokens_required = optional(bool, true)<br/> metadata_http_protocol_ipv6_enabled = optional(bool, false)<br/> tag_specifications_resource_types = optional(set(string), ["instance", "volume"])<br/> max_instance_lifetime = optional(number, null)<br/> capacity_rebalance = optional(bool, false)<br/> warm_pool = optional(object({<br/> pool_state = string<br/> min_size = number<br/> max_group_prepared_capacity = number<br/> }))<br/> }))</pre>	`{}`	no
<a name="input_capacity_providers_fargate"></a> capacity_providers_fargate	Use FARGATE capacity provider	`bool`	`true`	no
<a name="input_capacity_providers_fargate_spot"></a> capacity_providers_fargate_spot	Use FARGATE_SPOT capacity provider	`bool`	`false`	no
<a name="input_container_insights_enabled"></a> container_insights_enabled	Whether or not to enable container insights	`bool`	`true`	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_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_dns_delegated_component_name"></a> dns_delegated_component_name	Use this component name to read from the remote state to get the dns_delegated zone ID	`string`	`"dns-delegated"`	no
<a name="input_dns_delegated_environment_name"></a> dns_delegated_environment_name	Use this environment name to read from the remote state to get the dns_delegated zone ID	`string`	`"gbl"`	no
<a name="input_dns_delegated_stage_name"></a> dns_delegated_stage_name	Use this stage name to read from the remote state to get the dns_delegated zone ID	`string`	`null`	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_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_internal_enabled"></a> internal_enabled	Whether to create an internal load balancer for services in this cluster	`bool`	`false`	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_maintenance_page_path"></a> maintenance_page_path	The path from this directory to the text/html page to use as the maintenance page. Must be within 1024 characters	`string`	`"templates/503_example.html"`	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_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_region"></a> region	AWS Region	`string`	n/a	yes
<a name="input_route53_enabled"></a> route53_enabled	Whether or not to create a route53 record for the ALB	`bool`	`true`	no
<a name="input_route53_record_name"></a> route53_record_name	The route53 record name	`string`	`"*"`	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_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_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

Outputs

Name	Description
<a name="output_alb"></a> alb	ALB outputs
<a name="output_cluster_arn"></a> cluster_arn	ECS cluster ARN
<a name="output_cluster_name"></a> cluster_name	ECS Cluster Name
<a name="output_private_subnet_ids"></a> private_subnet_ids	Private subnet ids
<a name="output_public_subnet_ids"></a> public_subnet_ids	Public subnet ids
<a name="output_records"></a> records	Record names
<a name="output_security_group_id"></a> security_group_id	Security group id
<a name="output_vpc_id"></a> vpc_id	VPC ID

References

cloudposse/terraform-aws-components - Cloud Posse's upstream component

[!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>

Related Projects

Check out these related projects.

Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
Atmos - Atmos is like docker-compose but for your infrastructure

[!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-components/aws-ecs&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-components/aws-ecs&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-components/aws-ecs&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-components/aws-ecs&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>

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.