AWS Classic v5.41.0, May 15 23

aws.redshift.Cluster

Explore with Pulumi AI

Provides a Redshift Cluster Resource.

NOTE: A Redshift cluster’s default IAM role can be managed both by this resource’s default_iam_role_arn argument and the aws.redshift.ClusterIamRoles resource’s default_iam_role_arn argument. Do not configure different values for both arguments. Doing so will cause a conflict of default IAM roles.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.RedShift.Cluster("example", new()
    {
        ClusterIdentifier = "tf-redshift-cluster",
        ClusterType = "single-node",
        DatabaseName = "mydb",
        MasterPassword = "Mustbe8characters",
        MasterUsername = "exampleuser",
        NodeType = "dc1.large",
    });

});

package main

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

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

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.Cluster;
import com.pulumi.aws.redshift.ClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Cluster("example", ClusterArgs.builder()        
            .clusterIdentifier("tf-redshift-cluster")
            .clusterType("single-node")
            .databaseName("mydb")
            .masterPassword("Mustbe8characters")
            .masterUsername("exampleuser")
            .nodeType("dc1.large")
            .build());

    }
}

import pulumi
import pulumi_aws as aws

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

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

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

resources:
  example:
    type: aws:redshift:Cluster
    properties:
      clusterIdentifier: tf-redshift-cluster
      clusterType: single-node
      databaseName: mydb
      masterPassword: Mustbe8characters
      masterUsername: exampleuser
      nodeType: dc1.large

Create Cluster Resource

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

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            allow_version_upgrade: Optional[bool] = None,
            apply_immediately: Optional[bool] = None,
            aqua_configuration_status: Optional[str] = None,
            automated_snapshot_retention_period: Optional[int] = None,
            availability_zone: Optional[str] = None,
            availability_zone_relocation_enabled: Optional[bool] = None,
            cluster_identifier: Optional[str] = None,
            cluster_parameter_group_name: Optional[str] = None,
            cluster_public_key: Optional[str] = None,
            cluster_revision_number: Optional[str] = None,
            cluster_security_groups: Optional[Sequence[str]] = None,
            cluster_subnet_group_name: Optional[str] = None,
            cluster_type: Optional[str] = None,
            cluster_version: Optional[str] = None,
            database_name: Optional[str] = None,
            default_iam_role_arn: Optional[str] = None,
            elastic_ip: Optional[str] = None,
            encrypted: Optional[bool] = None,
            endpoint: Optional[str] = None,
            enhanced_vpc_routing: Optional[bool] = None,
            final_snapshot_identifier: Optional[str] = None,
            iam_roles: Optional[Sequence[str]] = None,
            kms_key_id: Optional[str] = None,
            logging: Optional[ClusterLoggingArgs] = None,
            maintenance_track_name: Optional[str] = None,
            manual_snapshot_retention_period: Optional[int] = None,
            master_password: Optional[str] = None,
            master_username: Optional[str] = None,
            node_type: Optional[str] = None,
            number_of_nodes: Optional[int] = None,
            owner_account: Optional[str] = None,
            port: Optional[int] = None,
            preferred_maintenance_window: Optional[str] = None,
            publicly_accessible: Optional[bool] = None,
            skip_final_snapshot: Optional[bool] = None,
            snapshot_cluster_identifier: Optional[str] = None,
            snapshot_copy: Optional[ClusterSnapshotCopyArgs] = None,
            snapshot_identifier: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            vpc_security_group_ids: Optional[Sequence[str]] = None)
@overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

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

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

public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

type: aws:redshift:Cluster
properties: # The arguments to resource properties.
options: # 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.

resource_name str: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control 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.

name String: The unique name of the resource.
args ClusterArgs: The arguments to resource properties.
options 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 Architecture and Concepts 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.

ApplyImmediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

AquaConfigurationStatus string

The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values are enabled, disabled, and auto. Requires Cluster reboot.

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. Can only be changed if availability_zone_relocation_enabled is true.

AvailabilityZoneRelocationEnabled bool

If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is false. Available for use on clusters from the RA3 instance family.

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.

Deprecated:

With the retirement of EC2-Classic the cluster_security_groups attribute has been deprecated and will be removed in a future version.

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.

DefaultIamRoleArn string

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

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 Pulumi.Aws.RedShift.Inputs.ClusterLoggingArgs

Logging, documented below.

MaintenanceTrackName string

The name of the maintenance track for the restored cluster. When you take a snapshot, the snapshot inherits the MaintenanceTrack value from the cluster. The snapshot might be on a different track than the cluster that was the source for the snapshot. For example, suppose that you take a snapshot of a cluster that is on the current track and then change the cluster to be on the trailing track. In this case, the snapshot and the source cluster are on different tracks. Default value is current.

ManualSnapshotRetentionPeriod int

The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. Valid values are between -1 and 3653. Default value is -1.

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. Valid values are between 1115 and 65535. 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 Pulumi.Aws.RedShift.Inputs.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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

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.

ApplyImmediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

AquaConfigurationStatus string

AutomatedSnapshotRetentionPeriod int

AvailabilityZone string

AvailabilityZoneRelocationEnabled bool

If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is false. Available for use on clusters from the RA3 instance family.

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.

Deprecated:

With the retirement of EC2-Classic the cluster_security_groups attribute has been deprecated and will be removed in a future version.

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.

DefaultIamRoleArn string

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

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 ClusterLoggingArgs

Logging, documented below.

MaintenanceTrackName string

ManualSnapshotRetentionPeriod int

MasterPassword string

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

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

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 map[string]string

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

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.

applyImmediately Boolean

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

aquaConfigurationStatus String

automatedSnapshotRetentionPeriod Integer

availabilityZone String

availabilityZoneRelocationEnabled Boolean

If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is false. Available for use on clusters from the RA3 instance family.

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.

Deprecated:

With the retirement of EC2-Classic the cluster_security_groups attribute has been deprecated and will be removed in a future version.

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.

defaultIamRoleArn String

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

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

maintenanceTrackName String

manualSnapshotRetentionPeriod Integer

masterPassword String

masterUsername String

Username for the master DB user.

numberOfNodes Integer

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 Integer

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

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 Map<String,String>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

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

applyImmediately boolean

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

aquaConfigurationStatus string

automatedSnapshotRetentionPeriod number

availabilityZone string

availabilityZoneRelocationEnabled boolean

If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is false. Available for use on clusters from the RA3 instance family.

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.

Deprecated:

With the retirement of EC2-Classic the cluster_security_groups attribute has been deprecated and will be removed in a future version.

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.

defaultIamRoleArn string

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

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 ClusterLoggingArgs

Logging, documented below.

maintenanceTrackName string

manualSnapshotRetentionPeriod number

masterPassword string

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

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

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 {[key: string]: string}

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

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.

apply_immediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

aqua_configuration_status str

automated_snapshot_retention_period int

availability_zone str

availability_zone_relocation_enabled bool

If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is false. Available for use on clusters from the RA3 instance family.

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 Sequence[str]

A list of security groups to be associated with this cluster.

Deprecated:

With the retirement of EC2-Classic the cluster_security_groups attribute has been deprecated and will be removed in a future version.

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.

default_iam_role_arn str

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

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 Sequence[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 ClusterLoggingArgs

Logging, documented below.

maintenance_track_name str

manual_snapshot_retention_period int

master_password str

master_username str

Username for the master DB user.

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

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 int

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

snapshot_cluster_identifier str

The name of the cluster the source snapshot was created from.

snapshot_copy ClusterSnapshotCopyArgs

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 Mapping[str, str]

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

vpc_security_group_ids Sequence[str]

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.

applyImmediately Boolean

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

aquaConfigurationStatus String

automatedSnapshotRetentionPeriod Number

availabilityZone String

availabilityZoneRelocationEnabled Boolean

If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is false. Available for use on clusters from the RA3 instance family.

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.

Deprecated:

With the retirement of EC2-Classic the cluster_security_groups attribute has been deprecated and will be removed in a future version.

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.

defaultIamRoleArn String

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

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 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 Property Map

Logging, documented below.

maintenanceTrackName String

manualSnapshotRetentionPeriod Number

masterPassword String

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

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

snapshotClusterIdentifier String

The name of the cluster the source snapshot was created from.

snapshotCopy Property Map

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>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

vpcSecurityGroupIds List<String>

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
ClusterNodes List<Pulumi.Aws.RedShift.Outputs.ClusterClusterNode>: The nodes in the cluster. Cluster node blocks are documented below
DnsName string: The DNS name of the cluster
Id string: The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string: Amazon Resource Name (ARN) of cluster
ClusterNodes []ClusterClusterNode: The nodes in the cluster. Cluster node blocks are documented below
DnsName string: The DNS name of the cluster
Id string: The provider-assigned unique ID for this managed resource.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: Amazon Resource Name (ARN) of cluster
clusterNodes List<ClusterClusterNode>: The nodes in the cluster. Cluster node blocks are documented below
dnsName String: The DNS name of the cluster
id String: The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string: Amazon Resource Name (ARN) of cluster
clusterNodes ClusterClusterNode[]: The nodes in the cluster. Cluster node blocks are documented below
dnsName string: The DNS name of the cluster
id string: The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str: Amazon Resource Name (ARN) of cluster
cluster_nodes Sequence[ClusterClusterNode]: The nodes in the cluster. Cluster node blocks are documented below
dns_name str: The DNS name of the cluster
id str: The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: Amazon Resource Name (ARN) of cluster
clusterNodes List<Property Map>: The nodes in the cluster. Cluster node blocks are documented below
dnsName String: The DNS name of the cluster
id String: The provider-assigned unique ID for this managed resource.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up 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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_version_upgrade: Optional[bool] = None,
        apply_immediately: Optional[bool] = None,
        aqua_configuration_status: Optional[str] = None,
        arn: Optional[str] = None,
        automated_snapshot_retention_period: Optional[int] = None,
        availability_zone: Optional[str] = None,
        availability_zone_relocation_enabled: Optional[bool] = None,
        cluster_identifier: Optional[str] = None,
        cluster_nodes: Optional[Sequence[ClusterClusterNodeArgs]] = None,
        cluster_parameter_group_name: Optional[str] = None,
        cluster_public_key: Optional[str] = None,
        cluster_revision_number: Optional[str] = None,
        cluster_security_groups: Optional[Sequence[str]] = None,
        cluster_subnet_group_name: Optional[str] = None,
        cluster_type: Optional[str] = None,
        cluster_version: Optional[str] = None,
        database_name: Optional[str] = None,
        default_iam_role_arn: Optional[str] = None,
        dns_name: Optional[str] = None,
        elastic_ip: Optional[str] = None,
        encrypted: Optional[bool] = None,
        endpoint: Optional[str] = None,
        enhanced_vpc_routing: Optional[bool] = None,
        final_snapshot_identifier: Optional[str] = None,
        iam_roles: Optional[Sequence[str]] = None,
        kms_key_id: Optional[str] = None,
        logging: Optional[ClusterLoggingArgs] = None,
        maintenance_track_name: Optional[str] = None,
        manual_snapshot_retention_period: Optional[int] = None,
        master_password: Optional[str] = None,
        master_username: Optional[str] = None,
        node_type: Optional[str] = None,
        number_of_nodes: Optional[int] = None,
        owner_account: Optional[str] = None,
        port: Optional[int] = None,
        preferred_maintenance_window: Optional[str] = None,
        publicly_accessible: Optional[bool] = None,
        skip_final_snapshot: Optional[bool] = None,
        snapshot_cluster_identifier: Optional[str] = None,
        snapshot_copy: Optional[ClusterSnapshotCopyArgs] = None,
        snapshot_identifier: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_security_group_ids: Optional[Sequence[str]] = None) -> Cluster

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)

public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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.

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.

ApplyImmediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

AquaConfigurationStatus string

Arn string

Amazon Resource Name (ARN) of cluster

AutomatedSnapshotRetentionPeriod int

AvailabilityZone string

AvailabilityZoneRelocationEnabled bool

If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is false. Available for use on clusters from the RA3 instance family.

ClusterIdentifier string

The Cluster Identifier. Must be a lower case string.

ClusterNodes List<Pulumi.Aws.RedShift.Inputs.ClusterClusterNodeArgs>

The nodes in the cluster. Cluster node blocks are documented below

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.

Deprecated:

With the retirement of EC2-Classic the cluster_security_groups attribute has been deprecated and will be removed in a future version.

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.

DefaultIamRoleArn string

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

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 Pulumi.Aws.RedShift.Inputs.ClusterLoggingArgs

Logging, documented below.

MaintenanceTrackName string

ManualSnapshotRetentionPeriod int

MasterPassword string

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

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

SnapshotClusterIdentifier string

The name of the cluster the source snapshot was created from.

SnapshotCopy Pulumi.Aws.RedShift.Inputs.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. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

ApplyImmediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

AquaConfigurationStatus string

Arn string

Amazon Resource Name (ARN) of cluster

AutomatedSnapshotRetentionPeriod int

AvailabilityZone string

AvailabilityZoneRelocationEnabled bool

If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is false. Available for use on clusters from the RA3 instance family.

ClusterIdentifier string

The Cluster Identifier. Must be a lower case string.

ClusterNodes []ClusterClusterNodeArgs

The nodes in the cluster. Cluster node blocks are documented below

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.

Deprecated:

With the retirement of EC2-Classic the cluster_security_groups attribute has been deprecated and will be removed in a future version.

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.

DefaultIamRoleArn string

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

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 ClusterLoggingArgs

Logging, documented below.

MaintenanceTrackName string

ManualSnapshotRetentionPeriod int

MasterPassword string

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

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

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 map[string]string

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

applyImmediately Boolean

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

aquaConfigurationStatus String

arn String

Amazon Resource Name (ARN) of cluster

automatedSnapshotRetentionPeriod Integer

availabilityZone String

availabilityZoneRelocationEnabled Boolean

If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is false. Available for use on clusters from the RA3 instance family.

clusterIdentifier String

The Cluster Identifier. Must be a lower case string.

clusterNodes List<ClusterClusterNodeArgs>

The nodes in the cluster. Cluster node blocks are documented below

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.

Deprecated:

With the retirement of EC2-Classic the cluster_security_groups attribute has been deprecated and will be removed in a future version.

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.

defaultIamRoleArn String

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

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

maintenanceTrackName String

manualSnapshotRetentionPeriod Integer

masterPassword String

masterUsername String

Username for the master DB user.

nodeType String

The node type to be provisioned for the cluster.

numberOfNodes Integer

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 Integer

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

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 Map<String,String>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

vpcSecurityGroupIds List<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.

applyImmediately boolean

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

aquaConfigurationStatus string

arn string

Amazon Resource Name (ARN) of cluster

automatedSnapshotRetentionPeriod number

availabilityZone string

availabilityZoneRelocationEnabled boolean

If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is false. Available for use on clusters from the RA3 instance family.

clusterIdentifier string

The Cluster Identifier. Must be a lower case string.

clusterNodes ClusterClusterNodeArgs[]

The nodes in the cluster. Cluster node blocks are documented below

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.

Deprecated:

With the retirement of EC2-Classic the cluster_security_groups attribute has been deprecated and will be removed in a future version.

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.

defaultIamRoleArn string

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

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 ClusterLoggingArgs

Logging, documented below.

maintenanceTrackName string

manualSnapshotRetentionPeriod number

masterPassword string

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

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

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 {[key: string]: string}

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

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.

apply_immediately bool

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

aqua_configuration_status str

arn str

Amazon Resource Name (ARN) of cluster

automated_snapshot_retention_period int

availability_zone str

availability_zone_relocation_enabled bool

If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is false. Available for use on clusters from the RA3 instance family.

cluster_identifier str

The Cluster Identifier. Must be a lower case string.

cluster_nodes Sequence[ClusterClusterNodeArgs]

The nodes in the cluster. Cluster node blocks are documented below

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 Sequence[str]

A list of security groups to be associated with this cluster.

Deprecated:

With the retirement of EC2-Classic the cluster_security_groups attribute has been deprecated and will be removed in a future version.

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.

default_iam_role_arn str

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

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 Sequence[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 ClusterLoggingArgs

Logging, documented below.

maintenance_track_name str

manual_snapshot_retention_period int

master_password str

master_username str

Username for the master DB user.

node_type str

The node type to be provisioned for the cluster.

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

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 int

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

snapshot_cluster_identifier str

The name of the cluster the source snapshot was created from.

snapshot_copy ClusterSnapshotCopyArgs

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 Mapping[str, str]

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

vpc_security_group_ids Sequence[str]

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.

applyImmediately Boolean

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.

aquaConfigurationStatus String

arn String

Amazon Resource Name (ARN) of cluster

automatedSnapshotRetentionPeriod Number

availabilityZone String

availabilityZoneRelocationEnabled Boolean

If true, the cluster can be relocated to another availabity zone, either automatically by AWS or when requested. Default is false. Available for use on clusters from the RA3 instance family.

clusterIdentifier String

The Cluster Identifier. Must be a lower case string.

clusterNodes List<Property Map>

The nodes in the cluster. Cluster node blocks are documented below

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.

Deprecated:

With the retirement of EC2-Classic the cluster_security_groups attribute has been deprecated and will be removed in a future version.

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.

defaultIamRoleArn String

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

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 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 Property Map

Logging, documented below.

maintenanceTrackName String

manualSnapshotRetentionPeriod Number

masterPassword String

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

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

snapshotClusterIdentifier String

The name of the cluster the source snapshot was created from.

snapshotCopy Property Map

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>

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

vpcSecurityGroupIds List<String>

A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

Supporting Types

ClusterClusterNode

NodeRole string: Whether the node is a leader node or a compute node
PrivateIpAddress string: The private IP address of a node within a cluster
PublicIpAddress string: The public IP address of a node within a cluster

NodeRole string: Whether the node is a leader node or a compute node
PrivateIpAddress string: The private IP address of a node within a cluster
PublicIpAddress string: The public IP address of a node within a cluster

nodeRole String: Whether the node is a leader node or a compute node
privateIpAddress String: The private IP address of a node within a cluster
publicIpAddress String: The public IP address of a node within a cluster

nodeRole string: Whether the node is a leader node or a compute node
privateIpAddress string: The private IP address of a node within a cluster
publicIpAddress string: The public IP address of a node within a cluster

node_role str: Whether the node is a leader node or a compute node
private_ip_address str: The private IP address of a node within a cluster
public_ip_address str: The public IP address of a node within a cluster

nodeRole String: Whether the node is a leader node or a compute node
privateIpAddress String: The private IP address of a node within a cluster
publicIpAddress String: The public IP address of a node within a cluster

ClusterLogging

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
LogDestinationType string: The log destination type. An enum with possible values of s3 and cloudwatch.
LogExports List<string>: The collection of exported log types. Log types include the connection log, user log and user activity log. Required when log_destination_type is cloudwatch. Valid log types are connectionlog, userlog, and useractivitylog.
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
LogDestinationType string: The log destination type. An enum with possible values of s3 and cloudwatch.
LogExports []string: The collection of exported log types. Log types include the connection log, user log and user activity log. Required when log_destination_type is cloudwatch. Valid log types are connectionlog, userlog, and useractivitylog.
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
logDestinationType String: The log destination type. An enum with possible values of s3 and cloudwatch.
logExports List<String>: The collection of exported log types. Log types include the connection log, user log and user activity log. Required when log_destination_type is cloudwatch. Valid log types are connectionlog, userlog, and useractivitylog.
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
logDestinationType string: The log destination type. An enum with possible values of s3 and cloudwatch.
logExports string[]: The collection of exported log types. Log types include the connection log, user log and user activity log. Required when log_destination_type is cloudwatch. Valid log types are connectionlog, userlog, and useractivitylog.
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
log_destination_type str: The log destination type. An enum with possible values of s3 and cloudwatch.
log_exports Sequence[str]: The collection of exported log types. Log types include the connection log, user log and user activity log. Required when log_destination_type is cloudwatch. Valid log types are connectionlog, userlog, and useractivitylog.
s3_key_prefix str: 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
logDestinationType String: The log destination type. An enum with possible values of s3 and cloudwatch.
logExports List<String>: The collection of exported log types. Log types include the connection log, user log and user activity log. Required when log_destination_type is cloudwatch. Valid log types are connectionlog, userlog, and useractivitylog.
s3KeyPrefix String: The prefix applied to the log file names.

ClusterSnapshotCopy

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 Integer: 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.

destination_region str: The destination region that you want to copy snapshots to.
grant_name 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 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.

Import

Redshift Clusters can be imported using the cluster_identifier, e.g.,

 $ pulumi import aws:redshift/cluster:Cluster myprodcluster tf-redshift-cluster-12345

Package Details

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

aws.redshift.Cluster

Example Usage

Create Cluster Resource

Cluster Resource Properties

Inputs

Outputs

Look up Existing Cluster Resource

Supporting Types

ClusterClusterNode

ClusterLogging

ClusterSnapshotCopy

Import

Package Details

On this page