terraform-aws-ecs-traefik

Terraform module which creates a traefik ecs task

Requirements

Name	Version
terraform	>= 1.3.0
aws	>= 4.67

Providers

Name	Version
aws	>= 4.67
aws.owner	>= 4.67

Modules

Name	Source	Version
container_definition	cloudposse/ecs-container-definition/aws	0.61.1
ecs_label	justtrackio/label/null	0.26.0
iam_label	justtrackio/label/null	0.26.0
nlb	terraform-aws-modules/alb/aws	9.8.0
service_task	justtrackio/ecs-alb-service-task/aws	1.3.0
this	justtrackio/label/null	0.26.0

Resources

Name	Type
aws_cloudwatch_log_group.default	resource
aws_iam_policy.default	resource
aws_iam_role_policy_attachment.task	resource
aws_iam_role_policy_attachment.task_exec	resource
aws_route53_record.default	resource
aws_route53_vpc_association_authorization.additional	resource
aws_route53_vpc_association_authorization.default	resource
aws_route53_zone.default	resource
aws_route53_zone_association.additional	resource
aws_route53_zone_association.default	resource
aws_iam_policy_document.default	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
additional_vpc_id	Additional vpc ids that should get associated with the route53 hosted-zone	list(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
aws_account_id	AWS account id	string	null	no
aws_region	AWS region	string	null	no
cloudwatch_log_group_enabled	A boolean to disable cloudwatch log group creation	bool	true	no
container_cpu	The number of cpu units to reserve for the container. This is optional for tasks using Fargate launch type and the total amount of container_cpu of all containers in a task will need to be lower than the task-level cpu value	number	512	no
container_image_tag	The image tag used to start the container. Images in the Docker Hub registry available by default	string	"v2.11.0"	no
container_image_url	The image tag used to start the container. Images in the Docker Hub registry available by default	string	"traefik"	no
container_memory	The amount of memory (in MiB) to allow the container to use. This is a hard limit, if the container attempts to exceed the container_memory, the container is killed. This field is optional for Fargate launch type and the total amount of container_memory of all containers in a task will need to be lower than the task memory value	number	256	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
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
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	150	no
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	50	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
desired_count	The number of instances of the task definition to place and keep running	number	3	no
dns_record_client_routing_policy	Indicates how traffic is distributed among the load balancer Availability Zones. Possible values are any_availability_zone, availability_zone_affinity (default), or partial_availability_zone_affinity. Only valid for network type load balancers.	string	"availability_zone_affinity"	no
domain	Domain for the hosted-zone	string	n/a	yes
ecs_cluster_arn	The ECS Cluster ARN where ECS Service will be provisioned	string	n/a	yes
ecs_service_role_enabled	Whether or not to create the ecs service aws_iam_role resource	bool	false	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
https_listeners_certificate_arn	ARN of the default SSL server certificate. Exactly one certificate is required if the protocol is HTTPS	string	null	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
ignore_changes_task_definition	Ignore changes (like environment variables) to the ECS task definition	bool	false	no
initial_vpc_id	VPC id to be used when creating the aws_route53_zone resource	string	n/a	yes
internal	Boolean determining if the load balancer is internal or externally facing.	bool	true	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_orders	Overrides the labels_order for the different labels to modify ID elements appear in the id	object({ cloudwatch = optional(list(string)), ecs = optional(list(string)), iam = optional(list(string)), ssm = optional(list(string)), vpc = optional(list(string)) })	{}	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
launch_type	The ECS launch type (valid options: FARGATE or EC2)	string	"EC2"	no
load_balancer_type	The type of load balancer to create. Possible values are application or network.	string	"network"	no
log_retention_in_days	The number of days to retain logs for the log group	number	1	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
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	null	no
organizational_unit	Usually used to indicate the AWS organizational unit, e.g. 'prod', 'sdlc'	string	null	no
port_gateway	Define the gateway port	number	8088	no
port_health	Define the health port	number	8090	no
port_metadata	Define the metadata port	number	8070	no
port_metrics	Define the prometheus metrics port	number	9100	no
prometheus_metrics_enabled	A boolean to enable/disable traefik prometheus metrics. Default is true	bool	true	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
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
subnets	A list of subnets to associate with the load balancer. e.g. ['subnet-1a2b3c4d','subnet-1a2b3c4e','subnet-1a2b3c4f']	list(string)	n/a	yes
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
task_cpu	The number of CPU units used by the task. If using FARGATE launch type task_cpu must match supported memory values	number	1024	no
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
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
vpc_id	VPC id where the load balancer and other resources will be deployed.	string	n/a	yes
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	true	no

Outputs

Name	Description
lb_dns_name	The DNS name of the load balancer
lb_zone_id	The zone_id of the load balancer to assist with creating DNS records