Snowflake AWS PrivateLink Terraform Module

We help companies turn their data into assets

---

Terraform module that can create and manage AWS PrivateLink for Snowflake.

This module creates:

• AWS VPC Endpoint
• Security group and assigns it to the endpoint
• AWS Route53 private zone and adds needed records inside

USAGE

module "snowflake_privatelink_aws" {
  source = "../../"

  name       = "snowflake"

  vpc_id     = "vpc-01234567890abcdef
  subnet_ids = ["subnet-01234567890abcdef", "subnet-01234567890abcdeg"]

  tags = {
    "example" = "tag"
  }
}

NOTES

In order to successfully setup a PrivateLink in AWS - manual authorization of PrivateLink requests is needed, more information can be found in Snowflake Documentation - https://docs.snowflake.com/en/user-guide/admin-security-privatelink.html#enabling-aws-privatelink.

EXAMPLES

• Complete example
• Simple example

Inputs

Name	Description	Type	Default	Required
account_name	Name of the Snowflake account, used to create regionless privatelink fqdns	string	null	no
additional_dns_records	List of additional Route53 records to be added to local privatelink.snowflakecomputing.com hosted zone that points to Snowflake VPC endpoint.	list(string)	[]	no
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
allow_vpc_cidr	Whether allow access to the Snowflake PrivateLink endpoint from the whole VPC	bool	true	no
allowed_cidrs	List of subnet CIDRs that will be allowed to access Snowflake endpoint via PrivateLink	list(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
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
descriptor_name	Name of the descriptor used to form a resource name	string	"snowflake-privatelink"	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
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
organisation_name	Name of the organisation, where the Snowflake account is created, used to create regionless privatelink fqdns	string	null	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
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
subnet_ids	List of AWS Subnet IDs where Snowflake AWS PrivateLink Endpoint interfaces will be created	list(string)	n/a	yes
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
vpc_id	VPC ID where the AWS PrivateLink VPC Endpoint will be created	string	n/a	yes

Modules

Name	Source	Version
this	cloudposse/label/null	0.25.0

Outputs

Name	Description
dns_private_zone	Details of Route53 private hosted zone created for Snowflake PrivateLink
security_group	Details of security group assigned to Snowflake AWS PrivateLink VPC Endpoint
snowflake_additional_dns_records	List of additional DNS records added to .privatelink.snowflakecomputing.com hosted zone
snowflake_privatelink_ocsp_url	URL to access Snowflake OCSP endpont using AWS PrivateLink
snowflake_privatelink_url	URL to access Snowflake using AWS PrivateLink
snowflake_regionless_private_link_account_url	URL to access Snowflake account using AWS PrivateLink without specifying AWS region
snowflake_regionless_private_link_snowsight_url	URL to access Snowsight UI using AWS PrivateLink without specifying AWS region
vpc_endpoint	Details created Snowflake AWS PrivateLink VPC Endpoint

Providers

Name	Version
aws	~> 4.0
snowflake	~> 0.47

Requirements

Name	Version
terraform	>= 1.3
aws	~> 4.0
snowflake	~> 0.47

Resources

Name	Type
aws_route53_record.snowflake_additional_dns_records	resource
aws_route53_record.snowflake_private_link_ocsp_url	resource
aws_route53_record.snowflake_private_link_url	resource
aws_route53_record.snowflake_regionless_private_link_account_url	resource
aws_route53_record.snowflake_regionless_private_link_snowsight_url	resource
aws_route53_zone.this	resource
aws_security_group.this	resource
aws_vpc_endpoint.this	resource
aws_vpc.this	data source
snowflake_system_get_privatelink_config.this	data source

CONTRIBUTING

Contributions are very welcomed!

Start by reviewing contribution guide and our code of conduct. After that, start coding and ship your changes by creating a new PR.

LICENSE

Apache 2 Licensed. See LICENSE for full details.

AUTHORS

Made with contrib.rocks.