Cluster
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
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
Redshift Clusters can be imported using the cluster_identifier, e.g.,
$ pulumi import aws:redshift/cluster:Cluster myprodcluster tf-redshift-cluster-12345Constructors
Properties
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.
Specifies whether any cluster modifications are applied immediately, or during the next maintenance window. Default is false.
The value represents how the cluster is configured to use AQUA (Advanced Query Accelerator) after the cluster is restored. Possible values are enabled, disabled, and auto. Requires Cluster reboot.
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.
The EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster. For example, if you have several EC2 instances running in a specific Availability Zone, then you might want the cluster to be provisioned in the same zone in order to decrease network latency. Can only be changed if availability_zone_relocation_enabled is true.
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.
The Cluster Identifier. Must be a lower case string.
The name of the parameter group to be associated with this cluster.
The public key for the cluster
The specific revision number of the database in the cluster
A list of security groups to be associated with this cluster.
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).
The cluster type to use. Either single-node or multi-node.
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.
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.
The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.
If true , enhanced VPC routing is enabled.
The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, skip_final_snapshot must be false.
Logging, documented below.
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.
The default number of days to retain a manual snapshot. If the value is -1, the snapshot is retained indefinitely. This setting doesn't change the retention period of existing snapshots. Valid values are between -1 and 3653. Default value is -1.
Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file. Password must contain at least 8 chars and contain at least one uppercase letter, one lowercase letter, and one number.
Username for the master DB user.
The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
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.
The port number on which the cluster accepts incoming connections. Valid values are between 1115 and 65535. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is 5439.
The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
If true, the cluster can be accessed from a public network. Default is true.
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.
The name of the cluster the source snapshot was created from.
Configuration of automatic copy of snapshots from one region to another. Documented below.
The name of the snapshot from which to create the new cluster.
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.