Giters

getindata / terraform-snowflake-warehouse

Terraform module for Snowflake Warehouse management

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

modulesnowflakesnowflakedbterraform

Terraform Snowflake Warehouse

Snowflake Terraform

License Release

We help companies turn their data into assets

Terraform module for Snowflake Warehouse management

  • Creates Snowflake Warehouse
  • Can create custom Snowflake Roles with role-to-role, role-to-user assignments
  • Can create a set of default, functional roles to simplify access management:
    • ADMIN - full access
    • MODIFY - abillity to modify warehouse
    • MONITOR - abillity to monitor warehouse
    • USAGE - abillity to use warehouse

USAGE

module "terraform_snowflake_warehouse" {
  source  = "getindata/warehouse/snowflake"
  context = module.this.context

  name    = "warehouse"
  comment = "My Warehouse"

  warehouse_size = "x-small"

  auto_resume         = true
  auto_suspend        = 600
  initially_suspended = true

  create_default_roles = true

  roles = {
    admin = {
      granted_to_roles = ["SYSADMIN"]
    }
  }
}

NOTES

Additional information that should be made public, for ex. how to solve known issues, additional descriptions/suggestions

EXAMPLES

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
auto_resume Specifies whether to automatically resume a warehouse when a SQL statement (e.g. query) is submitted to it. bool true no
auto_suspend Specifies the number of seconds of inactivity after which a warehouse is automatically suspended. number null no
comment Warehouse comment/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
create_default_roles Whether the default roles should be created bool false 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
descriptor_name Name of the descriptor used to form a resource name string "snowflake-warehouse" no
enable_query_acceleration Specifies whether to enable the query acceleration service for queries that rely on this warehouse for compute resources. bool true 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
initially_suspended Specifies whether the warehouse is created initially in the ‘Suspended’ state. bool true 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
max_cluster_count Specifies the maximum number of server clusters for the warehouse. number 1 no
max_concurrency_level Object parameter that specifies the concurrency level for SQL statements (i.e. queries and DML) executed by a warehouse. number null no
min_cluster_count Specifies the minimum number of server clusters for the warehouse (only applies to multi-cluster warehouses). number 1 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
query_acceleration_max_scale_factor Specifies the maximum scale factor for leasing compute resources for query acceleration. The scale factor is used as a multiplier based on warehouse size. number 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
resource_monitor Specifies the name of a resource monitor that is explicitly assigned to the warehouse. string null no
roles Roles created on the warehouse level 
map(object({
    enabled              = optional(bool, true)
    descriptor_name      = optional(string, "snowflake-role")
    comment              = optional(string)
    role_ownership_grant = optional(string)
    granted_roles        = optional(list(string))
    granted_to_roles     = optional(list(string))
    granted_to_users     = optional(list(string))
    warehouse_grants     = optional(list(string))
  }))
 {} no
scaling_policy Specifies the policy for automatically starting and shutting down clusters in a multi-cluster warehouse running in Auto-scale mode. string null no
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null no
statement_queued_timeout_in_seconds Object parameter that specifies the time, in seconds, a SQL statement (query, DDL, DML, etc.) can be queued on a warehouse before it is canceled by the system. number null no
statement_timeout_in_seconds Specifies the time, in seconds, after which a running SQL statement (query, DDL, DML, etc.) is canceled by the system number 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
warehouse_size Specifies the size of the virtual warehouse. string "X-Small" no
warehouse_type Specifies the type of the virtual warehouse. string "STANDARD" no

Modules

Name Source Version
roles_deep_merge Invicton-Labs/deepmerge/null 0.1.5
snowflake_custom_role getindata/role/snowflake 1.0.3
snowflake_default_role getindata/role/snowflake 1.0.3
this cloudposse/label/null 0.25.0
warehouse_label cloudposse/label/null 0.25.0

Outputs

Name Description
roles Access roles created for warehouse
warehouse Details of the warehouse

Providers

Name Version
snowflake ~> 0.53

Requirements

Name Version
terraform >= 1.3
snowflake ~> 0.53

Resources

Name Type
snowflake_warehouse.this resource
snowflake_warehouse_grant.this 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.

About

Terraform module for Snowflake Warehouse management

modulesnowflakesnowflakedbterraform

License:Apache License 2.0

Languages

Language:HCL 100.0%