Terraform module for managing Snowflake roles. Additionally, this module allows creating multiple grants on different Snowflake resources, specifying other roles to be granted and grantees (other roles and users).
module "snowflake_role" {
source = "github.com/getindata/terraform-snowflake-role"
name = "LOGS_DATABASE_READER"
granted_to_users = ["JANE_SMITH", "JOHN_DOE"]
account_grants = [
{
privileges = ["CREATE DATABASE"]
}
]
account_objects_grants = {
"DATABASE" = [
{
privileges = ["USAGE"]
object_name = "LOGS_DB"
}
]
}
schema_grants = [
{
database_name = "LOGS_DB"
schema_name = "BRONZE"
privileges = ["USAGE"]
}
]
schema_objects_grants = {
TABLE = [
{
database_name = "LOGS_DB"
schema_name = "BRONZE"
on_future = true
privileges = ["SELECT"]
}
]
VIEW = [
{
database_name = snowflake_database.this.name
on_future = true
all_privileges = true
}
]
}
}
Due to breaking changes in Snowflake provider and additional code optimizations, breaking changes were introduced in v2.0.0
version of this module.
List of code and variable (API) changes:
- Switched to
snowflake_account_role
resource instead of provider-deprecatedsnowflake_role
- Switched to
snowflake_grant_privileges_to_account_role
resource instead of provider-removedsnowflake_*_grant
- Switched to
snowflake_grant_account_role
resource instead of provider-removedsnowflake_role_grants
- Switched to
snowflake_grant_ownership
resource instead of provider-removedsnowflake_role_ownership_grant
- Variable
account_grants
type changed fromlist(string)
tolist(object({..}))
- Variable
schema_grants
type changed - Below variables were removed and replaced with aggregated / complex
account_object_grants
andschema_object_grants
:database_grants
table_grants
external_table_grants
view_grants
dynamic_table_grants
When upgrading from v1.x
, expect most of the resources to be recreated - if recreation is impossible, then it is possible to import some existing resources.
For more information, refer to variables.tf, list of inputs below and Snowflake provider documentation
Name | Description | Type | Default | Required |
---|---|---|---|---|
account_grants | Grants on a account level | list(object({ |
[] |
no |
account_objects_grants | Grants on account object level. Account objects list: USER | RESOURCE MONITOR | WAREHOUSE | COMPUTE POOL | DATABASE | INTEGRATION | FAILOVER GROUP | REPLICATION GROUP | EXTERNAL VOLUME Object type is used as a key in the map. Exmpale usage: account_object_grants = {Note: You can find a list of all object types here |
map(list(object({ |
{} |
no |
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 | 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 |
{ |
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 beidentical 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-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_roles | Roles granted to this role | list(string) |
[] |
no |
granted_to_roles | Roles which this role is granted to | list(string) |
[] |
no |
granted_to_users | Users which this role is granted 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 bechanged in later chained modules. Attempts to change it will be silently ignored. |
set(string) |
[ |
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 |
role_ownership_grant | The name of the role to grant ownership | string |
null |
no |
schema_grants | Grants on a schema level | list(object({ |
[] |
no |
schema_objects_grants | Grants on a schema object level Example usage: schema_objects_grants = {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({ |
{} |
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 |
Name | Source | Version |
---|---|---|
role_label | cloudposse/label/null | 0.25.0 |
this | cloudposse/label/null | 0.25.0 |
Name | Description |
---|---|
name | Name of the role |
Name | Version |
---|---|
snowflake | ~> 0.94 |
Name | Version |
---|---|
terraform | >= 1.3 |
snowflake | ~> 0.94 |
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.
Apache 2 Licensed. See LICENSE for full details.
Made with contrib.rocks.