|
1 | 1 | # Complete Example |
2 | 2 |
|
3 | | -```terraform |
4 | | -module "terraform_snowflake_user" { |
5 | | - source = "../../" |
6 | | - context = module.this.context |
7 | | - name = "snowflake-user" |
8 | | -} |
9 | | -``` |
| 3 | +This is complete usage example of `snowflake-user` terraform module. |
10 | 4 |
|
11 | 5 | ## Usage |
| 6 | +Populate `.env` file with Snowflake credentials and make sure it's sourced to your shell. |
| 7 | + |
| 8 | +## How to plan |
| 9 | + |
| 10 | +```shell |
| 11 | +terraform init |
| 12 | +terraform plan -var-file=fixtures.tfvars |
12 | 13 | ``` |
| 14 | + |
| 15 | +## How to apply |
| 16 | + |
| 17 | +```shell |
13 | 18 | terraform init |
14 | | -terraform plan -var-file fixtures.tfvars -out tfplan |
15 | | -terraform apply tfplan |
| 19 | +terraform apply -var-file=fixtures.tfvars |
16 | 20 | ``` |
| 21 | + |
| 22 | +## How to destroy |
| 23 | + |
| 24 | +```shell |
| 25 | +terraform destroy -var-file=fixtures.tfvars |
| 26 | +``` |
| 27 | + |
| 28 | + |
| 29 | +<!-- BEGIN_TF_DOCS --> |
| 30 | + |
| 31 | + |
| 32 | + |
| 33 | + |
| 34 | +## Inputs |
| 35 | + |
| 36 | +| Name | Description | Type | Default | Required | |
| 37 | +|------|-------------|------|---------|:--------:| |
| 38 | +| <a name="input_additional_tag_map"></a> [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`.<br>This is for some rare cases where resources want additional configuration of tags<br>and therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no | |
| 39 | +| <a name="input_attributes"></a> [attributes](#input\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,<br>in the order they appear in the list. New attributes are appended to the<br>end of the list. The elements of the list are joined by the `delimiter`<br>and treated as a single ID element. | `list(string)` | `[]` | no | |
| 40 | +| <a name="input_context"></a> [context](#input\_context) | Single object for setting entire context at once.<br>See description of individual variables for details.<br>Leave string and numeric variables as `null` to use default value.<br>Individual variable settings (non-null) override settings in context object,<br>except for attributes, tags, and additional\_tag\_map, which are merged. | `any` | <pre>{<br> "additional_tag_map": {},<br> "attributes": [],<br> "delimiter": null,<br> "descriptor_formats": {},<br> "enabled": true,<br> "environment": null,<br> "id_length_limit": null,<br> "label_key_case": null,<br> "label_order": [],<br> "label_value_case": null,<br> "labels_as_tags": [<br> "unset"<br> ],<br> "name": null,<br> "namespace": null,<br> "regex_replace_chars": null,<br> "stage": null,<br> "tags": {},<br> "tenant": null<br>}</pre> | no | |
| 41 | +| <a name="input_delimiter"></a> [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no | |
| 42 | +| <a name="input_descriptor_formats"></a> [descriptor\_formats](#input\_descriptor\_formats) | Describe additional descriptors to be output in the `descriptors` output map.<br>Map of maps. Keys are names of descriptors. Values are maps of the form<br>`{<br> format = string<br> labels = list(string)<br>}`<br>(Type is `any` so the map values can later be enhanced to provide additional options.)<br>`format` is a Terraform format string to be passed to the `format()` function.<br>`labels` is a list of labels, in order, to pass to `format()` function.<br>Label values will be normalized before being passed to `format()` so they will be<br>identical to how they appear in `id`.<br>Default is `{}` (`descriptors` output will be empty). | `any` | `{}` | no | |
| 43 | +| <a name="input_enabled"></a> [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no | |
| 44 | +| <a name="input_environment"></a> [environment](#input\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no | |
| 45 | +| <a name="input_id_length_limit"></a> [id\_length\_limit](#input\_id\_length\_limit) | Limit `id` to this many characters (minimum 6).<br>Set to `0` for unlimited length.<br>Set to `null` for keep the existing setting, which defaults to `0`.<br>Does not affect `id_full`. | `number` | `null` | no | |
| 46 | +| <a name="input_label_key_case"></a> [label\_key\_case](#input\_label\_key\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.<br>Does not affect keys of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper`.<br>Default value: `title`. | `string` | `null` | no | |
| 47 | +| <a name="input_label_order"></a> [label\_order](#input\_label\_order) | The order in which the labels (ID elements) appear in the `id`.<br>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present. | `list(string)` | `null` | no | |
| 48 | +| <a name="input_label_value_case"></a> [label\_value\_case](#input\_label\_value\_case) | Controls the letter case of ID elements (labels) as included in `id`,<br>set as tag values, and output by this module individually.<br>Does not affect values of tags passed in via the `tags` input.<br>Possible values: `lower`, `title`, `upper` and `none` (no transformation).<br>Set this to `title` and set `delimiter` to `""` to yield Pascal Case IDs.<br>Default value: `lower`. | `string` | `null` | no | |
| 49 | +| <a name="input_labels_as_tags"></a> [labels\_as\_tags](#input\_labels\_as\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.<br>Default is to include all labels.<br>Tags with empty values will not be included in the `tags` output.<br>Set to `[]` to suppress all generated tags.<br>**Notes:**<br> The value of the `name` tag, if included, will be the `id`, not the `name`.<br> Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be<br> changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | <pre>[<br> "default"<br>]</pre> | no | |
| 50 | +| <a name="input_name"></a> [name](#input\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br>This is the only ID element not also included as a `tag`.<br>The "name" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no | |
| 51 | +| <a name="input_namespace"></a> [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 | |
| 52 | +| <a name="input_regex_replace_chars"></a> [regex\_replace\_chars](#input\_regex\_replace\_chars) | Terraform regular expression (regex) string.<br>Characters matching the regex will be removed from the ID elements.<br>If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no | |
| 53 | +| <a name="input_stage"></a> [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no | |
| 54 | +| <a name="input_tags"></a> [tags](#input\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).<br>Neither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no | |
| 55 | +| <a name="input_tenant"></a> [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 | |
| 56 | + |
| 57 | +## Modules |
| 58 | + |
| 59 | +| Name | Source | Version | |
| 60 | +|------|--------|---------| |
| 61 | +| <a name="module_terraform_snowflake_user_1"></a> [terraform\_snowflake\_user\_1](#module\_terraform\_snowflake\_user\_1) | ../../ | n/a | |
| 62 | +| <a name="module_terraform_snowflake_user_2"></a> [terraform\_snowflake\_user\_2](#module\_terraform\_snowflake\_user\_2) | ../../ | n/a | |
| 63 | +| <a name="module_this"></a> [this](#module\_this) | cloudposse/label/null | 0.25.0 | |
| 64 | + |
| 65 | +## Outputs |
| 66 | + |
| 67 | +| Name | Description | |
| 68 | +|------|-------------| |
| 69 | +| <a name="output_user_module_outputs_1"></a> [user\_module\_outputs\_1](#output\_user\_module\_outputs\_1) | All user module outputs | |
| 70 | +| <a name="output_user_module_outputs_2"></a> [user\_module\_outputs\_2](#output\_user\_module\_outputs\_2) | All user module outputs | |
| 71 | + |
| 72 | +## Providers |
| 73 | + |
| 74 | +| Name | Version | |
| 75 | +|------|---------| |
| 76 | +| <a name="provider_snowflake"></a> [snowflake](#provider\_snowflake) | ~> 0.94 | |
| 77 | + |
| 78 | +## Requirements |
| 79 | + |
| 80 | +| Name | Version | |
| 81 | +|------|---------| |
| 82 | +| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3 | |
| 83 | +| <a name="requirement_snowflake"></a> [snowflake](#requirement\_snowflake) | ~> 0.94 | |
| 84 | + |
| 85 | +## Resources |
| 86 | + |
| 87 | +| Name | Type | |
| 88 | +|------|------| |
| 89 | +| [snowflake_account_role.user_role](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/resources/account_role) | resource | |
| 90 | +<!-- END_TF_DOCS --> |
0 commit comments