diff --git a/README.md b/README.md index 660ff5e..980bd67 100644 --- a/README.md +++ b/README.md @@ -91,66 +91,66 @@ Additionally, due to breaking changes introduced in `snowflake` terraform provid ## Inputs -| Name | Description | Type | Default | Required | -| ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | :------: | -| [context\_templates](#input\_context\_templates) | Map of context templates used for naming conventions - this variable supersedes `naming_scheme.properties` and `naming_scheme.delimiter` configuration | `map(string)` | `{}` | no | -| [create\_default\_roles](#input\_create\_default\_roles) | Whether the default roles should be created | `bool` | `false` | no | -| [credit\_quota](#input\_credit\_quota) | The number of credits allocated monthly to the resource monitor. | `number` | `null` | no | -| [end\_timestamp](#input\_end\_timestamp) | The date and time when the resource monitor suspends the assigned warehouses. | `string` | `null` | no | -| [frequency](#input\_frequency) | The frequency interval at which the credit usage resets to 0. If you set a frequency for a resource monitor, you must also set START\_TIMESTAMP. | `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-resource-monitor")
    replace_chars_regex   = optional(string, "[^a-zA-Z0-9_]")
    extra_values          = optional(map(string))
  })
| `{}` | no | -| [notify\_triggers](#input\_notify\_triggers) | A list of percentage thresholds at which to send an alert to subscribed users. | `list(number)` | `null` | no | -| [notify\_users](#input\_notify\_users) | Specifies the list of users to receive email notifications on resource monitors. | `list(string)` | `null` | no | -| [roles](#input\_roles) | Roles created on the Resource Monitor 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))
    resource_monitor_grants = optional(object({
      all_privileges    = optional(bool)
      with_grant_option = optional(bool, false)
      privileges        = optional(list(string))
    }))
  }))
| `{}` | no | -| [start\_timestamp](#input\_start\_timestamp) | The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. | `string` | `null` | no | -| [suspend\_immediate\_trigger](#input\_suspend\_immediate\_trigger) | The number that represents the percentage threshold at which to immediately suspend all warehouses. | `number` | `null` | no | -| [suspend\_trigger](#input\_suspend\_trigger) | The number that represents the percentage threshold at which to suspend all warehouses. | `number` | `null` | no | +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [context\_templates](#input\_context\_templates) | Map of context templates used for naming conventions - this variable supersedes `naming_scheme.properties` and `naming_scheme.delimiter` configuration | `map(string)` | `{}` | no | +| [create\_default\_roles](#input\_create\_default\_roles) | Whether the default roles should be created | `bool` | `false` | no | +| [credit\_quota](#input\_credit\_quota) | The number of credits allocated monthly to the resource monitor. | `number` | `null` | no | +| [end\_timestamp](#input\_end\_timestamp) | The date and time when the resource monitor suspends the assigned warehouses. | `string` | `null` | no | +| [frequency](#input\_frequency) | The frequency interval at which the credit usage resets to 0. If you set a frequency for a resource monitor, you must also set START\_TIMESTAMP. | `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-resource-monitor")
    replace_chars_regex   = optional(string, "[^a-zA-Z0-9_]")
    extra_values          = optional(map(string))
  })
| `{}` | no | +| [notify\_triggers](#input\_notify\_triggers) | A list of percentage thresholds at which to send an alert to subscribed users. | `list(number)` | `null` | no | +| [notify\_users](#input\_notify\_users) | Specifies the list of users to receive email notifications on resource monitors. | `list(string)` | `null` | no | +| [roles](#input\_roles) | Roles created on the Resource Monitor 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))
    resource_monitor_grants = optional(object({
      all_privileges    = optional(bool)
      with_grant_option = optional(bool, false)
      privileges        = optional(list(string))
    }))
  }))
| `{}` | no | +| [start\_timestamp](#input\_start\_timestamp) | The date and time when the resource monitor starts monitoring credit usage for the assigned warehouses. | `string` | `null` | no | +| [suspend\_immediate\_trigger](#input\_suspend\_immediate\_trigger) | The number that represents the percentage threshold at which to immediately suspend all warehouses. | `number` | `null` | no | +| [suspend\_trigger](#input\_suspend\_trigger) | The number that represents the percentage threshold at which to suspend all warehouses. | `number` | `null` | no | ## Modules -| Name | Source | Version | -| ---------------------------------------------------------------------------------------------------------- | ---------------------------- | ------- | -| [roles\_deep\_merge](#module\_roles\_deep\_merge) | Invicton-Labs/deepmerge/null | 0.1.5 | -| [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 | +| Name | Source | Version | +|------|--------|---------| +| [roles\_deep\_merge](#module\_roles\_deep\_merge) | Invicton-Labs/deepmerge/null | 0.1.5 | +| [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 -| Name | Description | -| ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | -| [credit\_quota](#output\_credit\_quota) | he number of credits allocated monthly to the resource monitor | -| [end\_timestamp](#output\_end\_timestamp) | The date and time when the resource monitor suspends the assigned warehouses | -| [frequency](#output\_frequency) | The frequency interval at which the credit usage resets to 0 | -| [name](#output\_name) | Name of resource monitor | -| [notify\_triggers](#output\_notify\_triggers) | A list of percentage thresholds at which to send an alert to subscribed users | -| [notify\_users](#output\_notify\_users) | A list of users to receive email notifications on resource monitors | -| [roles](#output\_roles) | Access roles created for resource monitor | -| [start\_timestamp](#output\_start\_timestamp) | The date and time when the resource monitor starts monitoring credit usage | +| Name | Description | +|------|-------------| +| [credit\_quota](#output\_credit\_quota) | he number of credits allocated monthly to the resource monitor | +| [end\_timestamp](#output\_end\_timestamp) | The date and time when the resource monitor suspends the assigned warehouses | +| [frequency](#output\_frequency) | The frequency interval at which the credit usage resets to 0 | +| [name](#output\_name) | Name of resource monitor | +| [notify\_triggers](#output\_notify\_triggers) | A list of percentage thresholds at which to send an alert to subscribed users | +| [notify\_users](#output\_notify\_users) | A list of users to receive email notifications on resource monitors | +| [roles](#output\_roles) | Access roles created for resource monitor | +| [start\_timestamp](#output\_start\_timestamp) | The date and time when the resource monitor starts monitoring credit usage | | [suspend\_immediate\_triggers](#output\_suspend\_immediate\_triggers) | A list of percentage thresholds at which to immediately suspend all warehouses | -| [suspend\_triggers](#output\_suspend\_triggers) | A list of percentage thresholds at which to suspend all warehouses | +| [suspend\_triggers](#output\_suspend\_triggers) | A list of percentage thresholds at which to suspend all warehouses | ## Providers -| Name | Version | -| ------------------------------------------------------------------- | ------- | -| [context](#provider\_context) | >=0.4.0 | +| Name | Version | +|------|---------| +| [context](#provider\_context) | >=0.4.0 | | [snowflake](#provider\_snowflake) | >= 0.96 | ## Requirements -| Name | Version | -| ------------------------------------------------------------------------- | ------- | -| [terraform](#requirement\_terraform) | >= 1.3 | -| [context](#requirement\_context) | >=0.4.0 | +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 1.3 | +| [context](#requirement\_context) | >=0.4.0 | | [snowflake](#requirement\_snowflake) | >= 0.96 | ## Resources -| Name | Type | -| ------------------------------------------------------------------------------------------------------------------------------------------ | ----------- | -| [snowflake_resource_monitor.this](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/resource_monitor) | resource | -| [context_label.this](https://registry.terraform.io/providers/cloudposse/context/latest/docs/data-sources/label) | data source | +| Name | Type | +|------|------| +| [snowflake_resource_monitor.this](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/resource_monitor) | resource | +| [context_label.this](https://registry.terraform.io/providers/cloudposse/context/latest/docs/data-sources/label) | data source | ## CONTRIBUTING