Skip to main content
Sponsor @cloudposse

Module: redshift-cluster

This is terraform-example-module project provides all the scaffolding for a typical well-built Cloud Posse module. It's a template repository you can use when creating new repositories.

Usage​

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

module "vpc" {
  source = "cloudposse/vpc/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  ipv4_primary_cidr_block = "172.19.0.0/16"

  context = module.this.context
}

module "subnet" {
  source = "cloudposse/dynamic-subnets/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  availability_zones   = var.availability_zones
  vpc_id               = module.vpc.vpc_id
  igw_id               = [module.vpc.igw_id]
  ipv4_cidr_block      = module.vpc.vpc_cidr_block
  nat_gateway_enabled  = false
  nat_instance_enabled = false

  context = module.this.context
}

module "security_group" {
  source = "cloudposse/security-group/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  vpc_id = module.vpc.vpc_id

  rules = [
    {
      type        = "ingress"
      from_port   = var.port
      to_port     = var.port
      protocol    = "all"
      cidr_blocks = ["0.0.0.0/0"]
    },
    {
      type        = "egress"
      from_port   = 0
      to_port     = 0
      protocol    = "all"
      cidr_blocks = ["0.0.0.0/0"]
    }
  ]

  context = module.this.context
}

module "redshift_cluster" {
  source = "cloudposse/redshift-cluster/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  subnet_ids          = module.subnet.private_subnet_ids
  vpc_security_groups = [module.vpc.vpc_default_security_group_id, module.security_group.id]

  admin_user            = var.admin_user
  admin_password        = var.admin_password
  database_name         = var.database_name
  node_type             = var.node_type
  cluster_type          = var.cluster_type
  engine_version        = var.engine_version
  publicly_accessible   = var.publicly_accessible
  allow_version_upgrade = var.allow_version_upgrade

  context = module.this.context
}

Examples​

Here is an example of using this module:

Variables​

Required Variables​

subnet_ids (list(string)) required

List of VPC subnet IDs

Optional Variables​

admin_password (string) optional

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


Default value: ""

admin_user (string) optional

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


Default value: "admin"

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"

database_name (string) optional

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


Default value: "dev"

elastic_ip (string) optional

The Elastic IP (EIP) address for the cluster


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_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

owner_account (string) optional

The AWS customer account used to create or copy the snapshot. Required if you are restoring a snapshot you do not own, optional if you own the snapshot


Default value: null

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

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

vpc_security_group_ids (list(string)) optional

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster. Used for EC2-VPC platform


Default value: [ ]

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 to be associated with this cluster

cluster_revision_number

The specific revision number of the database in the cluster

cluster_subnet_group_name

The name of a cluster subnet group to be associated with this cluster

cluster_type

The cluster type

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

node_type

The type of nodes in the cluster

port

The Port the cluster responds on

redshift_parameter_group_arn

Amazon Resource Name (ARN) of the Redshift parameter group

redshift_parameter_group_id

The Redshift parameter group ID

redshift_subnet_group_arn

Amazon Resource Name (ARN) of the Redshift Subnet group name

redshift_subnet_group_id

The Redshift Subnet group ID

vpc_security_group_ids

The VPC security group IDs associated with the cluster

Dependencies​

Requirements​

  • terraform, version: >= 0.14
  • aws, version: >= 5.0

Providers​

  • aws, version: >= 5.0

Modules​

NameVersionSourceDescription
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: