snowflake-account

This component sets up the requirements for all other Snowflake components, including creating the Terraform service user. Before running this component, follow the manual, Click-Ops steps below to create a Snowflake subscription.

Deployment Steps

Open the AWS Console for the given stack.
Go to AWS Marketplace Subscriptions.
Click "Manage Subscriptions", click "Discover products", type "Snowflake" in the search bar.
Select "Snowflake Data Cloud"
Click "Continue to Subscribe"
Fill out the information steps using the following as an example. Note, the provided email cannot use labels such as [email protected].

  First Name: John
  Last Name: Smith
  Email: [email protected]
  Company: Example
  Country: United States

Select "Standard" and the current region. In this example, we chose "US East (Ohio)" which is the same as us-east-1.
Continue and wait for Sign Up to complete. Note the Snowflake account ID; you can find this in the newly accessible Snowflake console in the top right of the window.
Check for the Account Activation email. Note, this may be collected in a Slack notifications channel for easy access.
Follow the given link to create the Admin user with username admin and a strong password. Be sure to save that password somewhere secure.
Upload that password to AWS Parameter Store under /snowflake/$ACCOUNT/users/admin/password, where ACCOUNT is the value given during the subscription process. This password will only be used to create a private key, and all other authentication will be done with said key. Below is an example of how to do that with a chamber command:

AWS_PROFILE=$NAMESPACE-$TENANT-gbl-sbx01-admin chamber write /snowflake/$ACCOUNT/users/admin/ admin $PASSWORD

Finally, use atmos to deploy this component:

atmos terraform deploy snowflake/account --stack $TENANT-use2-sbx01

Usage

Stack Level: Regional

Here's an example snippet for how to use this component:

components:
  terraform:
    snowflake-account:
      settings:
        spacelift:
          workspace_enabled: false
      vars:
        enabled: true
        snowflake_account: "AB12345"
        snowflake_account_region: "us-east-2"
        snowflake_user_email_format: "aws.dev+%[email protected]"
        tags:
          Team: data
          Service: snowflake

Variables

Required Variables

region (string) required: AWS Region
snowflake_account (string) required: The Snowflake account given with the AWS Marketplace Subscription.
snowflake_account_region (string) required: AWS Region with the Snowflake subscription

Optional Variables

default_warehouse_size (string) optional

The size for the default Snowflake Warehouse

Default value: "xsmall"

global_environment_name (string) optional

Global environment name

Default value: "gbl"

privileged (bool) optional

True if the default provider already has access to the backend

Default value: false

required_tags (list(string)) optional

List of required tag names

Default value: [ ]

root_account_stage_name (string) optional

The stage name for the AWS Organization root (master) account

Default value: "root"

service_user_id (string) optional

The identifier for the service user created to manage infrastructure.

Default value: "terraform"

snowflake_admin_username (string) optional

Snowflake admin username created with the initial account subscription.

Default value: "admin"

snowflake_role_description (string) optional

Comment to attach to the Snowflake Role.

Default value: "Terraform service user role."

snowflake_username_format (string) optional

Snowflake username format

Default value: "%s-%s"

ssm_path_snowflake_user_format (string) optional

SSM parameter path format for a Snowflake user. For example, /snowflake/{{ account }}/users/{{ username }}/

Default value: "/%s/%s/%s/%s/%s"

terraform_user_first_name (string) optional

Snowflake Terraform first name given with User creation

Default value: "Terrafrom"

terraform_user_last_name (string) optional

Snowflake Terraform last name given with User creation

Default value: "User"

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

snowflake_account: The Snowflake account ID.
snowflake_region: The AWS Region with the Snowflake account.
snowflake_terraform_role: The name of the role given to the Terraform service user.
ssm_path_terraform_user_name: The path to the SSM parameter for the Terraform user name.
ssm_path_terraform_user_private_key: The path to the SSM parameter for the Terraform user private key.

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 3.0
random, version: >= 2.3
snowflake, version: >= 0.25
tls, version: >= 3.0

Providers

aws, version: >= 3.0
random, version: >= 2.3
snowflake, version: >= 0.25
tls, version: >= 3.0

Modules

Name	Version	Source	Description
`account`	1.5.0	`cloudposse/stack-config/yaml//modules/remote-state`	n/a
`iam_roles`	latest	`../account-map/modules/iam-roles`	n/a
`introspection`	0.25.0	`cloudposse/label/null`	introspection module will contain the additional tags
`snowflake_account`	0.25.0	`cloudposse/label/null`	n/a
`snowflake_role`	0.25.0	`cloudposse/label/null`	The identifier must start with an alphabetic character and cannot contain spaces or special characters unless the entire identifier string is enclosed in double quotes (e.g. "My object"). Identifiers enclosed in double quotes are also case-sensitive.
`snowflake_warehouse`	0.25.0	`cloudposse/label/null`	Identifier for the virtual warehouse; must be unique for your account. In addition, the identifier must start with an alphabetic character and cannot contain spaces or special characters unless the entire identifier string is enclosed in double quotes (e.g. "My object" ).
`ssm_parameters`	0.9.1	`cloudposse/ssm-parameter-store/aws`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a
`utils`	0.8.1	`cloudposse/utils/aws`	n/a

Resources

The following resources are used by this module:

random_password.terraform_user_password (resource)
snowflake_role.terraform (resource)
snowflake_role_grants.grant_custom_roles (resource)
snowflake_role_grants.grant_system_roles (resource)
snowflake_user.terraform (resource)
snowflake_warehouse.default (resource)
tls_private_key.terraform_user_key (resource)

Data Sources

The following data sources are used by this module:

aws_ssm_parameter.snowflake_password (data source)

Deployment Steps​

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Deployment Steps

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources