Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. redshift
  5. Cluster
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.redshift.Cluster

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    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

    Basic Usage

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

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

    import pulumi
import pulumi_aws as aws

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

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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"),
			DatabaseName:      pulumi.String("mydb"),
			MasterUsername:    pulumi.String("exampleuser"),
			MasterPassword:    pulumi.String("Mustbe8characters"),
			NodeType:          pulumi.String("dc1.large"),
			ClusterType:       pulumi.String("single-node"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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",
        DatabaseName = "mydb",
        MasterUsername = "exampleuser",
        MasterPassword = "Mustbe8characters",
        NodeType = "dc1.large",
        ClusterType = "single-node",
    });

});

    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")
            .databaseName("mydb")
            .masterUsername("exampleuser")
            .masterPassword("Mustbe8characters")
            .nodeType("dc1.large")
            .clusterType("single-node")
            .build());

    }
}

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

    With Managed Credentials

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

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

    import pulumi
import pulumi_aws as aws

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

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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"),
			DatabaseName:         pulumi.String("mydb"),
			MasterUsername:       pulumi.String("exampleuser"),
			NodeType:             pulumi.String("dc1.large"),
			ClusterType:          pulumi.String("single-node"),
			ManageMasterPassword: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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",
        DatabaseName = "mydb",
        MasterUsername = "exampleuser",
        NodeType = "dc1.large",
        ClusterType = "single-node",
        ManageMasterPassword = true,
    });

});

    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")
            .databaseName("mydb")
            .masterUsername("exampleuser")
            .nodeType("dc1.large")
            .clusterType("single-node")
            .manageMasterPassword(true)
            .build());

    }
}

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

    Create Cluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
def Cluster(resource_name: str,
            args: ClusterArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            cluster_identifier: Optional[str] = None,
            node_type: Optional[str] = None,
            cluster_subnet_group_name: Optional[str] = None,
            cluster_revision_number: Optional[str] = None,
            availability_zone: Optional[str] = None,
            logging: Optional[ClusterLoggingArgs] = None,
            aqua_configuration_status: Optional[str] = None,
            manage_master_password: Optional[bool] = None,
            cluster_public_key: Optional[str] = None,
            maintenance_track_name: Optional[str] = None,
            allow_version_upgrade: Optional[bool] = 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,
            availability_zone_relocation_enabled: Optional[bool] = None,
            automated_snapshot_retention_period: Optional[int] = None,
            cluster_parameter_group_name: Optional[str] = None,
            manual_snapshot_retention_period: Optional[int] = None,
            master_password: Optional[str] = None,
            master_password_secret_kms_key_id: Optional[str] = None,
            master_username: Optional[str] = None,
            multi_az: Optional[bool] = None,
            apply_immediately: Optional[bool] = 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_arn: Optional[str] = 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)
    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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleclusterResourceResourceFromRedshiftcluster = new Aws.RedShift.Cluster("exampleclusterResourceResourceFromRedshiftcluster", new()
{
    ClusterIdentifier = "string",
    NodeType = "string",
    ClusterSubnetGroupName = "string",
    ClusterRevisionNumber = "string",
    AvailabilityZone = "string",
    ManageMasterPassword = false,
    ClusterPublicKey = "string",
    MaintenanceTrackName = "string",
    AllowVersionUpgrade = false,
    ClusterType = "string",
    ClusterVersion = "string",
    DatabaseName = "string",
    DefaultIamRoleArn = "string",
    ElasticIp = "string",
    Encrypted = false,
    Endpoint = "string",
    EnhancedVpcRouting = false,
    FinalSnapshotIdentifier = "string",
    IamRoles = new[]
    {
        "string",
    },
    KmsKeyId = "string",
    AvailabilityZoneRelocationEnabled = false,
    AutomatedSnapshotRetentionPeriod = 0,
    ClusterParameterGroupName = "string",
    ManualSnapshotRetentionPeriod = 0,
    MasterPassword = "string",
    MasterPasswordSecretKmsKeyId = "string",
    MasterUsername = "string",
    MultiAz = false,
    ApplyImmediately = false,
    NumberOfNodes = 0,
    OwnerAccount = "string",
    Port = 0,
    PreferredMaintenanceWindow = "string",
    PubliclyAccessible = false,
    SkipFinalSnapshot = false,
    SnapshotArn = "string",
    SnapshotClusterIdentifier = "string",
    SnapshotIdentifier = "string",
    Tags = 
    {
        { "string", "string" },
    },
    VpcSecurityGroupIds = new[]
    {
        "string",
    },
});

    example, err := redshift.NewCluster(ctx, "exampleclusterResourceResourceFromRedshiftcluster", &redshift.ClusterArgs{
	ClusterIdentifier:       pulumi.String("string"),
	NodeType:                pulumi.String("string"),
	ClusterSubnetGroupName:  pulumi.String("string"),
	ClusterRevisionNumber:   pulumi.String("string"),
	AvailabilityZone:        pulumi.String("string"),
	ManageMasterPassword:    pulumi.Bool(false),
	ClusterPublicKey:        pulumi.String("string"),
	MaintenanceTrackName:    pulumi.String("string"),
	AllowVersionUpgrade:     pulumi.Bool(false),
	ClusterType:             pulumi.String("string"),
	ClusterVersion:          pulumi.String("string"),
	DatabaseName:            pulumi.String("string"),
	DefaultIamRoleArn:       pulumi.String("string"),
	ElasticIp:               pulumi.String("string"),
	Encrypted:               pulumi.Bool(false),
	Endpoint:                pulumi.String("string"),
	EnhancedVpcRouting:      pulumi.Bool(false),
	FinalSnapshotIdentifier: pulumi.String("string"),
	IamRoles: pulumi.StringArray{
		pulumi.String("string"),
	},
	KmsKeyId:                          pulumi.String("string"),
	AvailabilityZoneRelocationEnabled: pulumi.Bool(false),
	AutomatedSnapshotRetentionPeriod:  pulumi.Int(0),
	ClusterParameterGroupName:         pulumi.String("string"),
	ManualSnapshotRetentionPeriod:     pulumi.Int(0),
	MasterPassword:                    pulumi.String("string"),
	MasterPasswordSecretKmsKeyId:      pulumi.String("string"),
	MasterUsername:                    pulumi.String("string"),
	MultiAz:                           pulumi.Bool(false),
	ApplyImmediately:                  pulumi.Bool(false),
	NumberOfNodes:                     pulumi.Int(0),
	OwnerAccount:                      pulumi.String("string"),
	Port:                              pulumi.Int(0),
	PreferredMaintenanceWindow:        pulumi.String("string"),
	PubliclyAccessible:                pulumi.Bool(false),
	SkipFinalSnapshot:                 pulumi.Bool(false),
	SnapshotArn:                       pulumi.String("string"),
	SnapshotClusterIdentifier:         pulumi.String("string"),
	SnapshotIdentifier:                pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	VpcSecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var exampleclusterResourceResourceFromRedshiftcluster = new Cluster("exampleclusterResourceResourceFromRedshiftcluster", ClusterArgs.builder()
    .clusterIdentifier("string")
    .nodeType("string")
    .clusterSubnetGroupName("string")
    .clusterRevisionNumber("string")
    .availabilityZone("string")
    .manageMasterPassword(false)
    .clusterPublicKey("string")
    .maintenanceTrackName("string")
    .allowVersionUpgrade(false)
    .clusterType("string")
    .clusterVersion("string")
    .databaseName("string")
    .defaultIamRoleArn("string")
    .elasticIp("string")
    .encrypted(false)
    .endpoint("string")
    .enhancedVpcRouting(false)
    .finalSnapshotIdentifier("string")
    .iamRoles("string")
    .kmsKeyId("string")
    .availabilityZoneRelocationEnabled(false)
    .automatedSnapshotRetentionPeriod(0)
    .clusterParameterGroupName("string")
    .manualSnapshotRetentionPeriod(0)
    .masterPassword("string")
    .masterPasswordSecretKmsKeyId("string")
    .masterUsername("string")
    .multiAz(false)
    .applyImmediately(false)
    .numberOfNodes(0)
    .ownerAccount("string")
    .port(0)
    .preferredMaintenanceWindow("string")
    .publiclyAccessible(false)
    .skipFinalSnapshot(false)
    .snapshotArn("string")
    .snapshotClusterIdentifier("string")
    .snapshotIdentifier("string")
    .tags(Map.of("string", "string"))
    .vpcSecurityGroupIds("string")
    .build());

    examplecluster_resource_resource_from_redshiftcluster = aws.redshift.Cluster("exampleclusterResourceResourceFromRedshiftcluster",
    cluster_identifier="string",
    node_type="string",
    cluster_subnet_group_name="string",
    cluster_revision_number="string",
    availability_zone="string",
    manage_master_password=False,
    cluster_public_key="string",
    maintenance_track_name="string",
    allow_version_upgrade=False,
    cluster_type="string",
    cluster_version="string",
    database_name="string",
    default_iam_role_arn="string",
    elastic_ip="string",
    encrypted=False,
    endpoint="string",
    enhanced_vpc_routing=False,
    final_snapshot_identifier="string",
    iam_roles=["string"],
    kms_key_id="string",
    availability_zone_relocation_enabled=False,
    automated_snapshot_retention_period=0,
    cluster_parameter_group_name="string",
    manual_snapshot_retention_period=0,
    master_password="string",
    master_password_secret_kms_key_id="string",
    master_username="string",
    multi_az=False,
    apply_immediately=False,
    number_of_nodes=0,
    owner_account="string",
    port=0,
    preferred_maintenance_window="string",
    publicly_accessible=False,
    skip_final_snapshot=False,
    snapshot_arn="string",
    snapshot_cluster_identifier="string",
    snapshot_identifier="string",
    tags={
        "string": "string",
    },
    vpc_security_group_ids=["string"])

    const exampleclusterResourceResourceFromRedshiftcluster = new aws.redshift.Cluster("exampleclusterResourceResourceFromRedshiftcluster", {
    clusterIdentifier: "string",
    nodeType: "string",
    clusterSubnetGroupName: "string",
    clusterRevisionNumber: "string",
    availabilityZone: "string",
    manageMasterPassword: false,
    clusterPublicKey: "string",
    maintenanceTrackName: "string",
    allowVersionUpgrade: false,
    clusterType: "string",
    clusterVersion: "string",
    databaseName: "string",
    defaultIamRoleArn: "string",
    elasticIp: "string",
    encrypted: false,
    endpoint: "string",
    enhancedVpcRouting: false,
    finalSnapshotIdentifier: "string",
    iamRoles: ["string"],
    kmsKeyId: "string",
    availabilityZoneRelocationEnabled: false,
    automatedSnapshotRetentionPeriod: 0,
    clusterParameterGroupName: "string",
    manualSnapshotRetentionPeriod: 0,
    masterPassword: "string",
    masterPasswordSecretKmsKeyId: "string",
    masterUsername: "string",
    multiAz: false,
    applyImmediately: false,
    numberOfNodes: 0,
    ownerAccount: "string",
    port: 0,
    preferredMaintenanceWindow: "string",
    publiclyAccessible: false,
    skipFinalSnapshot: false,
    snapshotArn: "string",
    snapshotClusterIdentifier: "string",
    snapshotIdentifier: "string",
    tags: {
        string: "string",
    },
    vpcSecurityGroupIds: ["string"],
});

    type: aws:redshift:Cluster
properties:
    allowVersionUpgrade: false
    applyImmediately: false
    automatedSnapshotRetentionPeriod: 0
    availabilityZone: string
    availabilityZoneRelocationEnabled: false
    clusterIdentifier: string
    clusterParameterGroupName: string
    clusterPublicKey: string
    clusterRevisionNumber: string
    clusterSubnetGroupName: string
    clusterType: string
    clusterVersion: string
    databaseName: string
    defaultIamRoleArn: string
    elasticIp: string
    encrypted: false
    endpoint: string
    enhancedVpcRouting: false
    finalSnapshotIdentifier: string
    iamRoles:
        - string
    kmsKeyId: string
    maintenanceTrackName: string
    manageMasterPassword: false
    manualSnapshotRetentionPeriod: 0
    masterPassword: string
    masterPasswordSecretKmsKeyId: string
    masterUsername: string
    multiAz: false
    nodeType: string
    numberOfNodes: 0
    ownerAccount: string
    port: 0
    preferredMaintenanceWindow: string
    publiclyAccessible: false
    skipFinalSnapshot: false
    snapshotArn: string
    snapshotClusterIdentifier: string
    snapshotIdentifier: string
    tags:
        string: string
    vpcSecurityGroupIds:
        - string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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. No longer supported by the AWS API. Always returns auto.

    Deprecated: This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.

    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
    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 ClusterLogging
    Logging, documented below.

    Deprecated: Use the aws.redshift.Logging resource instead. This argument will be removed in a future major version.

    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.
    ManageMasterPassword bool
    Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided.
    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. Conflicts with manage_master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.
    MasterPasswordSecretKmsKeyId string
    ID of the KMS key used to encrypt the cluster admin credentials secret.
    MasterUsername string
    Username for the master DB user.
    MultiAz bool
    Specifies if the Redshift cluster is multi-AZ.
    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.
    SnapshotArn string
    The ARN of the snapshot from which to create the new cluster. Conflicts with snapshot_identifier.
    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.

    Deprecated: Use the aws.redshift.SnapshotCopy resource instead. This argument will be removed in a future major version.

    SnapshotIdentifier string
    The name of the snapshot from which to create the new cluster. Conflicts with snapshot_arn.
    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
    The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. No longer supported by the AWS API. Always returns auto.

    Deprecated: This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.

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

    Deprecated: Use the aws.redshift.Logging resource instead. This argument will be removed in a future major version.

    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.
    ManageMasterPassword bool
    Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided.
    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. Conflicts with manage_master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.
    MasterPasswordSecretKmsKeyId string
    ID of the KMS key used to encrypt the cluster admin credentials secret.
    MasterUsername string
    Username for the master DB user.
    MultiAz bool
    Specifies if the Redshift cluster is multi-AZ.
    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.
    SnapshotArn string
    The ARN of the snapshot from which to create the new cluster. Conflicts with snapshot_identifier.
    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.

    Deprecated: Use the aws.redshift.SnapshotCopy resource instead. This argument will be removed in a future major version.

    SnapshotIdentifier string
    The name of the snapshot from which to create the new cluster. Conflicts with snapshot_arn.
    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
    The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. No longer supported by the AWS API. Always returns auto.

    Deprecated: This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.

    automatedSnapshotRetentionPeriod Integer
    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 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
    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 ClusterLogging
    Logging, documented below.

    Deprecated: Use the aws.redshift.Logging resource instead. This argument will be removed in a future major version.

    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.
    manageMasterPassword Boolean
    Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided.
    manualSnapshotRetentionPeriod Integer
    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. Conflicts with manage_master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.
    masterPasswordSecretKmsKeyId String
    ID of the KMS key used to encrypt the cluster admin credentials secret.
    masterUsername String
    Username for the master DB user.
    multiAz Boolean
    Specifies if the Redshift cluster is multi-AZ.
    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
    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 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.
    snapshotArn String
    The ARN of the snapshot from which to create the new cluster. Conflicts with snapshot_identifier.
    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.

    Deprecated: Use the aws.redshift.SnapshotCopy resource instead. This argument will be removed in a future major version.

    snapshotIdentifier String
    The name of the snapshot from which to create the new cluster. Conflicts with snapshot_arn.
    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
    The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. No longer supported by the AWS API. Always returns auto.

    Deprecated: This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.

    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. Can only be changed if availability_zone_relocation_enabled is true.
    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
    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 ClusterLogging
    Logging, documented below.

    Deprecated: Use the aws.redshift.Logging resource instead. This argument will be removed in a future major version.

    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.
    manageMasterPassword boolean
    Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided.
    manualSnapshotRetentionPeriod number
    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. Conflicts with manage_master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.
    masterPasswordSecretKmsKeyId string
    ID of the KMS key used to encrypt the cluster admin credentials secret.
    masterUsername string
    Username for the master DB user.
    multiAz boolean
    Specifies if the Redshift cluster is multi-AZ.
    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. 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 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.
    snapshotArn string
    The ARN of the snapshot from which to create the new cluster. Conflicts with snapshot_identifier.
    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.

    Deprecated: Use the aws.redshift.SnapshotCopy resource instead. This argument will be removed in a future major version.

    snapshotIdentifier string
    The name of the snapshot from which to create the new cluster. Conflicts with snapshot_arn.
    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
    The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. No longer supported by the AWS API. Always returns auto.

    Deprecated: This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.

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

    Deprecated: Use the aws.redshift.Logging resource instead. This argument will be removed in a future major version.

    maintenance_track_name str
    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.
    manage_master_password bool
    Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided.
    manual_snapshot_retention_period 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.
    master_password str
    Password for the master DB user. Conflicts with manage_master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.
    master_password_secret_kms_key_id str
    ID of the KMS key used to encrypt the cluster admin credentials secret.
    master_username str
    Username for the master DB user.
    multi_az bool
    Specifies if the Redshift cluster is multi-AZ.
    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
    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.
    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_arn str
    The ARN of the snapshot from which to create the new cluster. Conflicts with snapshot_identifier.
    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.

    Deprecated: Use the aws.redshift.SnapshotCopy resource instead. This argument will be removed in a future major version.

    snapshot_identifier str
    The name of the snapshot from which to create the new cluster. Conflicts with snapshot_arn.
    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
    The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. No longer supported by the AWS API. Always returns auto.

    Deprecated: This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.

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

    Deprecated: Use the aws.redshift.Logging resource instead. This argument will be removed in a future major version.

    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.
    manageMasterPassword Boolean
    Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided.
    manualSnapshotRetentionPeriod Number
    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. Conflicts with manage_master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.
    masterPasswordSecretKmsKeyId String
    ID of the KMS key used to encrypt the cluster admin credentials secret.
    masterUsername String
    Username for the master DB user.
    multiAz Boolean
    Specifies if the Redshift cluster is multi-AZ.
    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. 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 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.
    snapshotArn String
    The ARN of the snapshot from which to create the new cluster. Conflicts with snapshot_identifier.
    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.

    Deprecated: Use the aws.redshift.SnapshotCopy resource instead. This argument will be removed in a future major version.

    snapshotIdentifier String
    The name of the snapshot from which to create the new cluster. Conflicts with snapshot_arn.
    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
    ClusterNamespaceArn string
    The namespace Amazon Resource Name (ARN) of the 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.
    MasterPasswordSecretArn string
    ARN of the cluster admin credentials secret
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    Amazon Resource Name (ARN) of cluster
    ClusterNamespaceArn string
    The namespace Amazon Resource Name (ARN) of the 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.
    MasterPasswordSecretArn string
    ARN of the cluster admin credentials secret
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of cluster
    clusterNamespaceArn String
    The namespace Amazon Resource Name (ARN) of the 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.
    masterPasswordSecretArn String
    ARN of the cluster admin credentials secret
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    Amazon Resource Name (ARN) of cluster
    clusterNamespaceArn string
    The namespace Amazon Resource Name (ARN) of the 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.
    masterPasswordSecretArn string
    ARN of the cluster admin credentials secret
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    Amazon Resource Name (ARN) of cluster
    cluster_namespace_arn str
    The namespace Amazon Resource Name (ARN) of the 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.
    master_password_secret_arn str
    ARN of the cluster admin credentials secret
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    Amazon Resource Name (ARN) of cluster
    clusterNamespaceArn String
    The namespace Amazon Resource Name (ARN) of the 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.
    masterPasswordSecretArn String
    ARN of the cluster admin credentials secret
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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_namespace_arn: 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_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,
        manage_master_password: Optional[bool] = None,
        manual_snapshot_retention_period: Optional[int] = None,
        master_password: Optional[str] = None,
        master_password_secret_arn: Optional[str] = None,
        master_password_secret_kms_key_id: Optional[str] = None,
        master_username: Optional[str] = None,
        multi_az: Optional[bool] = 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_arn: Optional[str] = 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
    The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. No longer supported by the AWS API. Always returns auto.

    Deprecated: This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.

    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. 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.
    ClusterIdentifier string
    The Cluster Identifier. Must be a lower case string.
    ClusterNamespaceArn string
    The namespace Amazon Resource Name (ARN) of the cluster
    ClusterNodes List<ClusterClusterNode>
    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
    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 ClusterLogging
    Logging, documented below.

    Deprecated: Use the aws.redshift.Logging resource instead. This argument will be removed in a future major version.

    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.
    ManageMasterPassword bool
    Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided.
    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. Conflicts with manage_master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.
    MasterPasswordSecretArn string
    ARN of the cluster admin credentials secret
    MasterPasswordSecretKmsKeyId string
    ID of the KMS key used to encrypt the cluster admin credentials secret.
    MasterUsername string
    Username for the master DB user.
    MultiAz bool
    Specifies if the Redshift cluster is multi-AZ.
    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. 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.
    SnapshotArn string
    The ARN of the snapshot from which to create the new cluster. Conflicts with snapshot_identifier.
    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.

    Deprecated: Use the aws.redshift.SnapshotCopy resource instead. This argument will be removed in a future major version.

    SnapshotIdentifier string
    The name of the snapshot from which to create the new cluster. Conflicts with snapshot_arn.
    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.

    Deprecated: Please use tags instead.

    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
    The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. No longer supported by the AWS API. Always returns auto.

    Deprecated: This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.

    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. 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.
    ClusterIdentifier string
    The Cluster Identifier. Must be a lower case string.
    ClusterNamespaceArn string
    The namespace Amazon Resource Name (ARN) of the cluster
    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
    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.

    Deprecated: Use the aws.redshift.Logging resource instead. This argument will be removed in a future major version.

    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.
    ManageMasterPassword bool
    Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided.
    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. Conflicts with manage_master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.
    MasterPasswordSecretArn string
    ARN of the cluster admin credentials secret
    MasterPasswordSecretKmsKeyId string
    ID of the KMS key used to encrypt the cluster admin credentials secret.
    MasterUsername string
    Username for the master DB user.
    MultiAz bool
    Specifies if the Redshift cluster is multi-AZ.
    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. 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.
    SnapshotArn string
    The ARN of the snapshot from which to create the new cluster. Conflicts with snapshot_identifier.
    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.

    Deprecated: Use the aws.redshift.SnapshotCopy resource instead. This argument will be removed in a future major version.

    SnapshotIdentifier string
    The name of the snapshot from which to create the new cluster. Conflicts with snapshot_arn.
    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.

    Deprecated: Please use tags instead.

    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
    The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. No longer supported by the AWS API. Always returns auto.

    Deprecated: This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.

    arn String
    Amazon Resource Name (ARN) of cluster
    automatedSnapshotRetentionPeriod Integer
    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 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.
    clusterNamespaceArn String
    The namespace Amazon Resource Name (ARN) of the cluster
    clusterNodes List<ClusterClusterNode>
    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
    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 ClusterLogging
    Logging, documented below.

    Deprecated: Use the aws.redshift.Logging resource instead. This argument will be removed in a future major version.

    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.
    manageMasterPassword Boolean
    Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided.
    manualSnapshotRetentionPeriod Integer
    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. Conflicts with manage_master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.
    masterPasswordSecretArn String
    ARN of the cluster admin credentials secret
    masterPasswordSecretKmsKeyId String
    ID of the KMS key used to encrypt the cluster admin credentials secret.
    masterUsername String
    Username for the master DB user.
    multiAz Boolean
    Specifies if the Redshift cluster is multi-AZ.
    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
    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 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.
    snapshotArn String
    The ARN of the snapshot from which to create the new cluster. Conflicts with snapshot_identifier.
    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.

    Deprecated: Use the aws.redshift.SnapshotCopy resource instead. This argument will be removed in a future major version.

    snapshotIdentifier String
    The name of the snapshot from which to create the new cluster. Conflicts with snapshot_arn.
    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.

    Deprecated: Please use tags instead.

    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
    The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. No longer supported by the AWS API. Always returns auto.

    Deprecated: This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.

    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. Can only be changed if availability_zone_relocation_enabled is true.
    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.
    clusterNamespaceArn string
    The namespace Amazon Resource Name (ARN) of the cluster
    clusterNodes ClusterClusterNode[]
    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
    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 ClusterLogging
    Logging, documented below.

    Deprecated: Use the aws.redshift.Logging resource instead. This argument will be removed in a future major version.

    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.
    manageMasterPassword boolean
    Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided.
    manualSnapshotRetentionPeriod number
    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. Conflicts with manage_master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.
    masterPasswordSecretArn string
    ARN of the cluster admin credentials secret
    masterPasswordSecretKmsKeyId string
    ID of the KMS key used to encrypt the cluster admin credentials secret.
    masterUsername string
    Username for the master DB user.
    multiAz boolean
    Specifies if the Redshift cluster is multi-AZ.
    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. 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 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.
    snapshotArn string
    The ARN of the snapshot from which to create the new cluster. Conflicts with snapshot_identifier.
    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.

    Deprecated: Use the aws.redshift.SnapshotCopy resource instead. This argument will be removed in a future major version.

    snapshotIdentifier string
    The name of the snapshot from which to create the new cluster. Conflicts with snapshot_arn.
    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.

    Deprecated: Please use tags instead.

    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
    The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. No longer supported by the AWS API. Always returns auto.

    Deprecated: This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.

    arn str
    Amazon Resource Name (ARN) of cluster
    automated_snapshot_retention_period 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.
    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. Can only be changed if availability_zone_relocation_enabled is true.
    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_namespace_arn str
    The namespace Amazon Resource Name (ARN) of the cluster
    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_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.

    Deprecated: Use the aws.redshift.Logging resource instead. This argument will be removed in a future major version.

    maintenance_track_name str
    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.
    manage_master_password bool
    Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided.
    manual_snapshot_retention_period 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.
    master_password str
    Password for the master DB user. Conflicts with manage_master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.
    master_password_secret_arn str
    ARN of the cluster admin credentials secret
    master_password_secret_kms_key_id str
    ID of the KMS key used to encrypt the cluster admin credentials secret.
    master_username str
    Username for the master DB user.
    multi_az bool
    Specifies if the Redshift cluster is multi-AZ.
    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
    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.
    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_arn str
    The ARN of the snapshot from which to create the new cluster. Conflicts with snapshot_identifier.
    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.

    Deprecated: Use the aws.redshift.SnapshotCopy resource instead. This argument will be removed in a future major version.

    snapshot_identifier str
    The name of the snapshot from which to create the new cluster. Conflicts with snapshot_arn.
    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.

    Deprecated: Please use tags instead.

    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
    The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. No longer supported by the AWS API. Always returns auto.

    Deprecated: This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.

    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. Can only be changed if availability_zone_relocation_enabled is true.
    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.
    clusterNamespaceArn String
    The namespace Amazon Resource Name (ARN) of the cluster
    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
    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.

    Deprecated: Use the aws.redshift.Logging resource instead. This argument will be removed in a future major version.

    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.
    manageMasterPassword Boolean
    Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided.
    manualSnapshotRetentionPeriod Number
    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. Conflicts with manage_master_password. One of master_password or manage_master_password is required unless snapshot_identifier is provided. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 characters and contain at least one uppercase letter, one lowercase letter, and one number.
    masterPasswordSecretArn String
    ARN of the cluster admin credentials secret
    masterPasswordSecretKmsKeyId String
    ID of the KMS key used to encrypt the cluster admin credentials secret.
    masterUsername String
    Username for the master DB user.
    multiAz Boolean
    Specifies if the Redshift cluster is multi-AZ.
    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. 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 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.
    snapshotArn String
    The ARN of the snapshot from which to create the new cluster. Conflicts with snapshot_identifier.
    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.

    Deprecated: Use the aws.redshift.SnapshotCopy resource instead. This argument will be removed in a future major version.

    snapshotIdentifier String
    The name of the snapshot from which to create the new cluster. Conflicts with snapshot_arn.
    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.

    Deprecated: Please use tags instead.

    vpcSecurityGroupIds List<String>
    A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.

    Supporting Types

    ClusterClusterNode, ClusterClusterNodeArgs

    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, ClusterLoggingArgs

    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, ClusterSnapshotCopyArgs

    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

    Using pulumi import, import Redshift Clusters using the cluster_identifier. For example:

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws