Version: Latest

redshift

This component provisions an AWS Redshift cluster and 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

Variables

Required Variables

region (string) required: AWS region

Optional Variables

admin_password (string) optional

Password for the master DB user. Required unless a snapshot_identifier is provided

Default value: null

admin_user (string) optional

Username for the master DB user. Required unless a snapshot_identifier is provided

Default value: null

allow_version_upgrade (bool) optional

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

Default value: false

automated_snapshot_retention_period (number) optional

The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled

Default value: 1

availability_zone (string) optional

Optional parameter to place Amazon Redshift cluster instances in a specific availability zone. If left empty, will place randomly

Default value: null

availability_zone_relocation_enabled (bool) optional

Whether or not the cluster can be relocated to another availability zone, either automatically by AWS or when requested. Available for use on clusters from the RA3 instance family

Default value: false

cluster_identifier (string) optional

The Redshift Cluster Identifier. Must be a lower case string. Will use generated label ID if not supplied

Default value: ""

cluster_parameters optional

List of Redshift parameters to apply

Type:

list(object({
name  = string
value = string
}))

Default value: [ ]

cluster_type (string) optional

The cluster type to use. Either single-node or multi-node

Default value: "single-node"

custom_sg_allow_all_egress (bool) optional

Whether to allow all egress traffic or not

Default value: true

custom_sg_enabled (bool) optional

Whether to use custom security group or not

Default value: false

custom_sg_rules optional

An array of custom security groups to create and assign to the cluster.

Type:

list(object({
key         = string
type        = string
from_port   = number
to_port     = number
protocol    = string
cidr_blocks = list(string)
description = string
}))

Default value: [ ]

database_name (string) optional

The name of the first database to be created when the cluster is created

Default value: null

encrypted (bool) optional

Specifies whether the cluster is encrypted at rest

Default value: false

engine_version (string) optional

The version of the Amazon Redshift engine to use. See https://docs.aws.amazon.com/redshift/latest/mgmt/cluster-versions.html

Default value: "1.0"

enhanced_vpc_routing (bool) optional

If true, enhanced VPC routing is enabled

Default value: false

final_snapshot_identifier (string) optional

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, skip_final_snapshot must be false

Default value: null

iam_roles (list(string)) optional

A list of IAM Role ARNs to associate with the cluster. A maximum of 10 can be associated to the cluster at any time

Default value: [ ]

kms_alias_name_ssm (string) optional

KMS alias name for SSM

Default value: "alias/aws/ssm"

kms_key_arn (string) optional

The ARN for the KMS encryption key. When specifying kms_key_arn, encrypted needs to be set to true

Default value: null

logging_bucket_name (string) optional

The name of an existing S3 bucket where the log files are to be stored. Must be in the same region as the cluster and the cluster must have read bucket and put object permissions

Default value: null

logging_enabled (bool) optional

If true, enables logging information such as queries and connection attempts, for the specified Amazon Redshift cluster

Default value: false

logging_s3_key_prefix (string) optional

The prefix applied to the log file names

Default value: null

node_type (string) optional

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

Default value: "dc2.large"

number_of_nodes (number) optional

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node

Default value: 1

pause_resume_enabled (bool) optional

Whether to create scheduled actions that pause and resume the cluster

Default value: false

pause_resume_schedules optional

Named up-windows for the cluster, each a resume and pause cron pair. A map rather than a
single pair because preferred_maintenance_window must fall inside an up-window, since AWS
cannot maintain a paused cluster. That usually means one window for the workload and a
separate one for maintenance. Cron is UTC, in the Redshift format
cron(Minutes Hours Day-of-month Month Day-of-week Year).

Type:

map(object({
resume_cron = string
pause_cron  = string
}))

Default value: { }

port (number) optional

The port number on which the cluster accepts incoming connections

Default value: 5439

preferred_maintenance_window (string) optional

Weekly time range during which system maintenance can occur, in UTC. Format: ddd:hh24:mi-ddd:hh24:mi

Default value: null

publicly_accessible (bool) optional

If true, the cluster can be accessed from a public network

Default value: false

scheduled_action_iam_role_arn (string) optional

ARN of the IAM role Redshift assumes to run the scheduled actions. Must trust scheduler.redshift.amazonaws.com and allow redshift:PauseCluster and redshift:ResumeCluster

Default value: null

security_group_ids (list(string)) optional

An array of security group IDs to associate with the endpoint.

Default value: null

skip_final_snapshot (bool) optional

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster

Default value: true

snapshot_cluster_identifier (string) optional

The name of the cluster the source snapshot was created from

Default value: null

snapshot_identifier (string) optional

The name of the snapshot from which to create the new cluster

Default value: null

ssm_enabled (bool) optional

If true create SSM keys for the database user and password.

Default value: false

ssm_key_database_name (string) optional

The SSM key to save the database name. See var.ssm_path_format.

Default value: "admin/db_name"

ssm_key_format (string) optional

SSM path format. The values will be used in the following order: var.ssm_key_prefix, var.name, var.ssm_key_*

Default value: "/%v/%v/%v"

ssm_key_hostname (string) optional

The SSM key to save the hostname. See var.ssm_path_format.

Default value: "admin/db_hostname"

ssm_key_password (string) optional

The SSM key to save the password. See var.ssm_path_format.

Default value: "admin/db_password"

ssm_key_port (string) optional

The SSM key to save the port. See var.ssm_path_format.

Default value: "admin/db_port"

ssm_key_prefix (string) optional

SSM path prefix. Omit the leading forward slash /.

Default value: "redshift"

ssm_key_user (string) optional

The SSM key to save the user. See var.ssm_path_format.

Default value: "admin/db_user"

subnet_ids (list(string)) optional

Subnet IDs to place the cluster in. When set, these are used directly and the vpc component is not looked up, which allows the component to be used in stacks that have no CloudPosse managed VPC

Default value: null

use_private_subnets (bool) optional

Whether to use private or public subnets for the Redshift cluster

Default value: true

vpc_component_name (string) optional

VPC component name

Default value: "vpc"

vpc_id (string) optional

VPC the cluster's security group belongs to. Only needed alongside subnet_ids, which bypasses the vpc component lookup, and only when custom_sg_enabled is true. Left null, the ID comes from the vpc component as before

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

arn: Amazon Resource Name (ARN) of cluster
cluster_identifier: The Cluster Identifier
cluster_parameter_group_name: The name of the parameter group associated with the cluster
cluster_revision_number: The Redshift engine revision number the cluster is running
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

Dependencies

Requirements

terraform, version: >= 1.0
aws, version: >= 4.17, < 6.0.0
random, version: >= 3.0

Providers

aws, version: >= 4.17, < 6.0.0
random, version: >= 3.0

Modules

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

Resources

The following resources are used by this module:

aws_redshift_scheduled_action.pause (resource)
aws_redshift_scheduled_action.resume (resource)
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)

Data Sources

The following data sources are used by this module:

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources