Awesome

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 mdev+sbx01@example.com.

  First Name: John
  Last Name: Smith
  Email: aws@example.com
  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+%s@example.com"
        tags:
          Team: data
          Service: snowflake

Requirements

Name	Version
<a name="requirement_terraform"></a> terraform	>= 1.0.0
<a name="requirement_aws"></a> aws	>= 3.0
<a name="requirement_random"></a> random	>= 2.3
<a name="requirement_snowflake"></a> snowflake	>= 0.25
<a name="requirement_tls"></a> tls	>= 3.0

Providers

Name	Version
<a name="provider_aws"></a> aws	>= 3.0
<a name="provider_random"></a> random	>= 2.3
<a name="provider_snowflake"></a> snowflake	>= 0.25
<a name="provider_tls"></a> tls	>= 3.0

Modules

Name	Source	Version
<a name="module_account"></a> account	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
<a name="module_iam_roles"></a> iam_roles	../account-map/modules/iam-roles	n/a
<a name="module_introspection"></a> introspection	cloudposse/label/null	0.25.0
<a name="module_snowflake_account"></a> snowflake_account	cloudposse/label/null	0.25.0
<a name="module_snowflake_role"></a> snowflake_role	cloudposse/label/null	0.25.0
<a name="module_snowflake_warehouse"></a> snowflake_warehouse	cloudposse/label/null	0.25.0
<a name="module_ssm_parameters"></a> ssm_parameters	cloudposse/ssm-parameter-store/aws	0.9.1
<a name="module_this"></a> this	cloudposse/label/null	0.25.0
<a name="module_utils"></a> 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
<a name="input_additional_tag_map"></a> 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
<a name="input_attributes"></a> 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
<a name="input_context"></a> 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
<a name="input_default_warehouse_size"></a> default_warehouse_size	The size for the default Snowflake Warehouse	`string`	`"xsmall"`	no
<a name="input_delimiter"></a> delimiter	Delimiter to be used between ID elements.<br>Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
<a name="input_descriptor_formats"></a> 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
<a name="input_enabled"></a> enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
<a name="input_environment"></a> environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
<a name="input_global_environment_name"></a> global_environment_name	Global environment name	`string`	`"gbl"`	no
<a name="input_id_length_limit"></a> 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
<a name="input_label_key_case"></a> 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
<a name="input_label_order"></a> 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
<a name="input_label_value_case"></a> 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
<a name="input_labels_as_tags"></a> 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
<a name="input_name"></a> 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
<a name="input_namespace"></a> 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
<a name="input_privileged"></a> privileged	True if the default provider already has access to the backend	`bool`	`false`	no
<a name="input_regex_replace_chars"></a> 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
<a name="input_region"></a> region	AWS Region	`string`	n/a	yes
<a name="input_required_tags"></a> required_tags	List of required tag names	`list(string)`	`[]`	no
<a name="input_root_account_stage_name"></a> root_account_stage_name	The stage name for the AWS Organization root (master) account	`string`	`"root"`	no
<a name="input_service_user_id"></a> service_user_id	The identifier for the service user created to manage infrastructure.	`string`	`"terraform"`	no
<a name="input_snowflake_account"></a> snowflake_account	The Snowflake account given with the AWS Marketplace Subscription.	`string`	n/a	yes
<a name="input_snowflake_account_region"></a> snowflake_account_region	AWS Region with the Snowflake subscription	`string`	n/a	yes
<a name="input_snowflake_admin_username"></a> snowflake_admin_username	Snowflake admin username created with the initial account subscription.	`string`	`"admin"`	no
<a name="input_snowflake_role_description"></a> snowflake_role_description	Comment to attach to the Snowflake Role.	`string`	`"Terraform service user role."`	no
<a name="input_snowflake_username_format"></a> snowflake_username_format	Snowflake username format	`string`	`"%s-%s"`	no
<a name="input_ssm_path_snowflake_user_format"></a> 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
<a name="input_stage"></a> stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
<a name="input_tags"></a> 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
<a name="input_tenant"></a> tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	no
<a name="input_terraform_user_first_name"></a> terraform_user_first_name	Snowflake Terraform first name given with User creation	`string`	`"Terrafrom"`	no
<a name="input_terraform_user_last_name"></a> terraform_user_last_name	Snowflake Terraform last name given with User creation	`string`	`"User"`	no

Outputs

Name	Description
<a name="output_snowflake_account"></a> snowflake_account	The Snowflake account ID.
<a name="output_snowflake_region"></a> snowflake_region	The AWS Region with the Snowflake account.
<a name="output_snowflake_terraform_role"></a> snowflake_terraform_role	The name of the role given to the Terraform service user.
<a name="output_ssm_path_terraform_user_name"></a> ssm_path_terraform_user_name	The path to the SSM parameter for the Terraform user name.
<a name="output_ssm_path_terraform_user_private_key"></a> ssm_path_terraform_user_private_key	The path to the SSM parameter for the Terraform user private key.

[!NOTE] This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.
<details><summary>Learn More</summary>
It's 100% Open Source and licensed under the APACHE2.
</details>

Related Projects

Check out these related projects.

Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
Atmos - Atmos is like docker-compose but for your infrastructure

✨ Contributing

This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:

🐛 Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

💻 Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you! Hit us up in Slack, in the #cloudposse channel.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-snowflake-account&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

About

This project is maintained by <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-snowflake-account&utm_content=">Cloud Posse, LLC</a>. <a href="https://cpco.io/homepage?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-snowflake-account&utm_content="><img src="https://cloudposse.com/logo-300x69.svg" align="right" /></a>

We are a DevOps Accelerator for funded startups and enterprises. Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly. We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.

Your team can operate like a pro today.

Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.

<details> <summary>📚 See What's Included</summary>

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Deployment Strategy. You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
Site Reliability Engineering. You'll have total visibility into your apps and microservices.
Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
GitOps. You'll be able to operate your infrastructure via Pull Requests.
Training. You'll receive hands-on training so your team can operate what we build.
Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
Troubleshooting. You'll get help to triage when things aren't working.
Code Reviews. You'll receive constructive feedback on Pull Requests.
Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

</details>

License

<details> <summary>Preamble to the Apache License, Version 2.0</summary>

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

</details>

Trademarks

All other trademarks referenced herein are the property of their respective owners.