Skip to main content

Component: glue/catalog-table

This component provisions Glue catalog tables.


Stack Level: Regional

component: glue/catalog-table
enabled: true
name: example
catalog_table_description: Glue catalog table example
glue_iam_component_name: glue/iam
glue_catalog_database_component_name: glue/catalog-database/example
lakeformation_permissions_enabled: true
- "ALL"
location: "s3://awsglue-datasets/examples/medicare/Medicare_Hospital_Provider.csv"


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


aws>= 4.0






additional_tag_mapAdditional 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.
attributesID 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.
catalog_idID of the Glue Catalog and database to create the table in. If omitted, this defaults to the AWS Account ID plus the database namestringnullno
catalog_table_descriptionDescription of the tablestringnullno
catalog_table_nameName of the tablestringnullno
contextSingle 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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe 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).
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
glue_catalog_database_component_nameGlue catalog database component name where the table metadata resides. Used to get the Glue catalog database from the remote statestringn/ayes
glue_iam_component_nameGlue IAM component name. Used to get the Glue IAM role from the remote statestring"glue/iam"no
id_length_limitLimit 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.
label_key_caseControls 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.
label_orderThe 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.
label_value_caseControls 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.
labels_as_tagsSet 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.
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.
lakeformation_permissionsList of permissions granted to the principal. Refer to for more detailslist(string)
lakeformation_permissions_enabledWhether to enable adding Lake Formation permissions to the IAM role that is used to access the Glue tablebooltrueno
nameID 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.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
ownerOwner of the tablestringnullno
parametersProperties associated with this table, as a map of key-value pairsmap(string)nullno
partition_indexConfiguration block for a maximum of 3 partition indexes
index_name = string
keys = list(string)
partition_keysConfiguration block of columns by which the table is partitioned. Only primitive types are supported as partition keysmap(string)nullno
regex_replace_charsTerraform 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.
regionAWS Regionstringn/ayes
retentionRetention time for the tablenumbernullno
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
storage_descriptorConfiguration block for information about the physical storage of this tableanynullno
table_typeType of this table (EXTERNAL_TABLE, VIRTUAL_VIEW, etc.). While optional, some Athena DDL queries such as ALTER TABLE and SHOW CREATE TABLE will fail if this argument is emptystringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
target_tableConfiguration block of a target table for resource linking
catalog_id = string
database_name = string
name = string
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
view_expanded_textIf the table is a view, the expanded text of the view; otherwise nullstringnullno
view_original_textIf the table is a view, the original text of the view; otherwise nullstringnullno


catalog_table_arnCatalog table ARN
catalog_table_idCatalog table ID
catalog_table_nameCatalog table name