Skip to main content

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
  1. Select "Standard" and the current region. In this example, we chose "US East (Ohio)" which is the same as us-east-1.
  2. 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.
  3. Check for the Account Activation email. Note, this may be collected in a Slack notifications channel for easy access.
  4. Follow the given link to create the Admin user with username admin and a strong password. Be sure to save that password somewhere secure.
  5. 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
  1. Finally, use atmos to deploy this component:
atmos terraform deploy snowflake/account --stack $TENANT-use2-sbx01


Stack Level: Regional

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

workspace_enabled: false
enabled: true
snowflake_account: "AB12345"
snowflake_account_region: "us-east-2"
snowflake_user_email_format: "[email protected]"
Team: data
Service: snowflake


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


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




aws_ssm_parameter.snowflake_passworddata source


additional_tag_mapAdditional 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.
attributesID 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.
contextSingle 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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
default_warehouse_sizeThe size for the default Snowflake Warehousestring"xsmall"no
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe 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).
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
global_environment_nameGlobal environment namestring"gbl"no
id_length_limitLimit 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.
label_key_caseControls 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.
label_orderThe 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.
label_value_caseControls 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.
labels_as_tagsSet 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.
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.
nameID 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.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
privilegedTrue if the default provider already has access to the backendboolfalseno
regex_replace_charsTerraform 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.
regionAWS Regionstringn/ayes
required_tagsList of required tag nameslist(string)[]no
root_account_stage_nameThe stage name for the AWS Organization root (master) accountstring"root"no
service_user_idThe identifier for the service user created to manage infrastructure.string"terraform"no
snowflake_accountThe Snowflake account given with the AWS Marketplace Subscription.stringn/ayes
snowflake_account_regionAWS Region with the Snowflake subscriptionstringn/ayes
snowflake_admin_usernameSnowflake admin username created with the initial account subscription.string"admin"no
snowflake_role_descriptionComment to attach to the Snowflake Role.string"Terraform service user role."no
snowflake_username_formatSnowflake username formatstring"%s-%s"no
ssm_path_snowflake_user_formatSSM parameter path format for a Snowflake user. For example, /snowflake/{{ account }}/users/{{ username }}/string"/%s/%s/%s/%s/%s"no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
terraform_user_first_nameSnowflake Terraform first name given with User creationstring"Terrafrom"no
terraform_user_last_nameSnowflake Terraform last name given with User creationstring"User"no


snowflake_accountThe Snowflake account ID.
snowflake_regionThe AWS Region with the Snowflake account.
snowflake_terraform_roleThe name of the role given to the Terraform service user.
ssm_path_terraform_user_nameThe path to the SSM parameter for the Terraform user name.
ssm_path_terraform_user_private_keyThe path to the SSM parameter for the Terraform user private key.