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

Variables

Required Variables

region (string) required: AWS Region

Optional Variables

command (map(any)) optional

The command of the job

Default value: null

connections (list(string)) optional

The list of connections used for this job

Default value: null

default_arguments (map(string)) optional

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

Default value: null

execution_property optional

Execution property of the job

Type:

object({
# The maximum number of concurrent runs allowed for the job. The default is 1.
max_concurrent_runs = number
})

Default value: null

glue_iam_component_name (string) optional

Glue IAM component name. Used to get the Glue IAM role from the remote state

Default value: "glue/iam"

glue_job_command_name (string) optional

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

Default value: "glueetl"

glue_job_command_python_version (number) optional

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

Default value: 3

glue_job_s3_bucket_component_name (string) optional

Glue job S3 bucket component name. Used to get the remote state of the S3 bucket where the Glue job script is located

Default value: null

glue_job_s3_bucket_script_path (string) optional

Glue job script path in the S3 bucket

Default value: null

glue_version (string) optional

The version of Glue to use

Default value: "2.0"

job_description (string) optional

Glue job description

Default value: null

job_name (string) optional

Glue job name. If not provided, the name will be generated from the context

Default value: null

max_capacity (number) optional

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

Default value: null

max_retries (number) optional

The maximum number of times to retry the job if it fails

Default value: null

non_overridable_arguments (map(string)) optional

Non-overridable arguments for this job, specified as name-value pairs

Default value: null

notification_property optional

Notification property of the job

Type:

object({
# After a job run starts, the number of minutes to wait before sending a job run delay notification
notify_delay_after = number
})

Default value: null

number_of_workers (number) optional

The number of workers of a defined worker_type that are allocated when a job runs

Default value: null

security_configuration (string) optional

The name of the Security Configuration to be associated with the job

Default value: null

timeout (number) optional

The job timeout in minutes. The default is 2880 minutes (48 hours) for glueetl and pythonshell jobs, and null (unlimited) for gluestreaming jobs

Default value: 2880

worker_type (string) optional

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X

Default value: null

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

job_arn: Glue job ARN
job_id: Glue job ID
job_name: Glue job name

Dependencies

Requirements

terraform, version: >= 1.3.0
aws, version: >= 4.0, < 6.0.0
utils, version: >= 1.15.0

Providers

aws, version: >= 4.0, < 6.0.0

Modules

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

Resources

The following resources are used by this module:

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)

Data Sources

The following data sources are used by this module:

aws_iam_policy_document.glue_job_aws_tools_access (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