Component: redshift

This component is responsible for provisioning a RedShift instance. It seeds relevant database information (hostnames, username, password, etc.) into AWS SSM Parameter Store.

Usage

Stack Level: Regional

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

components:
  terraform:
    redshift:
      vars:
        enabled: true
        name: redshift
        database_name: redshift
        publicly_accessible: false
        node_type: dc2.large
        number_of_nodes: 1
        cluster_type: single-node
        ssm_enabled: true
        log_exports:
          - userlog
          - connectionlog
          - useractivitylog
        admin_user: redshift
        custom_sg_enabled: true
        custom_sg_rules:
          - type: ingress
            key: postgres
            description: Allow inbound traffic to the redshift cluster
            from_port: 5439
            to_port: 5439
            protocol: tcp
            cidr_blocks:
              - 10.0.0.0/8

Requirements

Name	Version
terraform	>= 1.0
aws	>= 4.17, <=4.67.0
random	>= 3.0

Providers

Name	Version
aws	>= 4.17, <=4.67.0
random	>= 3.0

Modules

Name	Source	Version
iam_roles	../account-map/modules/iam-roles	n/a
redshift_cluster	cloudposse/redshift-cluster/aws	1.0.0
redshift_sg	cloudposse/security-group/aws	2.2.0
this	cloudposse/label/null	0.25.0
vpc	cloudposse/stack-config/yaml//modules/remote-state	1.5.0

Resources

Name	Type
aws_ssm_parameter.redshift_database_hostname	resource
aws_ssm_parameter.redshift_database_name	resource
aws_ssm_parameter.redshift_database_password	resource
aws_ssm_parameter.redshift_database_port	resource
aws_ssm_parameter.redshift_database_user	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
allow_version_upgrade	Whether or not to enable major version upgrades which are applied during the maintenance window to the Amazon Redshift engine that is running on the cluster	bool	false	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
cluster_type	The cluster type to use. Either single-node or multi-node	string	"single-node"	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	An array of custom security groups to create and assign to the cluster.	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
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
engine_version	The version of the Amazon Redshift engine to use. See https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html	string	"1.0"	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
kms_alias_name_ssm	KMS alias name for SSM	string	"alias/aws/ssm"	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
node_type	The node type to be provisioned for the cluster. See https://docs.aws.amazon.com/redshift/latest/mgmt/working-with-clusters.html#working-with-clusters-overview	string	"dc2.large"	no
number_of_nodes	The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node	number	1	no
port	The port number on which the cluster accepts incoming connections	number	5439	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_enabled	If true create SSM keys for the database user and password.	bool	false	no
ssm_key_format	SSM path format. The values will will be used in the following order: var.ssm_key_prefix, var.name, var.ssm_key_*	string	"/%v/%v/%v"	no
ssm_key_hostname	The SSM key to save the hostname. See var.ssm_path_format.	string	"admin/db_hostname"	no
ssm_key_password	The SSM key to save the password. See var.ssm_path_format.	string	"admin/db_password"	no
ssm_key_port	The SSM key to save the port. See var.ssm_path_format.	string	"admin/db_port"	no
ssm_key_prefix	SSM path prefix. Omit the leading forward slash /.	string	"redshift"	no
ssm_key_user	The SSM key to save the user. See var.ssm_path_format.	string	"admin/db_user"	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

Outputs

Name	Description
arn	Amazon Resource Name (ARN) of cluster
cluster_identifier	The Cluster Identifier
cluster_security_groups	The security groups associated with the cluster
database_name	The name of the default database in the Cluster
dns_name	The DNS name of the cluster
endpoint	The connection endpoint
id	The Redshift Cluster ID
port	The Port the cluster responds on
redshift_database_ssm_key_prefix	SSM prefix
vpc_security_group_ids	The VPC security group IDs associated with the cluster

References

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

CHANGELOG

Components PR Fix components

This is a bug fix and feature enhancement update. No actions necessary to upgrade.

Fixes

• Fix bug related to the AWS provider >= 5.0.0 removed redshift_cluster.cluster_security_groups.