terraform-aws-ecs-scheduled-task

Terraform module which creates a scheduled ecs task

Requirements

Name	Version
terraform	>= 1.3.0
aws	>= 4.67

Providers

Name	Version
aws	>= 4.67

Modules

Name	Source	Version
cloudwatch_label	cloudposse/label/null	0.25.0
exec_label	cloudposse/label/null	0.25.0
task_label	cloudposse/label/null	0.25.0
this	justtrackio/label/null	0.26.0

Resources

Name	Type
aws_cloudwatch_event_rule.default	resource
aws_cloudwatch_event_target.default	resource
aws_ecs_task_definition.default	resource
aws_iam_role.cloudwatch_event	resource
aws_iam_role.ecs_exec	resource
aws_iam_role.ecs_task	resource
aws_iam_role_policy.cloudwatch_event	resource
aws_iam_role_policy.ecs_exec	resource
aws_iam_role_policy.ecs_ssm_exec	resource
aws_iam_role_policy_attachment.cloudwatch_event	resource
aws_iam_role_policy_attachment.ecs_exec	resource
aws_iam_role_policy_attachment.ecs_task	resource
aws_iam_policy_document.cloudwatch_event	data source
aws_iam_policy_document.ecs_exec	data source
aws_iam_policy_document.ecs_ssm_exec	data source
aws_iam_policy_document.ecs_task	data source
aws_iam_policy_document.ecs_task_exec	data source
aws_iam_policy_document.event	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
aws_account_id	AWS account id	string	null	no
aws_region	AWS region	string	null	no
cloudwatch_event_policy_arns	A list of IAM Policy ARNs to attach to the generated cloudwatch event role.	list(string)	[ "arn:aws:iam::aws:policy/service-role/AmazonEC2ContainerServiceEventsRole" ]	no
cloudwatch_event_role_arn	A list(string) of zero or one ARNs of IAM roles that allows your Amazon Cloudwatch event to make calls to the ECS API on your behalf. If the list is empty, a role will be created for you. DEPRECATED: you can also pass a string with the ARN, but that string must be known a "plan" time.	any	[]	no
container_definition_json	A string containing a JSON-encoded array of container definitions ("[{ "name": "container1", ... }, { "name": "container2", ... }]"). See API_ContainerDefinition, cloudposse/terraform-aws-ecs-container-definition, or ecs_task_definition#container_definitions	string	n/a	yes
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
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
docker_volumes	Task docker volume definitions as list of configuration objects. You can define multiple Docker volumes on the same task definition, but a single volume can only have one docker_volume_configuration.	list(object({ host_path = string name = string docker_volume_configuration = list(object({ autoprovision = bool driver = string driver_opts = map(string) labels = map(string) scope = string })) }))	[]	no
ecs_cluster_arn	The ARN of the ECS cluster where service will be provisioned	string	n/a	yes
efs_volumes	Task EFS volume definitions as list of configuration objects. You cannot define both Docker volumes and EFS volumes on the same task definition.	list(object({ host_path = string name = string efs_volume_configuration = list(object({ file_system_id = string root_directory = string transit_encryption = string transit_encryption_port = string authorization_config = list(object({ access_point_id = string iam = string })) })) }))	[]	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
ephemeral_storage_size	The number of GBs to provision for ephemeral storage on Fargate tasks. Must be greater than or equal to 21 and less than or equal to 200	number	0	no
exec_enabled	Specifies whether to enable Amazon ECS Exec for the tasks within the service	bool	false	no
fsx_volumes	Task FSx volume definitions as list of configuration objects. You can define multiple FSx volumes on the same task definition, but a single volume can only have one fsx_windows_file_server_volume_configuration.	list(object({ host_path = string name = string fsx_windows_file_server_volume_configuration = list(object({ file_system_id = string root_directory = string authorization_config = list(object({ credentials_parameter = string domain = string })) })) }))	[]	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
is_enabled	Whether the rule should be enabled.	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)), iam = 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 launch type on which to run your service. Valid values are EC2 and FARGATE	string	"EC2"	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
permissions_boundary	A permissions boundary ARN to apply to the 3 roles that are created.	string	""	no
proxy_configuration	The proxy configuration details for the App Mesh proxy. See proxy_configuration docs https://www.terraform.io/docs/providers/aws/r/ecs_task_definition.html#proxy-configuration-arguments	object({ type = string container_name = string properties = map(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
role_tags_enabled	Enable/disable tags on ECS roles	string	true	no
runtime_platform	Zero or one runtime platform configurations that containers in your task may use. Map of strings with optional keys operating_system_family and cpu_architecture. See runtime_platform docs https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecs_task_definition#runtime_platform	list(map(string))	[]	no
schedule_expression	The scheduling expression. For example, cron(0 20 * * ? *) or rate(5 minutes). At least one of schedule_expression or event_pattern is required. Can only be used on the default event bus.	string	""	no
security_groups	The security groups associated with the task or service. If you do not specify a security group, the default security group for the VPC is used.	list(string)	[]	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
subnet_ids	A list of subnet IDs to associate with the task or service	list(string)	[]	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
task_count	The number of tasks to create based on the TaskDefinition.	number	null	no
task_cpu	The number of CPU units used by the task. If using FARGATE launch type task_cpu must match supported memory values (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size)	number	null	no
task_exec_policy_arns	A list of IAM Policy ARNs to attach to the generated task execution role.	list(string)	[]	no
task_exec_role_arn	A list(string) of zero or one ARNs of IAM roles that allows the ECS/Fargate agent to make calls to the ECS API on your behalf. If the list is empty, a role will be created for you. DEPRECATED: you can also pass a string with the ARN, but that string must be known a "plan" time.	any	[]	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 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html#task_size)	number	null	no
task_placement_constraints	A set of placement constraints rules that are taken into consideration during task placement. Maximum number of placement_constraints is 10. See placement_constraints	list(object({ type = string expression = string }))	[]	no
task_policy_arns	A list of IAM Policy ARNs to attach to the generated task role.	list(string)	[]	no
task_role_arn	A list(string) of zero or one ARNs of IAM roles that allows your Amazon ECS container task to make calls to other AWS services. If the list is empty, a role will be created for you. DEPRECATED: you can also pass a string with the ARN, but that string must be known a "plan" time.	any	[]	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
use_old_arn	A flag to enable/disable tagging the ecs resources that require the new arn format	bool	false	no

Outputs

Name	Description
exec_role_arn	The ECS execution role ARN
exec_role_name	The ECS execution role name
exec_role_policy_id	The ECS execution role policy ID, in the form of role_name:role_policy_name
exec_role_policy_name	The ECS execution role policy name
exec_role_unique_id	The ECS execution role unique id
task_definition_arn	The ECS task definition ARN
task_definition_family	The ECS task definition family
task_definition_revision	The ECS task definition revision
task_role_arn	The ECS task role ARN
task_role_id	The ECS task role id
task_role_name	The ECS task role name
task_role_unique_id	The ECS task role unique id