Skip to main content

Component: ecs

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


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
  • r53 record on all * which will point to the load balancer
workspace_enabled: true
name: ecs
enabled: true
route53_record_name: "*"
# Create records will be created in each zone
capacity_providers_fargate: true
capacity_providers_fargate_spot: true
instance_type: t3.medium
max_size: 2


terraform>= 1.0.0
aws>= 4.0


aws>= 4.0




aws_acm_certificate.defaultdata source


acm_certificate_domainDomain to get the ACM cert to use on the ALB.stringnullno
acm_certificate_domain_suffixDomain suffix to use with dns delegated HZ to get the ACM cert to use on the ALBstringnullno
additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
alb_configurationMap of multiple ALB{}no
alb_ingress_cidr_blocks_httpList of CIDR blocks allowed to access environment over HTTPlist(string)
alb_ingress_cidr_blocks_httpsList of CIDR blocks allowed to access environment over HTTPSlist(string)
allowed_cidr_blocksList of CIDR blocks to be allowed to connect to the EKS clusterlist(string)[]no
allowed_security_groupsList of Security Group IDs to be allowed to connect to the EKS clusterlist(string)[]no
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
capacity_providers_ec2EC2 autoscale groups capacity providers
instance_type = string
max_size = number
security_group_ids = optional(list(string), [])
min_size = optional(number, 0)
image_id = optional(string)
instance_initiated_shutdown_behavior = optional(string, "terminate")
key_name = optional(string, "")
user_data = optional(string, "")
enable_monitoring = optional(bool, true)
instance_warmup_period = optional(number, 300)
maximum_scaling_step_size = optional(number, 1)
minimum_scaling_step_size = optional(number, 1)
target_capacity_utilization = optional(number, 100)
ebs_optimized = optional(bool, false)
block_device_mappings = optional(list(object({
device_name = string
no_device = bool
virtual_name = string
ebs = object({
delete_on_termination = bool
encrypted = bool
iops = number
kms_key_id = string
snapshot_id = string
volume_size = number
volume_type = string
})), [])
instance_market_options = optional(object({
market_type = string
spot_options = object({
block_duration_minutes = number
instance_interruption_behavior = string
max_price = number
spot_instance_type = string
valid_until = string
instance_refresh = optional(object({
strategy = string
preferences = object({
instance_warmup = number
min_healthy_percentage = number
triggers = list(string)
mixed_instances_policy = optional(object({
instances_distribution = object({
on_demand_allocation_strategy = string
on_demand_base_capacity = number
on_demand_percentage_above_base_capacity = number
spot_allocation_strategy = string
spot_instance_pools = number
spot_max_price = string
}), {
instances_distribution = null
placement = optional(object({
affinity = string
availability_zone = string
group_name = string
host_id = string
tenancy = string
credit_specification = optional(object({
cpu_credits = string
elastic_gpu_specifications = optional(object({
type = string
disable_api_termination = optional(bool, false)
default_cooldown = optional(number, 300)
health_check_grace_period = optional(number, 300)
force_delete = optional(bool, false)
termination_policies = optional(list(string), ["Default"])
suspended_processes = optional(list(string), [])
placement_group = optional(string, "")
metrics_granularity = optional(string, "1Minute")
enabled_metrics = optional(list(string), [
wait_for_capacity_timeout = optional(string, "10m")
service_linked_role_arn = optional(string, "")
metadata_http_endpoint_enabled = optional(bool, true)
metadata_http_put_response_hop_limit = optional(number, 2)
metadata_http_tokens_required = optional(bool, true)
metadata_http_protocol_ipv6_enabled = optional(bool, false)
tag_specifications_resource_types = optional(set(string), ["instance", "volume"])
max_instance_lifetime = optional(number, null)
capacity_rebalance = optional(bool, false)
warm_pool = optional(object({
pool_state = string
min_size = number
max_group_prepared_capacity = number
capacity_providers_fargateUse FARGATE capacity providerbooltrueno
capacity_providers_fargate_spotUse FARGATE_SPOT capacity providerboolfalseno
container_insights_enabledWhether or not to enable container insightsbooltrueno
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
default_capacity_strategyThe capacity provider strategy to use by default for the cluster
base = object({
provider = string
value = number
weights = map(number)
"base": {
"provider": "FARGATE",
"value": 1
"weights": {}
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
dns_delegated_component_nameUse this component name to read from the remote state to get the dns_delegated zone IDstring"dns-delegated"no
dns_delegated_environment_nameUse this environment name to read from the remote state to get the dns_delegated zone IDstring"gbl"no
dns_delegated_stage_nameUse this stage name to read from the remote state to get the dns_delegated zone IDstringnullno
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
internal_enabledWhether to create an internal load balancer for services in this clusterboolfalseno
kms_key_idThe AWS Key Management Service key ID to encrypt the data between the local client and the container.stringnullno
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
log_configurationThe log configuration for the results of the execute command actions Required when logging is OVERRIDE
cloud_watch_encryption_enabled = string
cloud_watch_log_group_name = string
s3_bucket_name = string
s3_key_prefix = string
loggingThe AWS Key Management Service key ID to encrypt the data between the local client and the container. (Valid values: 'NONE', 'DEFAULT', 'OVERRIDE')string"DEFAULT"no
maintenance_page_pathThe path from this directory to the text/html page to use as the maintenance page. Must be within 1024 charactersstring"templates/503_example.html"no
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
regionAWS Regionstringn/ayes
route53_enabledWhether or not to create a route53 record for the ALBbooltrueno
route53_record_nameThe route53 record namestring"*"no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


albALB outputs
cluster_arnECS cluster ARN
cluster_nameECS Cluster Name
private_subnet_idsPrivate subnet ids
public_subnet_idsPublic subnet ids
recordsRecord names
security_group_idSecurity group id
vpc_idVPC ID