Component: `snowflake-database`

All data in Snowflake is stored in database tables, logically structured as collections of columns and rows. This component will create and control a Snowflake database, schema, and set of tables.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component:

components:
  terraform:
    snowflake-database:
      vars:
        enabled: true
        tags:
          Team: data
          Service: snowflake
        tables:
          example:
            comment: "An example table"
            columns:
              - name: "data"
                type: "text"
              - name: "DATE"
                type: "TIMESTAMP_NTZ(9)"
              - name: "extra"
                type: "VARIANT"
                comment: "extra data"
            primary_key:
              name: "pk"
              keys:
                - "data"
        views:
          select-example:
            comment: "An example view"
            statement: |
              select * from "example";

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 3.0
snowflake	>= 0.25

Providers

Name	Version
aws	>= 3.0
snowflake	>= 0.25

Modules

Name	Source	Version
iam_roles	../account-map/modules/iam-roles	n/a
introspection	cloudposse/label/null	0.25.0
snowflake_account	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
snowflake_database	cloudposse/label/null	0.25.0
snowflake_label	cloudposse/label/null	0.25.0
snowflake_schema	cloudposse/label/null	0.25.0
snowflake_sequence	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0
utils	cloudposse/utils/aws	0.8.1

Resources

Name	Type
snowflake_database.this	resource
snowflake_database_grant.grant	resource
snowflake_schema.this	resource
snowflake_schema_grant.grant	resource
snowflake_sequence.this	resource
snowflake_table.tables	resource
snowflake_table_grant.grant	resource
snowflake_view.view	resource
snowflake_view_grant.grant	resource
aws_ssm_parameter.snowflake_private_key	data source
aws_ssm_parameter.snowflake_username	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
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
data_retention_time_in_days	Time in days to retain data in Snowflake databases, schemas, and tables by default.	`string`	`1`	no
database_comment	The comment to give to the provisioned database.	`string`	`"A database created for managing programmatically created Snowflake schemas and tables."`	no
database_grants	A list of Grants to give to the database created with component.	`list(string)`	`[ "MODIFY", "MONITOR", "USAGE" ]`	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
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
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
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
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
required_tags	List of required tag names	`list(string)`	`[]`	no
schema_grants	A list of Grants to give to the schema created with component.	`list(string)`	`[ "MODIFY", "MONITOR", "USAGE", "CREATE TABLE", "CREATE VIEW" ]`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
table_grants	A list of Grants to give to the tables created with component.	`list(string)`	`[ "SELECT", "INSERT", "UPDATE", "DELETE", "TRUNCATE", "REFERENCES" ]`	no
tables	A map of tables to create for Snowflake. A schema and database will be assigned for this group of tables.	`map(any)`	`{}`	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
view_grants	A list of Grants to give to the views created with component.	`list(string)`	`[ "SELECT", "REFERENCES" ]`	no
views	A map of views to create for Snowflake. The same schema and database will be assigned as for tables.	`map(any)`	`{}`	no

Outputs

No outputs.

References

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

Component: snowflake-database

Usage​

Requirements​

Providers​

Modules​

Resources​

Inputs​

Outputs​

References​