Component: glue/job

This component provisions Glue jobs.

Usage

Stack Level: Regional

components:
  terraform:
    glue/job/example:
      metadata:
        component: glue/job
      vars:
        enabled: true
        name: example
        job_description: Glue job example
        glue_version: "2.0"
        worker_type: Standard
        number_of_workers: 2
        max_retries: 2
        timeout: 20
        glue_iam_component_name: "glue/iam"
        glue_job_s3_bucket_component_name: "s3/datalake"
        glue_job_s3_bucket_script_path: "glue/glue_job.py"
        glue_job_command_name: glueetl
        glue_job_command_python_version: 3

Requirements

Name	Version
terraform	>= 1.3.0
aws	>= 4.0
utils	>= 1.15.0

Providers

Name	Version
aws	>= 4.0

Modules

Name	Source	Version
glue_iam_role	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
glue_job	cloudposse/glue/aws//modules/glue-job	0.4.0
glue_job_s3_bucket	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
iam_roles	../../account-map/modules/iam-roles	n/a
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_iam_policy.glue_job_aws_tools_access	resource
aws_iam_role_policy_attachment.glue_jobs_aws_tools_access	resource
aws_iam_role_policy_attachment.glue_redshift_access	resource
aws_iam_policy_document.glue_job_aws_tools_access	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
command	The command of the job	map(any)	null	no
connections	The list of connections used for this job	list(string)	null	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_arguments	The map of default arguments for the job. You can specify arguments here that your own job-execution script consumes, as well as arguments that AWS Glue itself consumes	map(string)	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
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
execution_property	Execution property of the job	object({ # The maximum number of concurrent runs allowed for the job. The default is 1. max_concurrent_runs = number })	null	no
glue_iam_component_name	Glue IAM component name. Used to get the Glue IAM role from the remote state	string	"glue/iam"	no
glue_job_command_name	The name of the job command. Defaults to glueetl. Use pythonshell for Python Shell Job Type, or gluestreaming for Streaming Job Type. max_capacity needs to be set if pythonshell is chosen	string	"glueetl"	no
glue_job_command_python_version	The Python version being used to execute a Python shell job. Allowed values are 2, 3 or 3.9. Version 3 refers to Python 3.6	number	3	no
glue_job_s3_bucket_component_name	Glue job S3 bucket component name. Used to get the remote state of the S3 bucket where the Glue job script is located	string	null	no
glue_job_s3_bucket_script_path	Glue job script path in the S3 bucket	string	null	no
glue_version	The version of Glue to use	string	"2.0"	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
job_description	Glue job description	string	null	no
job_name	Glue job name. If not provided, the name will be generated from the context	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
max_capacity	The maximum number of AWS Glue data processing units (DPUs) that can be allocated when the job runs. Required when pythonshell is set, accept either 0.0625 or 1.0. Use number_of_workers and worker_type arguments instead with glue_version 2.0 and above	number	null	no
max_retries	The maximum number of times to retry the job if it fails	number	null	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
non_overridable_arguments	Non-overridable arguments for this job, specified as name-value pairs	map(string)	null	no
notification_property	Notification property of the job	object({ # After a job run starts, the number of minutes to wait before sending a job run delay notification notify_delay_after = number })	null	no
number_of_workers	The number of workers of a defined worker_type that are allocated when a job runs	number	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
region	AWS Region	string	n/a	yes
security_configuration	The name of the Security Configuration to be associated with the job	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
timeout	The job timeout in minutes. The default is 2880 minutes (48 hours) for glueetl and pythonshell jobs, and null (unlimted) for gluestreaming jobs	number	2880	no
worker_type	The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X	string	null	no

Outputs

Name	Description
job_arn	Glue job ARN
job_id	Glue job ID
job_name	Glue job name

References

• cloudposse/terraform-aws-components - Cloud Posse's upstream component