Docs
PackagesTry AWS Native preview for resources not in the classic version.
aws.redshift.Cluster
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
Provides a Redshift Cluster Resource.
NOTE: A Redshift cluster’s default IAM role can be managed both by this resource’s
default_iam_role_arnargument and theaws.redshift.ClusterIamRolesresource’sdefault_iam_role_arnargument. Do not configure different values for both arguments. Doing so will cause a conflict of default IAM roles.
Example Usage
Basic Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.RedShift.Cluster("example", new()
{
ClusterIdentifier = "tf-redshift-cluster",
ClusterType = "single-node",
DatabaseName = "mydb",
MasterPassword = "Mustbe8characters",
MasterUsername = "exampleuser",
NodeType = "dc1.large",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/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"),
ClusterType: pulumi.String("single-node"),
DatabaseName: pulumi.String("mydb"),
MasterPassword: pulumi.String("Mustbe8characters"),
MasterUsername: pulumi.String("exampleuser"),
NodeType: pulumi.String("dc1.large"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.Cluster;
import com.pulumi.aws.redshift.ClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Cluster("example", ClusterArgs.builder()
.clusterIdentifier("tf-redshift-cluster")
.clusterType("single-node")
.databaseName("mydb")
.masterPassword("Mustbe8characters")
.masterUsername("exampleuser")
.nodeType("dc1.large")
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.redshift.Cluster("example",
cluster_identifier="tf-redshift-cluster",
cluster_type="single-node",
database_name="mydb",
master_password="Mustbe8characters",
master_username="exampleuser",
node_type="dc1.large")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.redshift.Cluster("example", {
clusterIdentifier: "tf-redshift-cluster",
clusterType: "single-node",
databaseName: "mydb",
masterPassword: "Mustbe8characters",
masterUsername: "exampleuser",
nodeType: "dc1.large",
});
resources:
example:
type: aws:redshift:Cluster
properties:
clusterIdentifier: tf-redshift-cluster
clusterType: single-node
databaseName: mydb
masterPassword: Mustbe8characters
masterUsername: exampleuser
nodeType: dc1.large
With Managed Credentials
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.RedShift.Cluster("example", new()
{
ClusterIdentifier = "tf-redshift-cluster",
ClusterType = "single-node",
DatabaseName = "mydb",
ManageMasterPassword = true,
MasterUsername = "exampleuser",
NodeType = "dc1.large",
});
});
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"),
ClusterType: pulumi.String("single-node"),
DatabaseName: pulumi.String("mydb"),
ManageMasterPassword: pulumi.Bool(true),
MasterUsername: pulumi.String("exampleuser"),
NodeType: pulumi.String("dc1.large"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.Cluster;
import com.pulumi.aws.redshift.ClusterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Cluster("example", ClusterArgs.builder()
.clusterIdentifier("tf-redshift-cluster")
.clusterType("single-node")
.databaseName("mydb")
.manageMasterPassword(true)
.masterUsername("exampleuser")
.nodeType("dc1.large")
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.redshift.Cluster("example",
cluster_identifier="tf-redshift-cluster",
cluster_type="single-node",
database_name="mydb",
manage_master_password=True,
master_username="exampleuser",
node_type="dc1.large")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.redshift.Cluster("example", {
clusterIdentifier: "tf-redshift-cluster",
clusterType: "single-node",
databaseName: "mydb",
manageMasterPassword: true,
masterUsername: "exampleuser",
nodeType: "dc1.large",
});
resources:
example:
type: aws:redshift:Cluster
properties:
clusterIdentifier: tf-redshift-cluster
clusterType: single-node
databaseName: mydb
manageMasterPassword: true
masterUsername: exampleuser
nodeType: dc1.large
Create Cluster Resource
new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
allow_version_upgrade: Optional[bool] = None,
apply_immediately: Optional[bool] = None,
aqua_configuration_status: Optional[str] = None,
automated_snapshot_retention_period: Optional[int] = None,
availability_zone: Optional[str] = None,
availability_zone_relocation_enabled: Optional[bool] = None,
cluster_identifier: Optional[str] = None,
cluster_parameter_group_name: Optional[str] = None,
cluster_public_key: Optional[str] = None,
cluster_revision_number: Optional[str] = None,
cluster_subnet_group_name: Optional[str] = None,
cluster_type: Optional[str] = None,
cluster_version: Optional[str] = None,
database_name: Optional[str] = None,
default_iam_role_arn: Optional[str] = None,
elastic_ip: Optional[str] = None,
encrypted: Optional[bool] = None,
endpoint: Optional[str] = None,
enhanced_vpc_routing: Optional[bool] = None,
final_snapshot_identifier: Optional[str] = None,
iam_roles: Optional[Sequence[str]] = None,
kms_key_id: Optional[str] = None,
logging: Optional[ClusterLoggingArgs] = None,
maintenance_track_name: Optional[str] = None,
manage_master_password: Optional[bool] = 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,
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,
vpc_security_group_ids: Optional[Sequence[str]] = None)
@overload
def Cluster(resource_name: str,
args: ClusterArgs,
opts: Optional[ResourceOptions] = None)func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
type: aws:redshift:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ClusterArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Cluster Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Cluster resource accepts the following input properties:
- Cluster
Identifier string The Cluster Identifier. Must be a lower case string.
- Node
Type string The node type to be provisioned for the cluster.
- Allow
Version boolUpgrade 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 stringStatus 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.This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.
- Automated
Snapshot intRetention Period 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 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_enabledistrue.- Availability
Zone boolRelocation Enabled 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 stringGroup Name The name of the parameter group to be associated with this cluster.
- Cluster
Public stringKey The public key for the cluster
- Cluster
Revision stringNumber The specific revision number of the database in the cluster
- Cluster
Subnet stringGroup Name 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 string The cluster type to use. Either
single-nodeormulti-node.- Cluster
Version 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.
- Database
Name 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.- Default
Iam stringRole Arn The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
- Elastic
Ip 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
- Enhanced
Vpc boolRouting If true , enhanced VPC routing is enabled.
- Final
Snapshot stringIdentifier The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skip_final_snapshotmust be false.- Iam
Roles 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.
- Kms
Key stringId The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.- Logging
Pulumi.
Aws. Red Shift. Inputs. Cluster Logging Logging, documented below.
- Maintenance
Track stringName 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 boolPassword Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with
master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris provided.- Manual
Snapshot intRetention Period 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
-1and3653. Default value is-1.- Master
Password string Password for the master DB user. Conflicts with
manage_master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris 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 stringSecret Kms Key Id ID of the KMS key used to encrypt the cluster admin credentials secret.
- Master
Username string Username for the master DB user.
- Number
Of intNodes 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 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
1115and65535. 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 is5439.- Preferred
Maintenance stringWindow 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 boolSnapshot 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 string The ARN of the snapshot from which to create the new cluster. Conflicts with
snapshot_identifier.- Snapshot
Cluster stringIdentifier The name of the cluster the source snapshot was created from.
- Snapshot
Copy Pulumi.Aws. Red Shift. Inputs. Cluster Snapshot Copy Configuration of automatic copy of snapshots from one region to another. Documented below.
- Snapshot
Identifier string The name of the snapshot from which to create the new cluster. Conflicts with
snapshot_arn.- Dictionary<string, string>
A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- Vpc
Security List<string>Group Ids A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- Cluster
Identifier string The Cluster Identifier. Must be a lower case string.
- Node
Type string The node type to be provisioned for the cluster.
- Allow
Version boolUpgrade 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 stringStatus 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.This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.
- Automated
Snapshot intRetention Period 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 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_enabledistrue.- Availability
Zone boolRelocation Enabled 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 stringGroup Name The name of the parameter group to be associated with this cluster.
- Cluster
Public stringKey The public key for the cluster
- Cluster
Revision stringNumber The specific revision number of the database in the cluster
- Cluster
Subnet stringGroup Name 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 string The cluster type to use. Either
single-nodeormulti-node.- Cluster
Version 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.
- Database
Name 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.- Default
Iam stringRole Arn The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
- Elastic
Ip 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
- Enhanced
Vpc boolRouting If true , enhanced VPC routing is enabled.
- Final
Snapshot stringIdentifier The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skip_final_snapshotmust be false.- Iam
Roles []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.
- Kms
Key stringId The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.- Logging
Cluster
Logging Args Logging, documented below.
- Maintenance
Track stringName 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 boolPassword Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with
master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris provided.- Manual
Snapshot intRetention Period 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
-1and3653. Default value is-1.- Master
Password string Password for the master DB user. Conflicts with
manage_master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris 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 stringSecret Kms Key Id ID of the KMS key used to encrypt the cluster admin credentials secret.
- Master
Username string Username for the master DB user.
- Number
Of intNodes 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 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
1115and65535. 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 is5439.- Preferred
Maintenance stringWindow 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 boolSnapshot 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 string The ARN of the snapshot from which to create the new cluster. Conflicts with
snapshot_identifier.- Snapshot
Cluster stringIdentifier The name of the cluster the source snapshot was created from.
- Snapshot
Copy ClusterSnapshot Copy Args Configuration of automatic copy of snapshots from one region to another. Documented below.
- Snapshot
Identifier string The name of the snapshot from which to create the new cluster. Conflicts with
snapshot_arn.- map[string]string
A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- Vpc
Security []stringGroup Ids A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- cluster
Identifier String The Cluster Identifier. Must be a lower case string.
- node
Type String The node type to be provisioned for the cluster.
- allow
Version BooleanUpgrade 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 Boolean Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is
false.- aqua
Configuration StringStatus 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.This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.
- automated
Snapshot IntegerRetention Period 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 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_enabledistrue.- availability
Zone BooleanRelocation Enabled 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 StringGroup Name The name of the parameter group to be associated with this cluster.
- cluster
Public StringKey The public key for the cluster
- cluster
Revision StringNumber The specific revision number of the database in the cluster
- cluster
Subnet StringGroup Name 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 String The cluster type to use. Either
single-nodeormulti-node.- cluster
Version 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.
- database
Name 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.- default
Iam StringRole Arn The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
- elastic
Ip 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
- enhanced
Vpc BooleanRouting If true , enhanced VPC routing is enabled.
- final
Snapshot StringIdentifier The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skip_final_snapshotmust be false.- iam
Roles 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.
- kms
Key StringId The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.- logging
Cluster
Logging Logging, documented below.
- maintenance
Track StringName 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 BooleanPassword Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with
master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris provided.- manual
Snapshot IntegerRetention Period 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
-1and3653. Default value is-1.- master
Password String Password for the master DB user. Conflicts with
manage_master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris 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 StringSecret Kms Key Id ID of the KMS key used to encrypt the cluster admin credentials secret.
- master
Username String Username for the master DB user.
- number
Of IntegerNodes 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 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
1115and65535. 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 is5439.- preferred
Maintenance StringWindow The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
- publicly
Accessible Boolean If true, the cluster can be accessed from a public network. Default is
true.- skip
Final BooleanSnapshot 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 String The ARN of the snapshot from which to create the new cluster. Conflicts with
snapshot_identifier.- snapshot
Cluster StringIdentifier The name of the cluster the source snapshot was created from.
- snapshot
Copy ClusterSnapshot Copy Configuration of automatic copy of snapshots from one region to another. Documented below.
- snapshot
Identifier String The name of the snapshot from which to create the new cluster. Conflicts with
snapshot_arn.- Map<String,String>
A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- vpc
Security List<String>Group Ids A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- cluster
Identifier string The Cluster Identifier. Must be a lower case string.
- node
Type string The node type to be provisioned for the cluster.
- allow
Version booleanUpgrade 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 boolean Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is
false.- aqua
Configuration stringStatus 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.This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.
- automated
Snapshot numberRetention Period 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 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_enabledistrue.- availability
Zone booleanRelocation Enabled 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 stringGroup Name The name of the parameter group to be associated with this cluster.
- cluster
Public stringKey The public key for the cluster
- cluster
Revision stringNumber The specific revision number of the database in the cluster
- cluster
Subnet stringGroup Name 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 string The cluster type to use. Either
single-nodeormulti-node.- cluster
Version 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.
- database
Name 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.- default
Iam stringRole Arn The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
- elastic
Ip 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
- enhanced
Vpc booleanRouting If true , enhanced VPC routing is enabled.
- final
Snapshot stringIdentifier The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skip_final_snapshotmust be false.- iam
Roles 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.
- kms
Key stringId The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.- logging
Cluster
Logging Logging, documented below.
- maintenance
Track stringName 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 booleanPassword Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with
master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris provided.- manual
Snapshot numberRetention Period 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
-1and3653. Default value is-1.- master
Password string Password for the master DB user. Conflicts with
manage_master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris 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 stringSecret Kms Key Id ID of the KMS key used to encrypt the cluster admin credentials secret.
- master
Username string Username for the master DB user.
- number
Of numberNodes 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 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
1115and65535. 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 is5439.- preferred
Maintenance stringWindow The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
- publicly
Accessible boolean If true, the cluster can be accessed from a public network. Default is
true.- skip
Final booleanSnapshot 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 string The ARN of the snapshot from which to create the new cluster. Conflicts with
snapshot_identifier.- snapshot
Cluster stringIdentifier The name of the cluster the source snapshot was created from.
- snapshot
Copy ClusterSnapshot Copy Configuration of automatic copy of snapshots from one region to another. Documented below.
- snapshot
Identifier string The name of the snapshot from which to create the new cluster. Conflicts with
snapshot_arn.- {[key: string]: string}
A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- vpc
Security string[]Group Ids 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_ boolupgrade 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_ strstatus 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.This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.
- automated_
snapshot_ intretention_ period 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_enabledistrue.- availability_
zone_ boolrelocation_ enabled 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_ strgroup_ name The name of the parameter group to be associated with this cluster.
- cluster_
public_ strkey The public key for the cluster
- cluster_
revision_ strnumber The specific revision number of the database in the cluster
- cluster_
subnet_ strgroup_ name 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-nodeormulti-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_ strrole_ arn 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_ boolrouting If true , enhanced VPC routing is enabled.
- final_
snapshot_ stridentifier The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skip_final_snapshotmust 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_ strid The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.- logging
Cluster
Logging Args Logging, documented below.
- maintenance_
track_ strname 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_ boolpassword Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with
master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris provided.- manual_
snapshot_ intretention_ period 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
-1and3653. Default value is-1.- master_
password str Password for the master DB user. Conflicts with
manage_master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris 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_ strsecret_ kms_ key_ id ID of the KMS key used to encrypt the cluster admin credentials secret.
- master_
username str Username for the master DB user.
- number_
of_ intnodes 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
1115and65535. 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 is5439.- preferred_
maintenance_ strwindow 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_ boolsnapshot 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_ stridentifier The name of the cluster the source snapshot was created from.
- snapshot_
copy ClusterSnapshot Copy Args Configuration of automatic copy of snapshots from one region to another. Documented below.
- snapshot_
identifier str The name of the snapshot from which to create the new cluster. Conflicts with
snapshot_arn.- Mapping[str, str]
A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- vpc_
security_ Sequence[str]group_ ids A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- cluster
Identifier String The Cluster Identifier. Must be a lower case string.
- node
Type String The node type to be provisioned for the cluster.
- allow
Version BooleanUpgrade 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 Boolean Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is
false.- aqua
Configuration StringStatus 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.This parameter is no longer supported by the AWS API. It will be removed in the next major version of the provider.
- automated
Snapshot NumberRetention Period 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 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_enabledistrue.- availability
Zone BooleanRelocation Enabled 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 StringGroup Name The name of the parameter group to be associated with this cluster.
- cluster
Public StringKey The public key for the cluster
- cluster
Revision StringNumber The specific revision number of the database in the cluster
- cluster
Subnet StringGroup Name 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 String The cluster type to use. Either
single-nodeormulti-node.- cluster
Version 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.
- database
Name 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.- default
Iam StringRole Arn The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
- elastic
Ip 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
- enhanced
Vpc BooleanRouting If true , enhanced VPC routing is enabled.
- final
Snapshot StringIdentifier The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skip_final_snapshotmust be false.- iam
Roles 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.
- kms
Key StringId The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.- logging Property Map
Logging, documented below.
- maintenance
Track StringName 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 BooleanPassword Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with
master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris provided.- manual
Snapshot NumberRetention Period 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
-1and3653. Default value is-1.- master
Password String Password for the master DB user. Conflicts with
manage_master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris 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 StringSecret Kms Key Id ID of the KMS key used to encrypt the cluster admin credentials secret.
- master
Username String Username for the master DB user.
- number
Of NumberNodes 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 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
1115and65535. 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 is5439.- preferred
Maintenance StringWindow The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
- publicly
Accessible Boolean If true, the cluster can be accessed from a public network. Default is
true.- skip
Final BooleanSnapshot 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 String The ARN of the snapshot from which to create the new cluster. Conflicts with
snapshot_identifier.- snapshot
Cluster StringIdentifier The name of the cluster the source snapshot was created from.
- snapshot
Copy Property Map Configuration of automatic copy of snapshots from one region to another. Documented below.
- snapshot
Identifier String The name of the snapshot from which to create the new cluster. Conflicts with
snapshot_arn.- Map<String>
A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- vpc
Security List<String>Group Ids 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
- Cluster
Namespace stringArn The namespace Amazon Resource Name (ARN) of the cluster
- Cluster
Nodes List<Pulumi.Aws. Red Shift. Outputs. Cluster Cluster Node> The nodes in the cluster. Cluster node blocks are documented below
- Dns
Name string The DNS name of the cluster
- Id string
The provider-assigned unique ID for this managed resource.
- Master
Password stringSecret Arn ARN of the cluster admin credentials secret
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.
- Arn string
Amazon Resource Name (ARN) of cluster
- Cluster
Namespace stringArn The namespace Amazon Resource Name (ARN) of the cluster
- Cluster
Nodes []ClusterCluster Node The nodes in the cluster. Cluster node blocks are documented below
- Dns
Name string The DNS name of the cluster
- Id string
The provider-assigned unique ID for this managed resource.
- Master
Password stringSecret Arn ARN of the cluster admin credentials secret
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.
- arn String
Amazon Resource Name (ARN) of cluster
- cluster
Namespace StringArn The namespace Amazon Resource Name (ARN) of the cluster
- cluster
Nodes List<ClusterCluster Node> The nodes in the cluster. Cluster node blocks are documented below
- dns
Name String The DNS name of the cluster
- id String
The provider-assigned unique ID for this managed resource.
- master
Password StringSecret Arn ARN of the cluster admin credentials secret
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.
- arn string
Amazon Resource Name (ARN) of cluster
- cluster
Namespace stringArn The namespace Amazon Resource Name (ARN) of the cluster
- cluster
Nodes ClusterCluster Node[] The nodes in the cluster. Cluster node blocks are documented below
- dns
Name string The DNS name of the cluster
- id string
The provider-assigned unique ID for this managed resource.
- master
Password stringSecret Arn ARN of the cluster admin credentials secret
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.
- arn str
Amazon Resource Name (ARN) of cluster
- cluster_
namespace_ strarn The namespace Amazon Resource Name (ARN) of the cluster
- cluster_
nodes Sequence[ClusterCluster Node] 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_ strsecret_ arn ARN of the cluster admin credentials secret
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.
- arn String
Amazon Resource Name (ARN) of cluster
- cluster
Namespace StringArn The namespace Amazon Resource Name (ARN) of the cluster
- cluster
Nodes List<Property Map> The nodes in the cluster. Cluster node blocks are documented below
- dns
Name String The DNS name of the cluster
- id String
The provider-assigned unique ID for this managed resource.
- master
Password StringSecret Arn ARN of the cluster admin credentials secret
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.
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,
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) -> Clusterfunc 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.
- Allow
Version boolUpgrade 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 stringStatus 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.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
- Automated
Snapshot intRetention Period 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 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_enabledistrue.- Availability
Zone boolRelocation Enabled 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 string The Cluster Identifier. Must be a lower case string.
- Cluster
Namespace stringArn The namespace Amazon Resource Name (ARN) of the cluster
- Cluster
Nodes List<Pulumi.Aws. Red Shift. Inputs. Cluster Cluster Node> The nodes in the cluster. Cluster node blocks are documented below
- Cluster
Parameter stringGroup Name The name of the parameter group to be associated with this cluster.
- Cluster
Public stringKey The public key for the cluster
- Cluster
Revision stringNumber The specific revision number of the database in the cluster
- Cluster
Subnet stringGroup Name 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 string The cluster type to use. Either
single-nodeormulti-node.- Cluster
Version 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.
- Database
Name 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.- Default
Iam stringRole Arn The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
- Dns
Name string The DNS name of the cluster
- Elastic
Ip 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
- Enhanced
Vpc boolRouting If true , enhanced VPC routing is enabled.
- Final
Snapshot stringIdentifier The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skip_final_snapshotmust be false.- Iam
Roles 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.
- Kms
Key stringId The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.- Logging
Pulumi.
Aws. Red Shift. Inputs. Cluster Logging Logging, documented below.
- Maintenance
Track stringName 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 boolPassword Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with
master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris provided.- Manual
Snapshot intRetention Period 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
-1and3653. Default value is-1.- Master
Password string Password for the master DB user. Conflicts with
manage_master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris 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 stringSecret Arn ARN of the cluster admin credentials secret
- Master
Password stringSecret Kms Key Id ID of the KMS key used to encrypt the cluster admin credentials secret.
- Master
Username string Username for the master DB user.
- Node
Type string The node type to be provisioned for the cluster.
- Number
Of intNodes 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 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
1115and65535. 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 is5439.- Preferred
Maintenance stringWindow 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 boolSnapshot 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 string The ARN of the snapshot from which to create the new cluster. Conflicts with
snapshot_identifier.- Snapshot
Cluster stringIdentifier The name of the cluster the source snapshot was created from.
- Snapshot
Copy Pulumi.Aws. Red Shift. Inputs. Cluster Snapshot Copy Configuration of automatic copy of snapshots from one region to another. Documented below.
- Snapshot
Identifier string The name of the snapshot from which to create the new cluster. Conflicts with
snapshot_arn.- Dictionary<string, string>
A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- Vpc
Security List<string>Group Ids A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- Allow
Version boolUpgrade 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 stringStatus 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.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
- Automated
Snapshot intRetention Period 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 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_enabledistrue.- Availability
Zone boolRelocation Enabled 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 string The Cluster Identifier. Must be a lower case string.
- Cluster
Namespace stringArn The namespace Amazon Resource Name (ARN) of the cluster
- Cluster
Nodes []ClusterCluster Node Args The nodes in the cluster. Cluster node blocks are documented below
- Cluster
Parameter stringGroup Name The name of the parameter group to be associated with this cluster.
- Cluster
Public stringKey The public key for the cluster
- Cluster
Revision stringNumber The specific revision number of the database in the cluster
- Cluster
Subnet stringGroup Name 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 string The cluster type to use. Either
single-nodeormulti-node.- Cluster
Version 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.
- Database
Name 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.- Default
Iam stringRole Arn The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
- Dns
Name string The DNS name of the cluster
- Elastic
Ip 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
- Enhanced
Vpc boolRouting If true , enhanced VPC routing is enabled.
- Final
Snapshot stringIdentifier The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skip_final_snapshotmust be false.- Iam
Roles []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.
- Kms
Key stringId The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.- Logging
Cluster
Logging Args Logging, documented below.
- Maintenance
Track stringName 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 boolPassword Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with
master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris provided.- Manual
Snapshot intRetention Period 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
-1and3653. Default value is-1.- Master
Password string Password for the master DB user. Conflicts with
manage_master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris 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 stringSecret Arn ARN of the cluster admin credentials secret
- Master
Password stringSecret Kms Key Id ID of the KMS key used to encrypt the cluster admin credentials secret.
- Master
Username string Username for the master DB user.
- Node
Type string The node type to be provisioned for the cluster.
- Number
Of intNodes 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 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
1115and65535. 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 is5439.- Preferred
Maintenance stringWindow 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 boolSnapshot 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 string The ARN of the snapshot from which to create the new cluster. Conflicts with
snapshot_identifier.- Snapshot
Cluster stringIdentifier The name of the cluster the source snapshot was created from.
- Snapshot
Copy ClusterSnapshot Copy Args Configuration of automatic copy of snapshots from one region to another. Documented below.
- Snapshot
Identifier string The name of the snapshot from which to create the new cluster. Conflicts with
snapshot_arn.- map[string]string
A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- Vpc
Security []stringGroup Ids A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- allow
Version BooleanUpgrade 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 Boolean Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is
false.- aqua
Configuration StringStatus 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.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
- automated
Snapshot IntegerRetention Period 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 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_enabledistrue.- availability
Zone BooleanRelocation Enabled 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 String The Cluster Identifier. Must be a lower case string.
- cluster
Namespace StringArn The namespace Amazon Resource Name (ARN) of the cluster
- cluster
Nodes List<ClusterCluster Node> The nodes in the cluster. Cluster node blocks are documented below
- cluster
Parameter StringGroup Name The name of the parameter group to be associated with this cluster.
- cluster
Public StringKey The public key for the cluster
- cluster
Revision StringNumber The specific revision number of the database in the cluster
- cluster
Subnet StringGroup Name 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 String The cluster type to use. Either
single-nodeormulti-node.- cluster
Version 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.
- database
Name 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.- default
Iam StringRole Arn The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
- dns
Name String The DNS name of the cluster
- elastic
Ip 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
- enhanced
Vpc BooleanRouting If true , enhanced VPC routing is enabled.
- final
Snapshot StringIdentifier The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skip_final_snapshotmust be false.- iam
Roles 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.
- kms
Key StringId The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.- logging
Cluster
Logging Logging, documented below.
- maintenance
Track StringName 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 BooleanPassword Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with
master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris provided.- manual
Snapshot IntegerRetention Period 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
-1and3653. Default value is-1.- master
Password String Password for the master DB user. Conflicts with
manage_master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris 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 StringSecret Arn ARN of the cluster admin credentials secret
- master
Password StringSecret Kms Key Id ID of the KMS key used to encrypt the cluster admin credentials secret.
- master
Username String Username for the master DB user.
- node
Type String The node type to be provisioned for the cluster.
- number
Of IntegerNodes 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 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
1115and65535. 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 is5439.- preferred
Maintenance StringWindow The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
- publicly
Accessible Boolean If true, the cluster can be accessed from a public network. Default is
true.- skip
Final BooleanSnapshot 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 String The ARN of the snapshot from which to create the new cluster. Conflicts with
snapshot_identifier.- snapshot
Cluster StringIdentifier The name of the cluster the source snapshot was created from.
- snapshot
Copy ClusterSnapshot Copy Configuration of automatic copy of snapshots from one region to another. Documented below.
- snapshot
Identifier String The name of the snapshot from which to create the new cluster. Conflicts with
snapshot_arn.- Map<String,String>
A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- vpc
Security List<String>Group Ids A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- allow
Version booleanUpgrade 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 boolean Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is
false.- aqua
Configuration stringStatus 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.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
- automated
Snapshot numberRetention Period 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 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_enabledistrue.- availability
Zone booleanRelocation Enabled 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 string The Cluster Identifier. Must be a lower case string.
- cluster
Namespace stringArn The namespace Amazon Resource Name (ARN) of the cluster
- cluster
Nodes ClusterCluster Node[] The nodes in the cluster. Cluster node blocks are documented below
- cluster
Parameter stringGroup Name The name of the parameter group to be associated with this cluster.
- cluster
Public stringKey The public key for the cluster
- cluster
Revision stringNumber The specific revision number of the database in the cluster
- cluster
Subnet stringGroup Name 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 string The cluster type to use. Either
single-nodeormulti-node.- cluster
Version 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.
- database
Name 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.- default
Iam stringRole Arn The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
- dns
Name string The DNS name of the cluster
- elastic
Ip 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
- enhanced
Vpc booleanRouting If true , enhanced VPC routing is enabled.
- final
Snapshot stringIdentifier The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skip_final_snapshotmust be false.- iam
Roles 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.
- kms
Key stringId The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.- logging
Cluster
Logging Logging, documented below.
- maintenance
Track stringName 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 booleanPassword Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with
master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris provided.- manual
Snapshot numberRetention Period 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
-1and3653. Default value is-1.- master
Password string Password for the master DB user. Conflicts with
manage_master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris 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 stringSecret Arn ARN of the cluster admin credentials secret
- master
Password stringSecret Kms Key Id ID of the KMS key used to encrypt the cluster admin credentials secret.
- master
Username string Username for the master DB user.
- node
Type string The node type to be provisioned for the cluster.
- number
Of numberNodes 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 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
1115and65535. 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 is5439.- preferred
Maintenance stringWindow The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
- publicly
Accessible boolean If true, the cluster can be accessed from a public network. Default is
true.- skip
Final booleanSnapshot 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 string The ARN of the snapshot from which to create the new cluster. Conflicts with
snapshot_identifier.- snapshot
Cluster stringIdentifier The name of the cluster the source snapshot was created from.
- snapshot
Copy ClusterSnapshot Copy Configuration of automatic copy of snapshots from one region to another. Documented below.
- snapshot
Identifier string The name of the snapshot from which to create the new cluster. Conflicts with
snapshot_arn.- {[key: string]: string}
A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- vpc
Security string[]Group Ids A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- allow_
version_ boolupgrade 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_ strstatus 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.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_ intretention_ period 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_enabledistrue.- availability_
zone_ boolrelocation_ enabled 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_ strarn The namespace Amazon Resource Name (ARN) of the cluster
- cluster_
nodes Sequence[ClusterCluster Node Args] The nodes in the cluster. Cluster node blocks are documented below
- cluster_
parameter_ strgroup_ name The name of the parameter group to be associated with this cluster.
- cluster_
public_ strkey The public key for the cluster
- cluster_
revision_ strnumber The specific revision number of the database in the cluster
- cluster_
subnet_ strgroup_ name 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-nodeormulti-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_ strrole_ arn 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_ boolrouting If true , enhanced VPC routing is enabled.
- final_
snapshot_ stridentifier The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skip_final_snapshotmust 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_ strid The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.- logging
Cluster
Logging Args Logging, documented below.
- maintenance_
track_ strname 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_ boolpassword Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with
master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris provided.- manual_
snapshot_ intretention_ period 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
-1and3653. Default value is-1.- master_
password str Password for the master DB user. Conflicts with
manage_master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris 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_ strsecret_ arn ARN of the cluster admin credentials secret
- master_
password_ strsecret_ kms_ key_ id ID of the KMS key used to encrypt the cluster admin credentials secret.
- master_
username str Username for the master DB user.
- node_
type str The node type to be provisioned for the cluster.
- number_
of_ intnodes 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
1115and65535. 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 is5439.- preferred_
maintenance_ strwindow 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_ boolsnapshot 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_ stridentifier The name of the cluster the source snapshot was created from.
- snapshot_
copy ClusterSnapshot Copy Args Configuration of automatic copy of snapshots from one region to another. Documented below.
- snapshot_
identifier str The name of the snapshot from which to create the new cluster. Conflicts with
snapshot_arn.- Mapping[str, str]
A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- vpc_
security_ Sequence[str]group_ ids A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
- allow
Version BooleanUpgrade 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 Boolean Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is
false.- aqua
Configuration StringStatus 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.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
- automated
Snapshot NumberRetention Period 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 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_enabledistrue.- availability
Zone BooleanRelocation Enabled 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 String The Cluster Identifier. Must be a lower case string.
- cluster
Namespace StringArn The namespace Amazon Resource Name (ARN) of the cluster
- cluster
Nodes List<Property Map> The nodes in the cluster. Cluster node blocks are documented below
- cluster
Parameter StringGroup Name The name of the parameter group to be associated with this cluster.
- cluster
Public StringKey The public key for the cluster
- cluster
Revision StringNumber The specific revision number of the database in the cluster
- cluster
Subnet StringGroup Name 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 String The cluster type to use. Either
single-nodeormulti-node.- cluster
Version 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.
- database
Name 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.- default
Iam StringRole Arn The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
- dns
Name String The DNS name of the cluster
- elastic
Ip 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
- enhanced
Vpc BooleanRouting If true , enhanced VPC routing is enabled.
- final
Snapshot StringIdentifier The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided,
skip_final_snapshotmust be false.- iam
Roles 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.
- kms
Key StringId The ARN for the KMS encryption key. When specifying
kms_key_id,encryptedneeds to be set to true.- logging Property Map
Logging, documented below.
- maintenance
Track StringName 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 BooleanPassword Whether to use AWS SecretsManager to manage the cluster admin credentials. Conflicts with
master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris provided.- manual
Snapshot NumberRetention Period 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
-1and3653. Default value is-1.- master
Password String Password for the master DB user. Conflicts with
manage_master_password. One ofmaster_passwordormanage_master_passwordis required unlesssnapshot_identifieris 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 StringSecret Arn ARN of the cluster admin credentials secret
- master
Password StringSecret Kms Key Id ID of the KMS key used to encrypt the cluster admin credentials secret.
- master
Username String Username for the master DB user.
- node
Type String The node type to be provisioned for the cluster.
- number
Of NumberNodes 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 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
1115and65535. 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 is5439.- preferred
Maintenance StringWindow The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
- publicly
Accessible Boolean If true, the cluster can be accessed from a public network. Default is
true.- skip
Final BooleanSnapshot 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 String The ARN of the snapshot from which to create the new cluster. Conflicts with
snapshot_identifier.- snapshot
Cluster StringIdentifier The name of the cluster the source snapshot was created from.
- snapshot
Copy Property Map Configuration of automatic copy of snapshots from one region to another. Documented below.
- snapshot
Identifier String The name of the snapshot from which to create the new cluster. Conflicts with
snapshot_arn.- Map<String>
A map of tags to assign to the resource. If configured with a provider
default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tagsconfiguration block.Please use
tagsinstead.- vpc
Security List<String>Group Ids A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Supporting Types
ClusterClusterNode, ClusterClusterNodeArgs
- Node
Role string Whether the node is a leader node or a compute node
- Private
Ip stringAddress The private IP address of a node within a cluster
- Public
Ip stringAddress The public IP address of a node within a cluster
- Node
Role string Whether the node is a leader node or a compute node
- Private
Ip stringAddress The private IP address of a node within a cluster
- Public
Ip stringAddress The public IP address of a node within a cluster
- node
Role String Whether the node is a leader node or a compute node
- private
Ip StringAddress The private IP address of a node within a cluster
- public
Ip StringAddress The public IP address of a node within a cluster
- node
Role string Whether the node is a leader node or a compute node
- private
Ip stringAddress The private IP address of a node within a cluster
- public
Ip stringAddress 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_ straddress The private IP address of a node within a cluster
- public_
ip_ straddress The public IP address of a node within a cluster
- node
Role String Whether the node is a leader node or a compute node
- private
Ip StringAddress The private IP address of a node within a cluster
- public
Ip StringAddress 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.
- Bucket
Name 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
- Log
Destination stringType The log destination type. An enum with possible values of
s3andcloudwatch.- Log
Exports List<string> The collection of exported log types. Log types include the connection log, user log and user activity log. Required when
log_destination_typeiscloudwatch. Valid log types areconnectionlog,userlog, anduseractivitylog.- S3Key
Prefix 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 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
- Log
Destination stringType The log destination type. An enum with possible values of
s3andcloudwatch.- Log
Exports []string The collection of exported log types. Log types include the connection log, user log and user activity log. Required when
log_destination_typeiscloudwatch. Valid log types areconnectionlog,userlog, anduseractivitylog.- S3Key
Prefix 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.
- bucket
Name 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
- log
Destination StringType The log destination type. An enum with possible values of
s3andcloudwatch.- log
Exports List<String> The collection of exported log types. Log types include the connection log, user log and user activity log. Required when
log_destination_typeiscloudwatch. Valid log types areconnectionlog,userlog, anduseractivitylog.- s3Key
Prefix 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.
- bucket
Name 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
- log
Destination stringType The log destination type. An enum with possible values of
s3andcloudwatch.- log
Exports string[] The collection of exported log types. Log types include the connection log, user log and user activity log. Required when
log_destination_typeiscloudwatch. Valid log types areconnectionlog,userlog, anduseractivitylog.- s3Key
Prefix 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_ strtype The log destination type. An enum with possible values of
s3andcloudwatch.- 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_typeiscloudwatch. Valid log types areconnectionlog,userlog, anduseractivitylog.- s3_
key_ strprefix 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.
- bucket
Name 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
- log
Destination StringType The log destination type. An enum with possible values of
s3andcloudwatch.- log
Exports List<String> The collection of exported log types. Log types include the connection log, user log and user activity log. Required when
log_destination_typeiscloudwatch. Valid log types areconnectionlog,userlog, anduseractivitylog.- s3Key
Prefix String The prefix applied to the log file names.
ClusterSnapshotCopy, ClusterSnapshotCopyArgs
- Destination
Region string The destination region that you want to copy snapshots to.
- Grant
Name string 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.
- Destination
Region string The destination region that you want to copy snapshots to.
- Grant
Name string 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.
- destination
Region String The destination region that you want to copy snapshots to.
- grant
Name String 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 Integer 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 string The destination region that you want to copy snapshots to.
- grant
Name string 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 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.
- destination
Region String The destination region that you want to copy snapshots to.
- grant
Name String 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 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
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
awsTerraform Provider.
Try AWS Native preview for resources not in the classic version.