Module: ecs-cluster

Terraform module to provision an ECS Cluster with list of capacity providers.

Supports Amazon ECS Fargate and EC2 Autoscaling capacity providers.

Usage

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

ECS cluster with Fargate capacity provider

module "ecs_cluster" {
  source = "cloudposse/ecs-cluster/aws"

  namespace = "eg"
  name      = "example"

  container_insights_enabled      = true
  capacity_providers_fargate      = true
}

ECS cluster with Fargate and EC2 autoscale capacity provider

# Create a standard label resource. See [null-label](https://github.com/cloudposse/terraform-null-label/#terraform-null-label--)
module "label" {
  source  = "cloudposse/label/null"
  # Cloud Posse recommends pinning every module to a specific version, though usually you want to use the current one
  # version = "x.x.x"

  namespace = "eg"
  name      = "example"
}

module "vpc" {
  source  = "cloudposse/vpc/aws"
  version = "1.2.0"

  context                 = module.label.context
  ipv4_primary_cidr_block = "172.16.0.0/16"
}

module "subnets" {
  source  = "cloudposse/dynamic-subnets/aws"
  version = "2.0.4"

  context              = module.label.context
  availability_zones   = var.availability_zones
  vpc_id               = module.vpc.vpc_id
  igw_id               = [module.vpc.igw_id]
  ipv4_cidr_block      = [module.vpc.vpc_cidr_block]
  nat_gateway_enabled  = false
  nat_instance_enabled = false
}

module "ecs_cluster" {
  source = "cloudposse/ecs-cluster/aws"

  context = module.label.context

  container_insights_enabled      = true
  capacity_providers_fargate      = true
  capacity_providers_fargate_spot = true
  capacity_providers_ec2 = {
    default = {
      instance_type               = "t3.medium"
      security_group_ids          = [module.vpc.vpc_default_security_group_id]
      subnet_ids                  = module.subnets.private_subnet_ids
      associate_public_ip_address = false
      min_size                    = 0
      max_size                    = 2
    }
  }
}

Requirements

Name	Version
terraform	>= 1.3
aws	>= 4.0

Providers

Name	Version
aws	>= 4.0

Modules

Name	Source	Version
autoscale_group	cloudposse/ec2-autoscale-group/aws	0.39.0
ecs_labels	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_ecs_capacity_provider.ec2	resource
aws_ecs_capacity_provider.external_ec2	resource
aws_ecs_cluster.default	resource
aws_ecs_cluster_capacity_providers.default	resource
aws_iam_instance_profile.default	resource
aws_iam_role.default	resource
aws_iam_role_policy_attachment.default	resource
aws_iam_policy_document.assume	data source
aws_partition.current	data source
aws_ssm_parameter.ami	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional 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.	map(string)	{}	no
attributes	ID 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.	list(string)	[]	no
capacity_providers_ec2	EC2 autoscale groups capacity providers	map(object({ instance_type = string max_size = number min_size = number subnet_ids = list(string) security_group_ids = list(string) image_id = optional(string, null) 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) associate_public_ip_address = 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 }) })) 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), [ "GroupMinSize", "GroupMaxSize", "GroupDesiredCapacity", "GroupInServiceInstances", "GroupPendingInstances", "GroupStandbyInstances", "GroupTerminatingInstances", "GroupTotalInstances", "GroupInServiceCapacity", "GroupPendingCapacity", "GroupStandbyCapacity", "GroupTerminatingCapacity", "GroupTotalCapacity", "WarmPoolDesiredCapacity", "WarmPoolWarmedCapacity", "WarmPoolPendingCapacity", "WarmPoolTerminatingCapacity", "WarmPoolTotalCapacity", "GroupAndWarmPoolDesiredCapacity", "GroupAndWarmPoolTotalCapacity", ]) 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) update_default_version = optional(bool, false) warm_pool = optional(object({ pool_state = string min_size = number max_group_prepared_capacity = number })) }))	{}	no
capacity_providers_fargate	Use FARGATE capacity provider	bool	true	no
capacity_providers_fargate_spot	Use FARGATE_SPOT capacity provider	bool	false	no
container_insights_enabled	Whether or not to enable container insights	bool	true	no
context	Single 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.	any	{ "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": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
default_capacity_strategy	The capacity provider strategy to use by default for the cluster	object({ base = object({ provider = string value = number }) weights = map(number) })	{ "base": { "provider": "FARGATE", "value": 1 }, "weights": {} }	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	Describe 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).	any	{}	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
external_ec2_capacity_providers	External EC2 autoscale groups capacity providers	map(object({ autoscaling_group_arn = string managed_termination_protection = bool managed_scaling_status = bool 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) }))	{}	no
id_length_limit	Limit 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.	number	null	no
kms_key_id	The AWS Key Management Service key ID to encrypt the data between the local client and the container.	string	null	no
label_key_case	Controls 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.	string	null	no
label_order	The 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.	list(string)	null	no
label_value_case	Controls 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.	string	null	no
labels_as_tags	Set 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. Notes: 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.	set(string)	[ "default" ]	no
log_configuration	The log configuration for the results of the execute command actions Required when logging is OVERRIDE	object({ cloud_watch_encryption_enabled = string cloud_watch_log_group_name = string s3_bucket_name = string s3_key_prefix = string })	null	no
logging	The 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
name	ID 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.	string	null	no
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
regex_replace_chars	Terraform 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.	string	null	no
service_discovery_namespace_arn	The Amazon Resource Name (ARN) of the service discovery namespace that you want to use for default service discovery.	string	null	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
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
arn	ECS cluster arn
id	ECS cluster id
name	ECS cluster name
role_name	IAM role name