crawler

This component provisions Glue crawlers.

Usage

Stack Level: Regional

components:
  terraform:
    # The crawler crawls the data in an S3 bucket and puts the results into a table in the Glue Catalog.
    # The crawler will read the first 2 MB of data from the file, and recognize the schema.
    # After that, the crawler will sync the table.
    glue/crawler/example:
      metadata:
        component: glue/crawler
      vars:
        enabled: true
        name: example
        crawler_description: "Glue crawler example"
        glue_iam_component_name: "glue/iam"
        glue_catalog_database_component_name: "glue/catalog-database/example"
        glue_catalog_table_component_name: "glue/catalog-table/example"
        schedule: "cron(0 1 * * ? *)"
        schema_change_policy:
          delete_behavior: LOG
          update_behavior: null

Variables

Required Variables

glue_catalog_database_component_name (string) required: Glue catalog database component name where metadata resides. Used to get the Glue catalog database from the remote state
region (string) required: AWS Region

Optional Variables

catalog_target optional

List of nested Glue catalog target arguments

Type:

list(object({
database_name = string
tables        = list(string)
}))

Default value: null

classifiers (list(string)) optional

List of custom classifiers. By default, all AWS classifiers are included in a crawl, but these custom classifiers always override the default classifiers for a given classification

Default value: null

configuration (string) optional

JSON string of configuration information

Default value: null

crawler_description (string) optional

Glue crawler description

Default value: null

crawler_name (string) optional

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

Default value: null

delta_target optional

List of nested Delta target arguments

Type:

list(object({
connection_name = string
delta_tables    = list(string)
write_manifest  = bool
}))

Default value: null

dynamodb_target (list(any)) optional

List of nested DynamoDB target arguments

Default value: null

glue_catalog_table_component_name (string) optional

Glue catalog table component name where metadata resides. Used to get the Glue catalog table from the remote state

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"

jdbc_target (list(any)) optional

List of nested JBDC target arguments

Default value: null

lineage_configuration optional

Specifies data lineage configuration settings for the crawler

Type:

object({
crawler_lineage_settings = string
})

Default value: null

mongodb_target (list(any)) optional

List of nested MongoDB target arguments

Default value: null

recrawl_policy optional

A policy that specifies whether to crawl the entire dataset again, or to crawl only folders that were added since the last crawler run

Type:

object({
recrawl_behavior = string
})

Default value: null

s3_target (list(any)) optional

List of nested Amazon S3 target arguments

Default value: null

schedule (string) optional

A cron expression for the schedule

Default value: null

schema_change_policy (map(string)) optional

Policy for the crawler's update and deletion behavior

Default value: null

security_configuration (string) optional

The name of Security Configuration to be used by the crawler

Default value: null

table_prefix (string) optional

The table prefix used for catalog tables that are created

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

crawler_arn: Crawler ARN
crawler_id: Crawler ID
crawler_name: Crawler name

Dependencies

Requirements

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

Modules

Name	Version	Source	Description
`glue_catalog_database`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`glue_catalog_table`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`glue_crawler`	0.4.0	`cloudposse/glue/aws//modules/glue-crawler`	n/a
`glue_iam_role`	1.5.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

References

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

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Modules​

References​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Modules

References