Cluster

Provides a Redshift Cluster Resource.

Note: All arguments including the username and password will be stored in the raw state as plain-text.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var @default = new Aws.RedShift.Cluster("default", new Aws.RedShift.ClusterArgs
        {
            ClusterIdentifier = "tf-redshift-cluster",
            ClusterType = "single-node",
            DatabaseName = "mydb",
            MasterPassword = "Mustbe8characters",
            MasterUsername = "foo",
            NodeType = "dc1.large",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/redshift"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := redshift.NewCluster(ctx, "_default", &redshift.ClusterArgs{
            ClusterIdentifier: pulumi.String("tf-redshift-cluster"),
            ClusterType:       pulumi.String("single-node"),
            DatabaseName:      pulumi.String("mydb"),
            MasterPassword:    pulumi.String("Mustbe8characters"),
            MasterUsername:    pulumi.String("foo"),
            NodeType:          pulumi.String("dc1.large"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

default = aws.redshift.Cluster("default",
    cluster_identifier="tf-redshift-cluster",
    cluster_type="single-node",
    database_name="mydb",
    master_password="Mustbe8characters",
    master_username="foo",
    node_type="dc1.large")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const defaultCluster = new aws.redshift.Cluster("default", {
    clusterIdentifier: "tf-redshift-cluster",
    clusterType: "single-node",
    databaseName: "mydb",
    masterPassword: "Mustbe8characters",
    masterUsername: "foo",
    nodeType: "dc1.large",
});

Create a Cluster Resource

new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);

def Cluster(resource_name, opts=None, allow_version_upgrade=None, automated_snapshot_retention_period=None, availability_zone=None, cluster_identifier=None, cluster_parameter_group_name=None, cluster_public_key=None, cluster_revision_number=None, cluster_security_groups=None, cluster_subnet_group_name=None, cluster_type=None, cluster_version=None, database_name=None, elastic_ip=None, encrypted=None, endpoint=None, enhanced_vpc_routing=None, final_snapshot_identifier=None, iam_roles=None, kms_key_id=None, logging=None, master_password=None, master_username=None, node_type=None, number_of_nodes=None, owner_account=None, port=None, preferred_maintenance_window=None, publicly_accessible=None, skip_final_snapshot=None, snapshot_cluster_identifier=None, snapshot_copy=None, snapshot_identifier=None, tags=None, vpc_security_group_ids=None, __props__=None);

func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)

public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Cluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Cluster resource accepts the following input properties:

ClusterIdentifier string: The Cluster Identifier. Must be a lower case string.
NodeType string: The node type to be provisioned for the cluster.
AllowVersionUpgrade bool: If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default is true
AutomatedSnapshotRetentionPeriod int: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.
AvailabilityZone string: The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
ClusterParameterGroupName string: The name of the parameter group to be associated with this cluster.
ClusterPublicKey string: The public key for the cluster
ClusterRevisionNumber string: The specific revision number of the database in the cluster
ClusterSecurityGroups List<string>: A list of security groups to be associated with this cluster.
ClusterSubnetGroupName string: The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
ClusterType string: The cluster type to use. Either single-node or multi-node.
ClusterVersion string: The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster.
DatabaseName string: The name of the first database to be created when the cluster is created. If you do not provide a name, Amazon Redshift will create a default database called dev.
ElasticIp string: The Elastic IP (EIP) address for the cluster.
Encrypted bool: If true , the data in the cluster is encrypted at rest.
Endpoint string: The connection endpoint
EnhancedVpcRouting bool: If true , enhanced VPC routing is enabled.
FinalSnapshotIdentifier string: 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.
IamRoles List<string>: A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.
KmsKeyId string: The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
Logging ClusterLoggingArgs: Logging, documented below.
MasterPassword string: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 chars and contain at least one uppercase letter, one lowercase letter, and one number.
MasterUsername string: Username for the master DB user.
NumberOfNodes int: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
OwnerAccount string: 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.
Port int: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is 5439.
PreferredMaintenanceWindow string: The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
PubliclyAccessible bool: If true, the cluster can be accessed from a public network. Default is true.
SkipFinalSnapshot bool: Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is false.
SnapshotClusterIdentifier string: The name of the cluster the source snapshot was created from.
SnapshotCopy ClusterSnapshotCopyArgs: Configuration of automatic copy of snapshots from one region to another. Documented below.
SnapshotIdentifier string: The name of the snapshot from which to create the new cluster.
Tags Dictionary<string, string>: A map of tags to assign to the resource.
VpcSecurityGroupIds List<string>: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

ClusterIdentifier string: The Cluster Identifier. Must be a lower case string.
NodeType string: The node type to be provisioned for the cluster.
AllowVersionUpgrade bool: If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default is true
AutomatedSnapshotRetentionPeriod int: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.
AvailabilityZone string: The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
ClusterParameterGroupName string: The name of the parameter group to be associated with this cluster.
ClusterPublicKey string: The public key for the cluster
ClusterRevisionNumber string: The specific revision number of the database in the cluster
ClusterSecurityGroups []string: A list of security groups to be associated with this cluster.
ClusterSubnetGroupName string: The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
ClusterType string: The cluster type to use. Either single-node or multi-node.
ClusterVersion string: The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster.
DatabaseName string: The name of the first database to be created when the cluster is created. If you do not provide a name, Amazon Redshift will create a default database called dev.
ElasticIp string: The Elastic IP (EIP) address for the cluster.
Encrypted bool: If true , the data in the cluster is encrypted at rest.
Endpoint string: The connection endpoint
EnhancedVpcRouting bool: If true , enhanced VPC routing is enabled.
FinalSnapshotIdentifier string: 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.
IamRoles []string: A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.
KmsKeyId string: The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
Logging ClusterLogging: Logging, documented below.
MasterPassword string: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 chars and contain at least one uppercase letter, one lowercase letter, and one number.
MasterUsername string: Username for the master DB user.
NumberOfNodes int: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
OwnerAccount string: 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.
Port int: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is 5439.
PreferredMaintenanceWindow string: The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
PubliclyAccessible bool: If true, the cluster can be accessed from a public network. Default is true.
SkipFinalSnapshot bool: Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is false.
SnapshotClusterIdentifier string: The name of the cluster the source snapshot was created from.
SnapshotCopy ClusterSnapshotCopy: Configuration of automatic copy of snapshots from one region to another. Documented below.
SnapshotIdentifier string: The name of the snapshot from which to create the new cluster.
Tags map[string]string: A map of tags to assign to the resource.
VpcSecurityGroupIds []string: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

clusterIdentifier string: The Cluster Identifier. Must be a lower case string.
nodeType string: The node type to be provisioned for the cluster.
allowVersionUpgrade boolean: If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default is true
automatedSnapshotRetentionPeriod number: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.
availabilityZone string: The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
clusterParameterGroupName string: The name of the parameter group to be associated with this cluster.
clusterPublicKey string: The public key for the cluster
clusterRevisionNumber string: The specific revision number of the database in the cluster
clusterSecurityGroups string[]: A list of security groups to be associated with this cluster.
clusterSubnetGroupName string: The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
clusterType string: The cluster type to use. Either single-node or multi-node.
clusterVersion string: The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster.
databaseName string: The name of the first database to be created when the cluster is created. If you do not provide a name, Amazon Redshift will create a default database called dev.
elasticIp string: The Elastic IP (EIP) address for the cluster.
encrypted boolean: If true , the data in the cluster is encrypted at rest.
endpoint string: The connection endpoint
enhancedVpcRouting boolean: If true , enhanced VPC routing is enabled.
finalSnapshotIdentifier string: 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.
iamRoles string[]: A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.
kmsKeyId string: The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
logging ClusterLogging: Logging, documented below.
masterPassword string: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 chars and contain at least one uppercase letter, one lowercase letter, and one number.
masterUsername string: Username for the master DB user.
numberOfNodes number: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
ownerAccount string: 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.
port number: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is 5439.
preferredMaintenanceWindow string: The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
publiclyAccessible boolean: If true, the cluster can be accessed from a public network. Default is true.
skipFinalSnapshot boolean: Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is false.
snapshotClusterIdentifier string: The name of the cluster the source snapshot was created from.
snapshotCopy ClusterSnapshotCopy: Configuration of automatic copy of snapshots from one region to another. Documented below.
snapshotIdentifier string: The name of the snapshot from which to create the new cluster.
tags {[key: string]: string}: A map of tags to assign to the resource.
vpcSecurityGroupIds string[]: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

cluster_identifier str: The Cluster Identifier. Must be a lower case string.
node_type str: The node type to be provisioned for the cluster.
allow_version_upgrade bool: If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default is true
automated_snapshot_retention_period float: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.
availability_zone str: The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
cluster_parameter_group_name str: The name of the parameter group to be associated with this cluster.
cluster_public_key str: The public key for the cluster
cluster_revision_number str: The specific revision number of the database in the cluster
cluster_security_groups List[str]: A list of security groups to be associated with this cluster.
cluster_subnet_group_name str: The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
cluster_type str: The cluster type to use. Either single-node or multi-node.
cluster_version str: The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster.
database_name str: The name of the first database to be created when the cluster is created. If you do not provide a name, Amazon Redshift will create a default database called dev.
elastic_ip str: The Elastic IP (EIP) address for the cluster.
encrypted bool: If true , the data in the cluster is encrypted at rest.
endpoint str: The connection endpoint
enhanced_vpc_routing bool: If true , enhanced VPC routing is enabled.
final_snapshot_identifier str: 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.
iam_roles List[str]: A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.
kms_key_id str: The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
logging Dict[ClusterLogging]: Logging, documented below.
master_password str: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 chars and contain at least one uppercase letter, one lowercase letter, and one number.
master_username str: Username for the master DB user.
number_of_nodes float: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
owner_account str: 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.
port float: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is 5439.
preferred_maintenance_window str: The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
publicly_accessible bool: If true, the cluster can be accessed from a public network. Default is true.
skip_final_snapshot bool: Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is false.
snapshot_cluster_identifier str: The name of the cluster the source snapshot was created from.
snapshot_copy Dict[ClusterSnapshotCopy]: Configuration of automatic copy of snapshots from one region to another. Documented below.
snapshot_identifier str: The name of the snapshot from which to create the new cluster.
tags Dict[str, str]: A map of tags to assign to the resource.
vpc_security_group_ids List[str]: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Outputs

All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

Arn string: Amazon Resource Name (ARN) of cluster
DnsName string: The DNS name of the cluster
Id string: The provider-assigned unique ID for this managed resource.

Arn string: Amazon Resource Name (ARN) of cluster
DnsName string: The DNS name of the cluster
Id string: The provider-assigned unique ID for this managed resource.

arn string: Amazon Resource Name (ARN) of cluster
dnsName string: The DNS name of the cluster
id string: The provider-assigned unique ID for this managed resource.

arn str: Amazon Resource Name (ARN) of cluster
dns_name str: The DNS name of the cluster
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Cluster Resource

Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster

static get(resource_name, id, opts=None, allow_version_upgrade=None, arn=None, automated_snapshot_retention_period=None, availability_zone=None, cluster_identifier=None, cluster_parameter_group_name=None, cluster_public_key=None, cluster_revision_number=None, cluster_security_groups=None, cluster_subnet_group_name=None, cluster_type=None, cluster_version=None, database_name=None, dns_name=None, elastic_ip=None, encrypted=None, endpoint=None, enhanced_vpc_routing=None, final_snapshot_identifier=None, iam_roles=None, kms_key_id=None, logging=None, master_password=None, master_username=None, node_type=None, number_of_nodes=None, owner_account=None, port=None, preferred_maintenance_window=None, publicly_accessible=None, skip_final_snapshot=None, snapshot_cluster_identifier=None, snapshot_copy=None, snapshot_identifier=None, tags=None, vpc_security_group_ids=None, __props__=None);

func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)

public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AllowVersionUpgrade bool: If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default is true
Arn string: Amazon Resource Name (ARN) of cluster
AutomatedSnapshotRetentionPeriod int: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.
AvailabilityZone string: The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
ClusterIdentifier string: The Cluster Identifier. Must be a lower case string.
ClusterParameterGroupName string: The name of the parameter group to be associated with this cluster.
ClusterPublicKey string: The public key for the cluster
ClusterRevisionNumber string: The specific revision number of the database in the cluster
ClusterSecurityGroups List<string>: A list of security groups to be associated with this cluster.
ClusterSubnetGroupName string: The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
ClusterType string: The cluster type to use. Either single-node or multi-node.
ClusterVersion string: The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster.
DatabaseName string: The name of the first database to be created when the cluster is created. If you do not provide a name, Amazon Redshift will create a default database called dev.
DnsName string: The DNS name of the cluster
ElasticIp string: The Elastic IP (EIP) address for the cluster.
Encrypted bool: If true , the data in the cluster is encrypted at rest.
Endpoint string: The connection endpoint
EnhancedVpcRouting bool: If true , enhanced VPC routing is enabled.
FinalSnapshotIdentifier string: 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.
IamRoles List<string>: A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.
KmsKeyId string: The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
Logging ClusterLoggingArgs: Logging, documented below.
MasterPassword string: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 chars and contain at least one uppercase letter, one lowercase letter, and one number.
MasterUsername string: Username for the master DB user.
NodeType string: The node type to be provisioned for the cluster.
NumberOfNodes int: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
OwnerAccount string: 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.
Port int: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is 5439.
PreferredMaintenanceWindow string: The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
PubliclyAccessible bool: If true, the cluster can be accessed from a public network. Default is true.
SkipFinalSnapshot bool: Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is false.
SnapshotClusterIdentifier string: The name of the cluster the source snapshot was created from.
SnapshotCopy ClusterSnapshotCopyArgs: Configuration of automatic copy of snapshots from one region to another. Documented below.
SnapshotIdentifier string: The name of the snapshot from which to create the new cluster.
Tags Dictionary<string, string>: A map of tags to assign to the resource.
VpcSecurityGroupIds List<string>: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

AllowVersionUpgrade bool: If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default is true
Arn string: Amazon Resource Name (ARN) of cluster
AutomatedSnapshotRetentionPeriod int: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.
AvailabilityZone string: The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
ClusterIdentifier string: The Cluster Identifier. Must be a lower case string.
ClusterParameterGroupName string: The name of the parameter group to be associated with this cluster.
ClusterPublicKey string: The public key for the cluster
ClusterRevisionNumber string: The specific revision number of the database in the cluster
ClusterSecurityGroups []string: A list of security groups to be associated with this cluster.
ClusterSubnetGroupName string: The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
ClusterType string: The cluster type to use. Either single-node or multi-node.
ClusterVersion string: The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster.
DatabaseName string: The name of the first database to be created when the cluster is created. If you do not provide a name, Amazon Redshift will create a default database called dev.
DnsName string: The DNS name of the cluster
ElasticIp string: The Elastic IP (EIP) address for the cluster.
Encrypted bool: If true , the data in the cluster is encrypted at rest.
Endpoint string: The connection endpoint
EnhancedVpcRouting bool: If true , enhanced VPC routing is enabled.
FinalSnapshotIdentifier string: 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.
IamRoles []string: A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.
KmsKeyId string: The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
Logging ClusterLogging: Logging, documented below.
MasterPassword string: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 chars and contain at least one uppercase letter, one lowercase letter, and one number.
MasterUsername string: Username for the master DB user.
NodeType string: The node type to be provisioned for the cluster.
NumberOfNodes int: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
OwnerAccount string: 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.
Port int: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is 5439.
PreferredMaintenanceWindow string: The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
PubliclyAccessible bool: If true, the cluster can be accessed from a public network. Default is true.
SkipFinalSnapshot bool: Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is false.
SnapshotClusterIdentifier string: The name of the cluster the source snapshot was created from.
SnapshotCopy ClusterSnapshotCopy: Configuration of automatic copy of snapshots from one region to another. Documented below.
SnapshotIdentifier string: The name of the snapshot from which to create the new cluster.
Tags map[string]string: A map of tags to assign to the resource.
VpcSecurityGroupIds []string: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

allowVersionUpgrade boolean: If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default is true
arn string: Amazon Resource Name (ARN) of cluster
automatedSnapshotRetentionPeriod number: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.
availabilityZone string: The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
clusterIdentifier string: The Cluster Identifier. Must be a lower case string.
clusterParameterGroupName string: The name of the parameter group to be associated with this cluster.
clusterPublicKey string: The public key for the cluster
clusterRevisionNumber string: The specific revision number of the database in the cluster
clusterSecurityGroups string[]: A list of security groups to be associated with this cluster.
clusterSubnetGroupName string: The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
clusterType string: The cluster type to use. Either single-node or multi-node.
clusterVersion string: The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster.
databaseName string: The name of the first database to be created when the cluster is created. If you do not provide a name, Amazon Redshift will create a default database called dev.
dnsName string: The DNS name of the cluster
elasticIp string: The Elastic IP (EIP) address for the cluster.
encrypted boolean: If true , the data in the cluster is encrypted at rest.
endpoint string: The connection endpoint
enhancedVpcRouting boolean: If true , enhanced VPC routing is enabled.
finalSnapshotIdentifier string: 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.
iamRoles string[]: A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.
kmsKeyId string: The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
logging ClusterLogging: Logging, documented below.
masterPassword string: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 chars and contain at least one uppercase letter, one lowercase letter, and one number.
masterUsername string: Username for the master DB user.
nodeType string: The node type to be provisioned for the cluster.
numberOfNodes number: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
ownerAccount string: 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.
port number: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is 5439.
preferredMaintenanceWindow string: The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
publiclyAccessible boolean: If true, the cluster can be accessed from a public network. Default is true.
skipFinalSnapshot boolean: Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is false.
snapshotClusterIdentifier string: The name of the cluster the source snapshot was created from.
snapshotCopy ClusterSnapshotCopy: Configuration of automatic copy of snapshots from one region to another. Documented below.
snapshotIdentifier string: The name of the snapshot from which to create the new cluster.
tags {[key: string]: string}: A map of tags to assign to the resource.
vpcSecurityGroupIds string[]: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

allow_version_upgrade bool: If true , major version upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster. Default is true
arn str: Amazon Resource Name (ARN) of cluster
automated_snapshot_retention_period float: The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with create-cluster-snapshot. Default is 1.
availability_zone str: The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency.
cluster_identifier str: The Cluster Identifier. Must be a lower case string.
cluster_parameter_group_name str: The name of the parameter group to be associated with this cluster.
cluster_public_key str: The public key for the cluster
cluster_revision_number str: The specific revision number of the database in the cluster
cluster_security_groups List[str]: A list of security groups to be associated with this cluster.
cluster_subnet_group_name str: The name of a cluster subnet group to be associated with this cluster. If this parameter is not provided the resulting cluster will be deployed outside virtual private cloud (VPC).
cluster_type str: The cluster type to use. Either single-node or multi-node.
cluster_version str: The version of the Amazon Redshift engine software that you want to deploy on the cluster. The version selected runs on all the nodes in the cluster.
database_name str: The name of the first database to be created when the cluster is created. If you do not provide a name, Amazon Redshift will create a default database called dev.
dns_name str: The DNS name of the cluster
elastic_ip str: The Elastic IP (EIP) address for the cluster.
encrypted bool: If true , the data in the cluster is encrypted at rest.
endpoint str: The connection endpoint
enhanced_vpc_routing bool: If true , enhanced VPC routing is enabled.
final_snapshot_identifier str: 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.
iam_roles List[str]: A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.
kms_key_id str: The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
logging Dict[ClusterLogging]: Logging, documented below.
master_password str: Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 chars and contain at least one uppercase letter, one lowercase letter, and one number.
master_username str: Username for the master DB user.
node_type str: The node type to be provisioned for the cluster.
number_of_nodes float: The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
owner_account str: 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.
port float: The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is 5439.
preferred_maintenance_window str: The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
publicly_accessible bool: If true, the cluster can be accessed from a public network. Default is true.
skip_final_snapshot bool: Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default is false.
snapshot_cluster_identifier str: The name of the cluster the source snapshot was created from.
snapshot_copy Dict[ClusterSnapshotCopy]: Configuration of automatic copy of snapshots from one region to another. Documented below.
snapshot_identifier str: The name of the snapshot from which to create the new cluster.
tags Dict[str, str]: A map of tags to assign to the resource.
vpc_security_group_ids List[str]: A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Supporting Types

ClusterLogging

See the input and output API doc for this type.

Enable bool: Enables logging information such as queries and connection attempts, for the specified Amazon Redshift cluster.
BucketName string: 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. For more information on the permissions required for the bucket, please read the AWS documentation
S3KeyPrefix string: The prefix applied to the log file names.

Enable bool: Enables logging information such as queries and connection attempts, for the specified Amazon Redshift cluster.
BucketName string: 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. For more information on the permissions required for the bucket, please read the AWS documentation
S3KeyPrefix string: The prefix applied to the log file names.

enable boolean: Enables logging information such as queries and connection attempts, for the specified Amazon Redshift cluster.
bucketName string: 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. For more information on the permissions required for the bucket, please read the AWS documentation
s3KeyPrefix string: The prefix applied to the log file names.

enable bool: Enables logging information such as queries and connection attempts, for the specified Amazon Redshift cluster.
bucket_name str: 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. For more information on the permissions required for the bucket, please read the AWS documentation
s3_key_prefix str: The prefix applied to the log file names.

ClusterSnapshotCopy

See the input and output API doc for this type.

DestinationRegion string: The destination region that you want to copy snapshots to.
GrantName string: The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
RetentionPeriod int: The number of days to retain automated snapshots in the destination region after they are copied from the source region. Defaults to 7.

DestinationRegion string: The destination region that you want to copy snapshots to.
GrantName string: The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
RetentionPeriod int: The number of days to retain automated snapshots in the destination region after they are copied from the source region. Defaults to 7.

destinationRegion string: The destination region that you want to copy snapshots to.
grantName string: The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
retentionPeriod number: The number of days to retain automated snapshots in the destination region after they are copied from the source region. Defaults to 7.

destinationRegion str: The destination region that you want to copy snapshots to.
grantName str: The name of the snapshot copy grant to use when snapshots of an AWS KMS-encrypted cluster are copied to the destination region.
retention_period float: The number of days to retain automated snapshots in the destination region after they are copied from the source region. Defaults to 7.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud