Version: Latest

ecs

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"

Variables

Required Variables

region (string) required: AWS Region

Optional Variables

acm_certificate_domain (string) optional

Domain to get the ACM cert to use on the ALB.

Default value: null

acm_certificate_domain_suffix (string) optional

Domain suffix to use with dns delegated HZ to get the ACM cert to use on the ALB

Default value: null

alb_configuration (map(any)) optional

Map of multiple ALB configurations.

Default value: { }

alb_ingress_cidr_blocks_http (list(string)) optional

List of CIDR blocks allowed to access environment over HTTP

Default value:

[
  "0.0.0.0/0"
]

alb_ingress_cidr_blocks_https (list(string)) optional

List of CIDR blocks allowed to access environment over HTTPS

Default value:

[
  "0.0.0.0/0"
]

allowed_cidr_blocks (list(string)) optional

List of CIDR blocks to be allowed to connect to the ECS cluster

Default value: [ ]

allowed_security_groups (list(string)) optional

List of Security Group IDs to be allowed to connect to the ECS cluster

Default value: [ ]

capacity_providers_ec2 optional

EC2 autoscale groups capacity providers

Type:

map(object({
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
    throughput            = 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 = optional(object({
    instance_warmup              = optional(number, null)
    min_healthy_percentage       = optional(number, null)
    skip_matching                = optional(bool, null)
    auto_rollback                = optional(bool, null)
    scale_in_protected_instances = optional(string)
    standby_instances            = optional(string)
  }), null)
  triggers = optional(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), [
  "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)
warm_pool = optional(object({
  pool_state                  = string
  min_size                    = number
  max_group_prepared_capacity = number
}))
}))

Default value: { }

capacity_providers_fargate (bool) optional

Use FARGATE capacity provider

Default value: true

capacity_providers_fargate_spot (bool) optional

Use FARGATE_SPOT capacity provider

Default value: false

container_insights_enabled (bool) optional

Whether or not to enable container insights

Default value: true

dns_delegated_component_name (string) optional

Use this component name to read from the remote state to get the dns_delegated zone ID

Default value: "dns-delegated"

dns_delegated_environment_name (string) optional

Use this environment name to read from the remote state to get the dns_delegated zone ID

Default value: "gbl"

dns_delegated_stage_name (string) optional

Use this stage name to read from the remote state to get the dns_delegated zone ID

Default value: null

internal_enabled (bool) optional

Whether to create an internal load balancer for services in this cluster

Default value: false

maintenance_page_path (string) optional

The path from this directory to the text/html page to use as the maintenance page. Must be within 1024 characters

Default value: "templates/503_example.html"

route53_enabled (bool) optional

Whether or not to create a route53 record for the ALB

Default value: true

route53_record_name (string) optional

The route53 record name

Default value: "*"

vpc_component_name (string) optional

The name of a VPC component

Default value: "vpc"

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

alb: ALB outputs
cluster_arn: ECS cluster ARN
cluster_name: ECS Cluster Name
private_subnet_ids: Private subnet ids
public_subnet_ids: Public subnet ids
records: Record names
security_group_id: Security group id
vpc_id: VPC ID

Dependencies

Requirements

terraform, version: >= 1.3.0
aws, version: >=6.0.0

Providers

aws, version: >=6.0.0

Modules

Name	Version	Source	Description
`alb`	1.12.0	`cloudposse/alb/aws`	n/a
`cluster`	2.0.0	`cloudposse/ecs-cluster/aws`	n/a
`dns_delegated`	1.8.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`target_group_label`	0.25.0	`cloudposse/label/null`	This is used due to the short limit on target group names i.e. 32 characters
`this`	0.25.0	`cloudposse/label/null`	n/a
`vpc`	1.8.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a

Resources

The following resources are used by this module:

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)

Data Sources

The following data sources are used by this module:

aws_acm_certificate.additional_certs (data source)
aws_acm_certificate.default (data source)

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources