` | `string` | n/a | yes |
-| [id\_length\_limit](#input\_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](#input\_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](#input\_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](#input\_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](#input\_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 |
| [log\_level](#input\_log\_level) | Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF] | `string` | `null` | no |
-| [name](#input\_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](#input\_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 |
+| [name](#input\_name) | Name of the resource | `string` | n/a | yes |
+| [name\_scheme](#input\_name\_scheme) | Naming scheme configuration for the resource. This configuration is used to generate names using context provider:
- `properties` - list of properties to use when creating the name - is superseded by `var.context_templates`
- `delimiter` - delimited used to create the name from `properties` - is superseded by `var.context_templates`
- `context_template_name` - name of the context template used to create the name
- `replace_chars_regex` - regex to use for replacing characters in property-values created by the provider - any characters that match the regex will be removed from the name
- `extra_values` - map of extra label-value pairs, used to create a name | object({
properties = optional(list(string), ["environment", "name"])
delimiter = optional(string, "_")
context_template_name = optional(string, "snowflake-shared-database")
replace_chars_regex = optional(string, "[^a-zA-Z0-9_]")
extra_values = optional(map(string))
}) | `{}` | no |
| [quoted\_identifiers\_ignore\_case](#input\_quoted\_identifiers\_ignore\_case) | If true, the case of quoted identifiers is ignored | `bool` | `null` | no |
-| [regex\_replace\_chars](#input\_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 |
| [replace\_invalid\_characters](#input\_replace\_invalid\_characters) | If true, invalid characters are replaced with the replacement character | `bool` | `null` | no |
-| [roles](#input\_roles) | Account roles created on the Shared Database 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))
database_grants = optional(object({
privileges = optional(list(string))
}))
})) | `{}` | no |
-| [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |
+| [roles](#input\_roles) | Account roles created on the Shared Database level | map(object({
name_scheme = optional(object({
properties = optional(list(string))
delimiter = optional(string)
context_template_name = optional(string)
replace_chars_regex = optional(string)
extra_labels = optional(map(string))
}))
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))
database_grants = optional(object({
privileges = optional(list(string))
}))
})) | `{}` | no |
| [storage\_serialization\_policy](#input\_storage\_serialization\_policy) | The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED] | `string` | `null` | no |
| [suspend\_task\_after\_num\_failures](#input\_suspend\_task\_after\_num\_failures) | How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending | `number` | `null` | no |
-| [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).
Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no |
| [task\_auto\_retry\_attempts](#input\_task\_auto\_retry\_attempts) | Maximum automatic retries allowed for a user task | `number` | `null` | no |
-| [tenant](#input\_tenant) | ID element \_(Rarely used, not included by default)\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no |
| [trace\_level](#input\_trace\_level) | Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON\_EVENT OFF] | `string` | `null` | no |
| [user\_task\_managed\_initial\_warehouse\_size](#input\_user\_task\_managed\_initial\_warehouse\_size) | The initial size of warehouse to use for managed warehouses in the absence of history | `string` | `null` | no |
| [user\_task\_minimum\_trigger\_interval\_in\_seconds](#input\_user\_task\_minimum\_trigger\_interval\_in\_seconds) | Minimum amount of time between Triggered Task executions in seconds | `number` | `null` | no |
@@ -90,11 +74,9 @@ module "snowflake_shared_database" {
| Name | Source | Version |
|------|--------|---------|
-| [database\_label](#module\_database\_label) | cloudposse/label/null | 0.25.0 |
| [roles\_deep\_merge](#module\_roles\_deep\_merge) | Invicton-Labs/deepmerge/null | 0.1.5 |
-| [snowflake\_custom\_role](#module\_snowflake\_custom\_role) | getindata/role/snowflake | 2.1.0 |
-| [snowflake\_default\_role](#module\_snowflake\_default\_role) | getindata/role/snowflake | 2.1.0 |
-| [this](#module\_this) | cloudposse/label/null | 0.25.0 |
+| [snowflake\_custom\_role](#module\_snowflake\_custom\_role) | getindata/role/snowflake | 3.0.1 |
+| [snowflake\_default\_role](#module\_snowflake\_default\_role) | getindata/role/snowflake | 3.0.1 |
## Outputs
@@ -122,6 +104,7 @@ module "snowflake_shared_database" {
| Name | Version |
|------|---------|
+| [context](#provider\_context) | >=0.4.0 |
| [snowflake](#provider\_snowflake) | >= 0.94.0 |
## Requirements
@@ -129,6 +112,7 @@ module "snowflake_shared_database" {
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | >= 1.3 |
+| [context](#requirement\_context) | >=0.4.0 |
| [snowflake](#requirement\_snowflake) | >= 0.94.0 |
## Resources
@@ -136,6 +120,7 @@ module "snowflake_shared_database" {
| Name | Type |
|------|------|
| [snowflake_shared_database.this](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/shared_database) | resource |
+| [context_label.this](https://registry.terraform.io/providers/cloudposse/context/latest/docs/data-sources/label) | data source |
## CONTRIBUTING
diff --git a/context.tf b/context.tf
deleted file mode 100644
index 5e0ef88..0000000
--- a/context.tf
+++ /dev/null
@@ -1,279 +0,0 @@
-#
-# ONLY EDIT THIS FILE IN github.com/cloudposse/terraform-null-label
-# All other instances of this file should be a copy of that one
-#
-#
-# Copy this file from https://github.com/cloudposse/terraform-null-label/blob/master/exports/context.tf
-# and then place it in your Terraform module to automatically get
-# Cloud Posse's standard configuration inputs suitable for passing
-# to Cloud Posse modules.
-#
-# curl -sL https://raw.githubusercontent.com/cloudposse/terraform-null-label/master/exports/context.tf -o context.tf
-#
-# Modules should access the whole context as `module.this.context`
-# to get the input variables with nulls for defaults,
-# for example `context = module.this.context`,
-# and access individual variables as `module.this.`,
-# with final values filled in.
-#
-# For example, when using defaults, `module.this.context.delimiter`
-# will be null, and `module.this.delimiter` will be `-` (hyphen).
-#
-
-module "this" {
- source = "cloudposse/label/null"
- version = "0.25.0" # requires Terraform >= 0.13.0
-
- enabled = var.enabled
- namespace = var.namespace
- tenant = var.tenant
- environment = var.environment
- stage = var.stage
- name = var.name
- delimiter = var.delimiter
- attributes = var.attributes
- tags = var.tags
- additional_tag_map = var.additional_tag_map
- label_order = var.label_order
- regex_replace_chars = var.regex_replace_chars
- id_length_limit = var.id_length_limit
- label_key_case = var.label_key_case
- label_value_case = var.label_value_case
- descriptor_formats = var.descriptor_formats
- labels_as_tags = var.labels_as_tags
-
- context = var.context
-}
-
-# Copy contents of cloudposse/terraform-null-label/variables.tf here
-
-variable "context" {
- type = any
- default = {
- enabled = true
- namespace = null
- tenant = null
- environment = null
- stage = null
- name = null
- delimiter = null
- attributes = []
- tags = {}
- additional_tag_map = {}
- regex_replace_chars = null
- label_order = []
- id_length_limit = null
- label_key_case = null
- label_value_case = null
- descriptor_formats = {}
- # Note: we have to use [] instead of null for unset lists due to
- # https://github.com/hashicorp/terraform/issues/28137
- # which was not fixed until Terraform 1.0.0,
- # but we want the default to be all the labels in `label_order`
- # and we want users to be able to prevent all tag generation
- # by setting `labels_as_tags` to `[]`, so we need
- # a different sentinel to indicate "default"
- labels_as_tags = ["unset"]
- }
- description = <<-EOT
- 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.
- EOT
-
- validation {
- condition = lookup(var.context, "label_key_case", null) == null ? true : contains(["lower", "title", "upper"], var.context["label_key_case"])
- error_message = "Allowed values: `lower`, `title`, `upper`."
- }
-
- validation {
- condition = lookup(var.context, "label_value_case", null) == null ? true : contains(["lower", "title", "upper", "none"], var.context["label_value_case"])
- error_message = "Allowed values: `lower`, `title`, `upper`, `none`."
- }
-}
-
-variable "enabled" {
- type = bool
- default = null
- description = "Set to false to prevent the module from creating any resources"
-}
-
-variable "namespace" {
- type = string
- default = null
- description = "ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique"
-}
-
-variable "tenant" {
- type = string
- default = null
- description = "ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for"
-}
-
-variable "environment" {
- type = string
- default = null
- description = "ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'"
-}
-
-variable "stage" {
- type = string
- default = null
- description = "ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'"
-}
-
-variable "name" {
- type = string
- default = null
- description = <<-EOT
- 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.
- EOT
-}
-
-variable "delimiter" {
- type = string
- default = null
- description = <<-EOT
- Delimiter to be used between ID elements.
- Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.
- EOT
-}
-
-variable "attributes" {
- type = list(string)
- default = []
- description = <<-EOT
- 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.
- EOT
-}
-
-variable "labels_as_tags" {
- type = set(string)
- default = ["default"]
- description = <<-EOT
- 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.
- EOT
-}
-
-variable "tags" {
- type = map(string)
- default = {}
- description = <<-EOT
- Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).
- Neither the tag keys nor the tag values will be modified by this module.
- EOT
-}
-
-variable "additional_tag_map" {
- type = map(string)
- default = {}
- description = <<-EOT
- 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.
- EOT
-}
-
-variable "label_order" {
- type = list(string)
- default = null
- description = <<-EOT
- 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.
- EOT
-}
-
-variable "regex_replace_chars" {
- type = string
- default = null
- description = <<-EOT
- 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.
- EOT
-}
-
-variable "id_length_limit" {
- type = number
- default = null
- description = <<-EOT
- 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`.
- EOT
- validation {
- condition = var.id_length_limit == null ? true : var.id_length_limit >= 6 || var.id_length_limit == 0
- error_message = "The id_length_limit must be >= 6 if supplied (not null), or 0 for unlimited length."
- }
-}
-
-variable "label_key_case" {
- type = string
- default = null
- description = <<-EOT
- 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`.
- EOT
-
- validation {
- condition = var.label_key_case == null ? true : contains(["lower", "title", "upper"], var.label_key_case)
- error_message = "Allowed values: `lower`, `title`, `upper`."
- }
-}
-
-variable "label_value_case" {
- type = string
- default = null
- description = <<-EOT
- 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`.
- EOT
-
- validation {
- condition = var.label_value_case == null ? true : contains(["lower", "title", "upper", "none"], var.label_value_case)
- error_message = "Allowed values: `lower`, `title`, `upper`, `none`."
- }
-}
-
-variable "descriptor_formats" {
- type = any
- default = {}
- description = <<-EOT
- 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
- `{
- format = string
- labels = list(string)
- }`
- (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).
- EOT
-}
-
-#### End of copy of cloudposse/terraform-null-label/variables.tf
diff --git a/examples/complete/README.md b/examples/complete/README.md
index 3e69295..91addaa 100644
--- a/examples/complete/README.md
+++ b/examples/complete/README.md
@@ -75,32 +75,14 @@ var.from_share
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
-| [additional\_tag\_map](#input\_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](#input\_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](#input\_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 |
-| [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.
Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no |
-| [descriptor\_formats](#input\_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
`{
format = string
labels = list(string)
}`
(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](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |
-| [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |
+| [context\_templates](#input\_context\_templates) | A map of context templates used to generate names | `map(string)` | n/a | yes |
| [from\_share](#input\_from\_share) | A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of `..` | `string` | n/a | yes |
-| [id\_length\_limit](#input\_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](#input\_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](#input\_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](#input\_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](#input\_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](#input\_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](#input\_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](#input\_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 |
-| [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |
-| [tags](#input\_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](#input\_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 |
|------|--------|---------|
| [snowflake\_shared\_database](#module\_snowflake\_shared\_database) | ../.. | n/a |
-| [this](#module\_this) | cloudposse/label/null | 0.25.0 |
## Outputs
@@ -119,6 +101,7 @@ var.from_share
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | >= 1.3 |
+| [context](#requirement\_context) | >=0.4.0 |
| [snowflake](#requirement\_snowflake) | >= 0.94.0 |
## Resources
diff --git a/examples/complete/context.tf b/examples/complete/context.tf
deleted file mode 100644
index 5e0ef88..0000000
--- a/examples/complete/context.tf
+++ /dev/null
@@ -1,279 +0,0 @@
-#
-# ONLY EDIT THIS FILE IN github.com/cloudposse/terraform-null-label
-# All other instances of this file should be a copy of that one
-#
-#
-# Copy this file from https://github.com/cloudposse/terraform-null-label/blob/master/exports/context.tf
-# and then place it in your Terraform module to automatically get
-# Cloud Posse's standard configuration inputs suitable for passing
-# to Cloud Posse modules.
-#
-# curl -sL https://raw.githubusercontent.com/cloudposse/terraform-null-label/master/exports/context.tf -o context.tf
-#
-# Modules should access the whole context as `module.this.context`
-# to get the input variables with nulls for defaults,
-# for example `context = module.this.context`,
-# and access individual variables as `module.this.`,
-# with final values filled in.
-#
-# For example, when using defaults, `module.this.context.delimiter`
-# will be null, and `module.this.delimiter` will be `-` (hyphen).
-#
-
-module "this" {
- source = "cloudposse/label/null"
- version = "0.25.0" # requires Terraform >= 0.13.0
-
- enabled = var.enabled
- namespace = var.namespace
- tenant = var.tenant
- environment = var.environment
- stage = var.stage
- name = var.name
- delimiter = var.delimiter
- attributes = var.attributes
- tags = var.tags
- additional_tag_map = var.additional_tag_map
- label_order = var.label_order
- regex_replace_chars = var.regex_replace_chars
- id_length_limit = var.id_length_limit
- label_key_case = var.label_key_case
- label_value_case = var.label_value_case
- descriptor_formats = var.descriptor_formats
- labels_as_tags = var.labels_as_tags
-
- context = var.context
-}
-
-# Copy contents of cloudposse/terraform-null-label/variables.tf here
-
-variable "context" {
- type = any
- default = {
- enabled = true
- namespace = null
- tenant = null
- environment = null
- stage = null
- name = null
- delimiter = null
- attributes = []
- tags = {}
- additional_tag_map = {}
- regex_replace_chars = null
- label_order = []
- id_length_limit = null
- label_key_case = null
- label_value_case = null
- descriptor_formats = {}
- # Note: we have to use [] instead of null for unset lists due to
- # https://github.com/hashicorp/terraform/issues/28137
- # which was not fixed until Terraform 1.0.0,
- # but we want the default to be all the labels in `label_order`
- # and we want users to be able to prevent all tag generation
- # by setting `labels_as_tags` to `[]`, so we need
- # a different sentinel to indicate "default"
- labels_as_tags = ["unset"]
- }
- description = <<-EOT
- 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.
- EOT
-
- validation {
- condition = lookup(var.context, "label_key_case", null) == null ? true : contains(["lower", "title", "upper"], var.context["label_key_case"])
- error_message = "Allowed values: `lower`, `title`, `upper`."
- }
-
- validation {
- condition = lookup(var.context, "label_value_case", null) == null ? true : contains(["lower", "title", "upper", "none"], var.context["label_value_case"])
- error_message = "Allowed values: `lower`, `title`, `upper`, `none`."
- }
-}
-
-variable "enabled" {
- type = bool
- default = null
- description = "Set to false to prevent the module from creating any resources"
-}
-
-variable "namespace" {
- type = string
- default = null
- description = "ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique"
-}
-
-variable "tenant" {
- type = string
- default = null
- description = "ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for"
-}
-
-variable "environment" {
- type = string
- default = null
- description = "ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'"
-}
-
-variable "stage" {
- type = string
- default = null
- description = "ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'"
-}
-
-variable "name" {
- type = string
- default = null
- description = <<-EOT
- 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.
- EOT
-}
-
-variable "delimiter" {
- type = string
- default = null
- description = <<-EOT
- Delimiter to be used between ID elements.
- Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.
- EOT
-}
-
-variable "attributes" {
- type = list(string)
- default = []
- description = <<-EOT
- 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.
- EOT
-}
-
-variable "labels_as_tags" {
- type = set(string)
- default = ["default"]
- description = <<-EOT
- 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.
- EOT
-}
-
-variable "tags" {
- type = map(string)
- default = {}
- description = <<-EOT
- Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).
- Neither the tag keys nor the tag values will be modified by this module.
- EOT
-}
-
-variable "additional_tag_map" {
- type = map(string)
- default = {}
- description = <<-EOT
- 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.
- EOT
-}
-
-variable "label_order" {
- type = list(string)
- default = null
- description = <<-EOT
- 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.
- EOT
-}
-
-variable "regex_replace_chars" {
- type = string
- default = null
- description = <<-EOT
- 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.
- EOT
-}
-
-variable "id_length_limit" {
- type = number
- default = null
- description = <<-EOT
- 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`.
- EOT
- validation {
- condition = var.id_length_limit == null ? true : var.id_length_limit >= 6 || var.id_length_limit == 0
- error_message = "The id_length_limit must be >= 6 if supplied (not null), or 0 for unlimited length."
- }
-}
-
-variable "label_key_case" {
- type = string
- default = null
- description = <<-EOT
- 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`.
- EOT
-
- validation {
- condition = var.label_key_case == null ? true : contains(["lower", "title", "upper"], var.label_key_case)
- error_message = "Allowed values: `lower`, `title`, `upper`."
- }
-}
-
-variable "label_value_case" {
- type = string
- default = null
- description = <<-EOT
- 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`.
- EOT
-
- validation {
- condition = var.label_value_case == null ? true : contains(["lower", "title", "upper", "none"], var.label_value_case)
- error_message = "Allowed values: `lower`, `title`, `upper`, `none`."
- }
-}
-
-variable "descriptor_formats" {
- type = any
- default = {}
- description = <<-EOT
- 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
- `{
- format = string
- labels = list(string)
- }`
- (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).
- EOT
-}
-
-#### End of copy of cloudposse/terraform-null-label/variables.tf
diff --git a/examples/complete/fixtures.tfvars b/examples/complete/fixtures.tfvars
index f575f57..866a1c8 100644
--- a/examples/complete/fixtures.tfvars
+++ b/examples/complete/fixtures.tfvars
@@ -1,14 +1,4 @@
-namespace = "gid"
-#stage = "example"
-#environment = "dev"
-
-descriptor_formats = {
- snowflake-role = {
- labels = ["attributes", "name"]
- format = "%v_%v"
- }
- snowflake-database = {
- labels = ["environment", "stage", "name", "attributes"]
- format = "%v_%v_%v_%v"
- }
+context_templates = {
+ snowflake-shared-database = "{{.environment}}_{{.name}}"
+ snowflake-shared-database-role = "{{.environment}}_{{.database}}_{{.name}}"
}
diff --git a/examples/complete/main.tf b/examples/complete/main.tf
index f390c5f..cd48039 100644
--- a/examples/complete/main.tf
+++ b/examples/complete/main.tf
@@ -9,11 +9,10 @@ resource "snowflake_account_role" "this" {
module "snowflake_shared_database" {
source = "../.."
- name = "SHARED_DATABASE"
- context = module.this.context
- from_share = var.from_share
+ name = "shared_database"
+ context_templates = var.context_templates
+ from_share = var.from_share
- descriptor_name = "snowflake-database"
comment = "Sample shared Database"
replace_invalid_characters = true
default_ddl_collation = "UTF8"
@@ -36,5 +35,10 @@ module "snowflake_shared_database" {
granted_roles = [resource.snowflake_account_role.this.name]
granted_to_users = [resource.snowflake_user.this.name]
}
+ custom = {
+ database_grants = {
+ privileges = ["IMPORTED PRIVILEGES"]
+ }
+ }
}
}
diff --git a/examples/complete/providers.tf b/examples/complete/providers.tf
index d343f0d..5b943b9 100644
--- a/examples/complete/providers.tf
+++ b/examples/complete/providers.tf
@@ -1 +1,12 @@
provider "snowflake" {}
+
+provider "context" {
+ properties = {
+ "environment" = {}
+ "name" = { required = true }
+ }
+
+ values = {
+ environment = "dev"
+ }
+}
diff --git a/examples/complete/variables.tf b/examples/complete/variables.tf
index 99be937..451d0c0 100644
--- a/examples/complete/variables.tf
+++ b/examples/complete/variables.tf
@@ -2,3 +2,8 @@ variable "from_share" {
description = "A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of `..`"
type = string
}
+
+variable "context_templates" {
+ description = "A map of context templates used to generate names"
+ type = map(string)
+}
diff --git a/examples/complete/versions.tf b/examples/complete/versions.tf
index dba1fe9..e03ba3f 100644
--- a/examples/complete/versions.tf
+++ b/examples/complete/versions.tf
@@ -5,5 +5,9 @@ terraform {
source = "Snowflake-Labs/snowflake"
version = ">= 0.94.0"
}
+ context = {
+ source = "cloudposse/context"
+ version = ">=0.4.0"
+ }
}
}
diff --git a/locals.tf b/locals.tf
index 89dfe89..2601336 100644
--- a/locals.tf
+++ b/locals.tf
@@ -1,23 +1,25 @@
locals {
- # Get a name from the descriptor. If not available, use default naming convention.
- # Trim and replace function are used to avoid bare delimiters on both ends of the name and situation of adjacent delimiters.
- name_from_descriptor = module.database_label.enabled ? trim(replace(
- lookup(module.database_label.descriptors, var.descriptor_name, module.database_label.id), "/${module.database_label.delimiter}${module.database_label.delimiter}+/", module.database_label.delimiter
- ), module.database_label.delimiter) : null
+ context_template = lookup(var.context_templates, var.name_scheme.context_template_name, null)
- create_default_roles = module.this.enabled && var.create_default_roles
+ default_role_naming_scheme = {
+ properties = ["environment", "database", "name"]
+ context_template_name = "snowflake-shared-database-role"
+ extra_values = {
+ database = var.name
+ }
+ }
#This needs to be the same as an object in roles variable
- role_template = {
- enabled = true
- descriptor_name = "snowflake-role"
- comment = null
- role_ownership_grant = "SYSADMIN"
- granted_roles = []
- granted_to_roles = []
- granted_to_users = []
- database_grants = {}
- }
+ # role_template = {
+ # enabled = true
+ # descriptor_name = "snowflake-role"
+ # comment = null
+ # role_ownership_grant = "SYSADMIN"
+ # granted_roles = []
+ # granted_to_roles = []
+ # granted_to_users = []
+ # database_grants = {}
+ # }
default_roles_definition = {
readonly = {
@@ -32,16 +34,17 @@ locals {
if v != null
} }
- roles_definition = {
- for role_name, role in module.roles_deep_merge.merged : role_name => merge(
- local.role_template,
- role
- )
- }
+ roles_definition = module.roles_deep_merge.merged
+ # roles_definition = {
+ # for role_name, role in module.roles_deep_merge.merged : role_name => merge(
+ # local.role_template,
+ # role
+ # )
+ # }
default_roles = {
for role_name, role in local.roles_definition : role_name => role
- if contains(keys(local.default_roles_definition), role_name)
+ if contains(keys(local.default_roles_definition), role_name) && var.create_default_roles
}
custom_roles = {
@@ -51,7 +54,7 @@ locals {
roles = {
for role_name, role in merge(
- var.create_default_roles ? module.snowflake_default_role : {},
+ module.snowflake_default_role,
module.snowflake_custom_role
) : role_name => role
if role_name != null
diff --git a/main.tf b/main.tf
index a4200b2..ddeb44b 100644
--- a/main.tf
+++ b/main.tf
@@ -1,17 +1,19 @@
-module "database_label" {
- source = "cloudposse/label/null"
- version = "0.25.0"
- context = module.this.context
-
- delimiter = coalesce(module.this.context.delimiter, "_")
- regex_replace_chars = coalesce(module.this.context.regex_replace_chars, "/[^_a-zA-Z0-9]/")
- label_value_case = coalesce(module.this.context.label_value_case, "upper")
+data "context_label" "this" {
+ delimiter = local.context_template == null ? var.name_scheme.delimiter : null
+ properties = local.context_template == null ? var.name_scheme.properties : null
+ template = local.context_template
+
+ replace_chars_regex = var.name_scheme.replace_chars_regex
+
+ values = merge(
+ var.name_scheme.extra_values,
+ { name = var.name }
+ )
}
-resource "snowflake_shared_database" "this" {
- count = module.this.enabled ? 1 : 0
- name = local.name_from_descriptor
+resource "snowflake_shared_database" "this" {
+ name = data.context_label.this.rendered
from_share = var.from_share
comment = var.comment
@@ -30,19 +32,25 @@ resource "snowflake_shared_database" "this" {
user_task_minimum_trigger_interval_in_seconds = var.user_task_minimum_trigger_interval_in_seconds
user_task_timeout_ms = var.user_task_timeout_ms
}
+moved {
+ from = snowflake_shared_database.this[0]
+ to = snowflake_shared_database.this
+}
module "snowflake_default_role" {
for_each = local.default_roles
source = "getindata/role/snowflake"
- version = "2.1.0"
- context = module.this.context
+ version = "3.0.1"
- name = each.key
- comment = lookup(each.value, "comment", null)
- enabled = local.create_default_roles && lookup(each.value, "enabled", true)
- attributes = [one(snowflake_shared_database.this[*].name)]
- descriptor_name = lookup(each.value, "descriptor_name", "snowflake-role")
+ context_templates = var.context_templates
+
+ name = each.key
+ name_scheme = merge(
+ local.default_role_naming_scheme,
+ lookup(each.value, "name_scheme", {})
+ )
+ comment = lookup(each.value, "comment", null)
granted_to_roles = lookup(each.value, "granted_to_roles", [])
granted_roles = lookup(each.value, "granted_roles", [])
@@ -50,38 +58,32 @@ module "snowflake_default_role" {
account_objects_grants = {
DATABASE = [{
privileges = each.value.database_grants.privileges
- object_name = one(snowflake_shared_database.this[*].name)
+ object_name = snowflake_shared_database.this.name
}]
}
-
- depends_on = [
- snowflake_shared_database.this
- ]
}
module "snowflake_custom_role" {
for_each = local.custom_roles
source = "getindata/role/snowflake"
- version = "2.1.0"
- context = module.this.context
+ version = "3.0.1"
- name = each.key
- comment = lookup(each.value, "comment", null)
- enabled = module.this.enabled && lookup(each.value, "enabled", true)
- attributes = [one(snowflake_shared_database.this[*].name)]
- descriptor_name = lookup(each.value, "descriptor_name", "snowflake-role")
+ context_templates = var.context_templates
+
+ name = each.key
+ name_scheme = merge(
+ local.default_role_naming_scheme,
+ lookup(each.value, "name_scheme", {})
+ )
+ comment = lookup(each.value, "comment", null)
granted_to_roles = lookup(each.value, "granted_to_roles", [])
granted_roles = lookup(each.value, "granted_roles", [])
account_objects_grants = {
DATABASE = [{
privileges = each.value.database_grants.privileges
- object_name = one(snowflake_shared_database.this[*].name)
+ object_name = snowflake_shared_database.this.name
}]
}
-
- depends_on = [
- snowflake_shared_database.this
- ]
}
diff --git a/outputs.tf b/outputs.tf
index ce8c4ec..681d4a3 100644
--- a/outputs.tf
+++ b/outputs.tf
@@ -1,81 +1,81 @@
output "name" {
description = "Name of the database"
- value = one(snowflake_shared_database.this[*].name)
+ value = snowflake_shared_database.this.name
}
output "from_share" {
description = "The name of the share from which the database is created"
- value = one(snowflake_shared_database.this[*].from_share)
+ value = snowflake_shared_database.this.from_share
}
output "comment" {
description = "The comment for the database"
- value = one(snowflake_shared_database.this[*].comment)
+ value = snowflake_shared_database.this.comment
}
output "external_volume" {
description = "The database parameter that specifies the default external volume to use for Iceberg tables"
- value = one(snowflake_shared_database.this[*].external_volume)
+ value = snowflake_shared_database.this.external_volume
}
output "catalog" {
description = "The database parameter that specifies the default catalog to use for Iceberg tables"
- value = one(snowflake_shared_database.this[*].catalog)
+ value = snowflake_shared_database.this.catalog
}
output "default_ddl_collation" {
description = "Specifies a default collation specification for all schemas and tables added to the database."
- value = one(snowflake_shared_database.this[*].default_ddl_collation)
+ value = snowflake_shared_database.this.default_ddl_collation
}
output "storage_serialization_policy" {
description = "The storage serialization policy for Iceberg tables that use Snowflake as the catalog. Valid options are: [COMPATIBLE OPTIMIZED]"
- value = one(snowflake_shared_database.this[*].storage_serialization_policy)
+ value = snowflake_shared_database.this.storage_serialization_policy
}
output "log_level" {
description = "Specifies the severity level of messages that should be ingested and made available in the active event table. Valid options are: [TRACE DEBUG INFO WARN ERROR FATAL OFF]"
- value = one(snowflake_shared_database.this[*].log_level)
+ value = snowflake_shared_database.this.log_level
}
output "trace_level" {
description = "Controls how trace events are ingested into the event table. Valid options are: [ALWAYS ON_EVENT OFF]"
- value = one(snowflake_shared_database.this[*].trace_level)
+ value = snowflake_shared_database.this.trace_level
}
output "suspend_task_after_num_failures" {
description = "How many times a task must fail in a row before it is automatically suspended. 0 disables auto-suspending"
- value = one(snowflake_shared_database.this[*].suspend_task_after_num_failures)
+ value = snowflake_shared_database.this.suspend_task_after_num_failures
}
output "task_auto_retry_attempts" {
description = "Maximum automatic retries allowed for a user task"
- value = one(snowflake_shared_database.this[*].task_auto_retry_attempts)
+ value = snowflake_shared_database.this.task_auto_retry_attempts
}
output "user_task_managed_initial_warehouse_size" {
description = "The initial size of warehouse to use for managed warehouses in the absence of history"
- value = one(snowflake_shared_database.this[*].user_task_managed_initial_warehouse_size)
+ value = snowflake_shared_database.this.user_task_managed_initial_warehouse_size
}
output "user_task_minimum_trigger_interval_in_seconds" {
description = "Minimum amount of time between Triggered Task executions in seconds"
- value = one(snowflake_shared_database.this[*].user_task_minimum_trigger_interval_in_seconds)
+ value = snowflake_shared_database.this.user_task_minimum_trigger_interval_in_seconds
}
output "user_task_timeout_ms" {
description = "User task execution timeout in milliseconds"
- value = one(snowflake_shared_database.this[*].user_task_timeout_ms)
+ value = snowflake_shared_database.this.user_task_timeout_ms
}
output "quoted_identifiers_ignore_case" {
description = "If true, the case of quoted identifiers is ignored"
- value = one(snowflake_shared_database.this[*].quoted_identifiers_ignore_case)
+ value = snowflake_shared_database.this.quoted_identifiers_ignore_case
}
output "enable_console_output" {
description = "If true, enables stdout/stderr fast path logging for anonymous stored procedures"
- value = one(snowflake_shared_database.this[*].enable_console_output)
+ value = snowflake_shared_database.this.enable_console_output
}
output "roles" {
diff --git a/variables.tf b/variables.tf
index a318aa2..b724db1 100644
--- a/variables.tf
+++ b/variables.tf
@@ -1,12 +1,11 @@
-variable "from_share" {
- description = "A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of `..`"
+variable "name" {
+ description = "Name of the resource"
type = string
}
-variable "descriptor_name" {
- description = "Name of the descriptor used to form a resource name"
+variable "from_share" {
+ description = "A fully qualified path to a share from which the database will be created. A fully qualified path follows the format of `..`"
type = string
- default = "snowflake-database"
}
variable "comment" {
@@ -108,8 +107,13 @@ variable "create_default_roles" {
variable "roles" {
description = "Account roles created on the Shared Database level"
type = map(object({
- enabled = optional(bool, true)
- descriptor_name = optional(string, "snowflake-role")
+ name_scheme = optional(object({
+ properties = optional(list(string))
+ delimiter = optional(string)
+ context_template_name = optional(string)
+ replace_chars_regex = optional(string)
+ extra_labels = optional(map(string))
+ }))
comment = optional(string)
role_ownership_grant = optional(string)
granted_roles = optional(list(string))
@@ -121,3 +125,28 @@ variable "roles" {
}))
default = {}
}
+
+variable "name_scheme" {
+ description = <