This component is responsible for provisioning Redshift clusters.

Usage

Stack Level: Regional

Here are some example snippets for how to use this component:

components:
  terraform:
    redshift:
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        name: redshift
        admin_user: admin
        database_name: dev

Requirements

Name	Version
terraform	>= 1.0.0
aws	>= 4.0
random	>= 3.0

Providers

Name	Version
aws	>= 4.0
random	>= 3.0

Modules

Name	Source	Version
iam_roles	../account-map/modules/iam-roles	n/a
redshift_sg	cloudposse/security-group/aws	2.0.0-rc1
this	cloudposse/label/null	0.25.0
vpc	cloudposse/stack-config/yaml//modules/remote-state	1.4.1

Resources

Name	Type
aws_redshiftserverless_endpoint_access.default	resource
aws_redshiftserverless_namespace.default	resource
aws_redshiftserverless_workgroup.default	resource
aws_ssm_parameter.admin_password	resource
aws_ssm_parameter.admin_user	resource
aws_ssm_parameter.endpoint	resource
random_password.admin_password	resource
random_pet.admin_user	resource

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
admin_password	Password for the master DB user. Required unless a snapshot_identifier is provided	string	null	no
admin_user	Username for the master DB user. Required unless a snapshot_identifier is provided	string	null	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
base_capacity	The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).	number	128	no
config_parameter	A list of Redshift config parameters to apply to the workgroup.	list(object({ parameter_key = string parameter_value = any }))	[]	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
custom_sg_allow_all_egress	Whether to allow all egress traffic or not	bool	true	no
custom_sg_enabled	Whether to use custom security group or not	bool	false	no
custom_sg_rules	Custom security group rules	list(object({ key = string type = string from_port = number to_port = number protocol = string cidr_blocks = list(string) description = string }))	[]	no
database_name	The name of the first database to be created when the cluster is created	string	null	no
default_iam_role_arn	The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace	string	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
enabled	Set to false to prevent the module from creating any resources	bool	null	no
endpoint_name	Endpoint name for the redshift endpoint, if null, is set to $stage-$name	string	null	no
enhanced_vpc_routing	The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.	bool	true	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
iam_roles	A list of IAM roles to associate with the namespace.	list(string)	[]	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
import_profile_name	AWS Profile name to use when importing a resource	string	null	no
import_role_arn	IAM Role ARN to use when importing a resource	string	null	no
kms_alias_name_ssm	KMS alias name for SSM	string	"alias/aws/ssm"	no
kms_key_id	The ARN of the Amazon Web Services Key Management Service key used to encrypt your data.	string	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
log_exports	The types of logs the namespace can export. Available export types are userlog, connectionlog, and useractivitylog.	set(string)	[]	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
publicly_accessible	If true, the cluster can be accessed from a public network	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
security_group_ids	An array of security group IDs to associate with the endpoint.	list(string)	null	no
ssm_path_prefix	SSM path prefix (without leading or trailing slash)	string	"redshift"	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
use_private_subnets	Whether to use private or public subnets for the Redshift cluster	bool	true	no
vpc_security_group_ids	An array of security group IDs to associate with the workgroup.	list(string)	null	no

Outputs

Name	Description
endpoint_address	The DNS address of the VPC endpoint.
endpoint_arn	Amazon Resource Name (ARN) of the Redshift Serverless Endpoint Access.
endpoint_id	The Redshift Endpoint Access Name.
endpoint_name	Endpoint Name.
endpoint_port	The port that Amazon Redshift Serverless listens on.
endpoint_subnet_ids	Subnets used in redshift serverless endpoint.
endpoint_vpc_endpoint	The VPC endpoint or the Redshift Serverless workgroup. See VPC Endpoint below.
namespace_arn	Amazon Resource Name (ARN) of the Redshift Serverless Namespace.
namespace_id	The Redshift Namespace Name.
namespace_namespace_id	The Redshift Namespace ID.
workgroup_arn	Amazon Resource Name (ARN) of the Redshift Serverless Workgroup.
workgroup_endpoint	The Redshift Serverless Endpoint.
workgroup_id	The Redshift Workgroup Name.
workgroup_workgroup_id	The Redshift Workgroup ID.

References

• cloudposse/terraform-aws-components - Cloud Posse's upstream component

---

Note

This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.

Learn More

It's 100% Open Source and licensed under the APACHE2.

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.

1. Review our Code of Conduct and Contributor Guidelines.
2. Fork the repo on GitHub
3. Clone the project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your fork
6. 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

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 Cloud Posse, LLC.

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.

📚 See What's Included

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

License

Preamble to the Apache License, Version 2.0

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.

Trademarks

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

Copyright © 2017-2024 Cloud Posse, LLC