Component: 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

1. Open the AWS Console for the given stack.

2. Go to AWS Marketplace Subscriptions.

3. Click "Manage Subscriptions", click "Discover products", type "Snowflake" in the search bar.

4. Select "Snowflake Data Cloud"

5. Click "Continue to Subscribe"

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

7. Select "Standard" and the current region. In this example, we chose "US East (Ohio)" which is the same as us-east-1.
8. 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.
9. Check for the Account Activation email. Note, this may be collected in a Slack notifications channel for easy access.
10. Follow the given link to create the Admin user with username admin and a strong password. Be sure to save that password somewhere secure.
11. 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

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

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 3.0
random	>= 2.3
snowflake	>= 0.25
tls	>= 3.0

Providers

Name	Version
aws	>= 3.0
random	>= 2.3
snowflake	>= 0.25
tls	>= 3.0

Modules

Name	Source	Version
account	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
iam_roles	../account-map/modules/iam-roles	n/a
introspection	cloudposse/label/null	0.25.0
snowflake_account	cloudposse/label/null	0.25.0
snowflake_role	cloudposse/label/null	0.25.0
snowflake_warehouse	cloudposse/label/null	0.25.0
ssm_parameters	cloudposse/ssm-parameter-store/aws	0.9.1
this	cloudposse/label/null	0.25.0
utils	cloudposse/utils/aws	0.8.1

Resources

Name	Type
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
aws_ssm_parameter.snowflake_password	data source

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
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
default_warehouse_size	The size for the default Snowflake Warehouse	string	"xsmall"	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
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
global_environment_name	Global environment name	string	"gbl"	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
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
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
privileged	True if the default provider already has access to the backend	bool	false	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
region	AWS Region	string	n/a	yes
required_tags	List of required tag names	list(string)	[]	no
root_account_stage_name	The stage name for the AWS Organization root (master) account	string	"root"	no
service_user_id	The identifier for the service user created to manage infrastructure.	string	"terraform"	no
snowflake_account	The Snowflake account given with the AWS Marketplace Subscription.	string	n/a	yes
snowflake_account_region	AWS Region with the Snowflake subscription	string	n/a	yes
snowflake_admin_username	Snowflake admin username created with the initial account subscription.	string	"admin"	no
snowflake_role_description	Comment to attach to the Snowflake Role.	string	"Terraform service user role."	no
snowflake_username_format	Snowflake username format	string	"%s-%s"	no
ssm_path_snowflake_user_format	SSM parameter path format for a Snowflake user. For example, /snowflake/{{ account }}/users/{{ username }}/	string	"/%s/%s/%s/%s/%s"	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	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
terraform_user_first_name	Snowflake Terraform first name given with User creation	string	"Terrafrom"	no
terraform_user_last_name	Snowflake Terraform last name given with User creation	string	"User"	no

Outputs

Name	Description
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.