Snowflake Database Role Terraform Module

We help companies turn their data into assets

---

Terraform module for managing Snowflake Database roles.

• Creates Snowflake database role with specific privileges on database and schemas.
• Allows granting of privileges on future schemas in a database.
• Allows granting of privileges on all existing schemas in a database.
• Allows granting of privileges on specific schema objects like tables.
• Supports granting of all privileges or specific ones based on the configuration.
• Can be used to create a hierarchy of roles by assigning parent roles.
• Can be used to grant roles to other roles.

USAGE

resource "snowflake_database" "this" {
  name = "TEST_DB"
}

resource "snowflake_schema" "this" {
  database = snowflake_database.this.name
  name     = "BRONZE"
}

module "snowflake_database_role" {
  source = "../../"

  database_name = snowflake_database.this.name
  name          = "TEST_DB_ROLE"


  schema_grants = [
    {
      future_schemas_in_database = true
      all_schemas_in_database    = true
      all_privileges             = true
    },
  ]

  schema_objects_grants = {
    "TABLE" = [
      {
        all_privileges = true
        on_future      = true
        on_all         = true
        schema_name    = snowflake_schema.this.name
      }
    ]
  }
}

EXAMPLES

• Simple - Basic usage of the module
• Complete - Advanced usage of the module

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
comment	Database Role description	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
database_grants	Grants on a database level	object({ all_privileges = optional(bool) with_grant_option = optional(bool, false) privileges = optional(list(string), null) })	{}	no
database_name	The name of the database to create the role in	string	n/a	yes
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
descriptor_name	Name of the descriptor used to form a resource name	string	"snowflake-database-role"	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
granted_database_roles	Database Roles granted to this role	list(string)	[]	no
granted_to_database_roles	Fully qualified Parent Database Role name (DB_NAME.ROLE_NAME), to create parent-child relationship	list(string)	[]	no
granted_to_roles	List of Snowflake Account Roles to grant this role to	list(string)	[]	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
parent_database_role	DEPRECATED variable - please use granted_to_database_roles instead	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
schema_grants	Grants on a schema level	list(object({ all_privileges = optional(bool) with_grant_option = optional(bool, false) privileges = optional(list(string), null) all_schemas_in_database = optional(bool, false) future_schemas_in_database = optional(bool, false) schema_name = optional(string, null) }))	[]	no
schema_objects_grants	Grants on a schema object level Example usage: schema_objects_grants = { "TABLE" = [ { privileges = ["SELECT"] object_name = snowflake_table.table_1.name schema_name = snowflake_schema.this.name }, { all_privileges = true object_name = snowflake_table.table_2.name schema_name = snowflake_schema.this.name } ] "ALERT" = [ { all_privileges = true on_future = true on_all = true } ] } Note: If you don't provide a schema_name, the grants will be created for all objects of that type in the database. You can find a list of all object types here	map(list(object({ all_privileges = optional(bool) with_grant_option = optional(bool) privileges = optional(list(string)) object_name = optional(string) on_all = optional(bool, false) schema_name = optional(string) on_future = optional(bool, false) })))	{}	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

Modules

Name	Source	Version
role_label	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0

Outputs

Name	Description
fully_qualified_name	Name of the database role in fully qualified format ("DB_NAME"."ROLE_NAME")
name	Name of the database role

Providers

Name	Version
snowflake	>= 0.90

Requirements

Name	Version
terraform	>= 1.3
snowflake	>= 0.90

Resources

Name	Type
snowflake_database_role.this	resource
snowflake_grant_database_role.granted_database_roles	resource
snowflake_grant_database_role.granted_to_database_roles	resource
snowflake_grant_database_role.granted_to_role	resource
snowflake_grant_database_role.parent_database_role	resource
snowflake_grant_privileges_to_database_role.database_grants	resource
snowflake_grant_privileges_to_database_role.schema_grants	resource
snowflake_grant_privileges_to_database_role.schema_objects_grants	resource

CONTRIBUTING

Contributions are very welcomed!

Start by reviewing contribution guide and our code of conduct. After that, start coding and ship your changes by creating a new PR.

LICENSE

Apache 2 Licensed. See LICENSE for full details.

AUTHORS

Made with contrib.rocks.