Skip to main content

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.


Stack Level: Regional

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

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
- userlog
- connectionlog
- useractivitylog
admin_user: redshift
custom_sg_enabled: true
- type: ingress
key: postgres
description: Allow inbound traffic to the redshift cluster
from_port: 5439
to_port: 5439
protocol: tcp


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


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






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.
admin_passwordPassword for the master DB user. Required unless a snapshot_identifier is providedstringnullno
admin_userUsername for the master DB user. Required unless a snapshot_identifier is providedstringnullno
allow_version_upgradeWhether or not to enable major version upgrades which are applied during the maintenance window to the Amazon Redshift engine that is running on the clusterboolfalseno
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.
cluster_typeThe cluster type to use. Either single-node or multi-nodestring"single-node"no
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
custom_sg_allow_all_egressWhether to allow all egress traffic or notbooltrueno
custom_sg_enabledWhether to use custom security group or notboolfalseno
custom_sg_rulesAn array of custom security groups to create and assign to the cluster.
key = string
type = string
from_port = number
to_port = number
protocol = string
cidr_blocks = list(string)
description = string
database_nameThe name of the first database to be created when the cluster is createdstringnullno
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
engine_versionThe version of the Amazon Redshift engine to use. See"1.0"no
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
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.
kms_alias_name_ssmKMS alias name for SSMstring"alias/aws/ssm"no
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
node_typeThe node type to be provisioned for the cluster. See"dc2.large"no
number_of_nodesThe number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-nodenumber1no
portThe port number on which the cluster accepts incoming connectionsnumber5439no
publicly_accessibleIf true, the cluster can be accessed from a public networkboolfalseno
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
security_group_idsAn array of security group IDs to associate with the endpoint.list(string)nullno
ssm_enabledIf true create SSM keys for the database user and password.boolfalseno
ssm_key_formatSSM path format. The values will will be used in the following order: var.ssm_key_prefix,, var.ssm_key_*string"/%v/%v/%v"no
ssm_key_hostnameThe SSM key to save the hostname. See var.ssm_path_format.string"admin/db_hostname"no
ssm_key_passwordThe SSM key to save the password. See var.ssm_path_format.string"admin/db_password"no
ssm_key_portThe SSM key to save the port. See var.ssm_path_format.string"admin/db_port"no
ssm_key_prefixSSM path prefix. Omit the leading forward slash /.string"redshift"no
ssm_key_userThe SSM key to save the user. See var.ssm_path_format.string"admin/db_user"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
use_private_subnetsWhether to use private or public subnets for the Redshift clusterbooltrueno


arnAmazon Resource Name (ARN) of cluster
cluster_identifierThe Cluster Identifier
cluster_security_groupsThe security groups associated with the cluster
database_nameThe name of the default database in the Cluster
dns_nameThe DNS name of the cluster
endpointThe connection endpoint
idThe Redshift Cluster ID
portThe Port the cluster responds on
redshift_database_ssm_key_prefixSSM prefix
vpc_security_group_idsThe VPC security group IDs associated with the cluster



Components PR Fix components

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


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