Class ClusterArgs
Inherited Members
Namespace: Pulumi.Aws.RedShift
Assembly: Pulumi.Aws.dll
Syntax
public sealed class ClusterArgs : ResourceArgs
Constructors
View SourceClusterArgs()
Declaration
public ClusterArgs()
Properties
View SourceAllowVersionUpgrade
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
Declaration
public Input<bool> AllowVersionUpgrade { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.Boolean> |
AutomatedSnapshotRetentionPeriod
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.
Declaration
public Input<int> AutomatedSnapshotRetentionPeriod { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.Int32> |
AvailabilityZone
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.
Declaration
public Input<string> AvailabilityZone { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
ClusterIdentifier
The Cluster Identifier. Must be a lower case string.
Declaration
public Input<string> ClusterIdentifier { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
ClusterParameterGroupName
The name of the parameter group to be associated with this cluster.
Declaration
public Input<string> ClusterParameterGroupName { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
ClusterPublicKey
The public key for the cluster
Declaration
public Input<string> ClusterPublicKey { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
ClusterRevisionNumber
The specific revision number of the database in the cluster
Declaration
public Input<string> ClusterRevisionNumber { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
ClusterSecurityGroups
A list of security groups to be associated with this cluster.
Declaration
public InputList<string> ClusterSecurityGroups { get; set; }
Property Value
| Type | Description |
|---|---|
| InputList<System.String> |
ClusterSubnetGroupName
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).
Declaration
public Input<string> ClusterSubnetGroupName { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
ClusterType
The cluster type to use. Either single-node or multi-node.
Declaration
public Input<string> ClusterType { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
ClusterVersion
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.
Declaration
public Input<string> ClusterVersion { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
DatabaseName
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.
Declaration
public Input<string> DatabaseName { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
ElasticIp
The Elastic IP (EIP) address for the cluster.
Declaration
public Input<string> ElasticIp { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
Encrypted
If true , the data in the cluster is encrypted at rest.
Declaration
public Input<bool> Encrypted { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.Boolean> |
Endpoint
The connection endpoint
Declaration
public Input<string> Endpoint { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
EnhancedVpcRouting
If true , enhanced VPC routing is enabled.
Declaration
public Input<bool> EnhancedVpcRouting { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.Boolean> |
FinalSnapshotIdentifier
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.
Declaration
public Input<string> FinalSnapshotIdentifier { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
IamRoles
A list of IAM Role ARNs to associate with the cluster. A Maximum of 10 can be associated to the cluster at any time.
Declaration
public InputList<string> IamRoles { get; set; }
Property Value
| Type | Description |
|---|---|
| InputList<System.String> |
KmsKeyId
The ARN for the KMS encryption key. When specifying kms_key_id, encrypted needs to be set to true.
Declaration
public Input<string> KmsKeyId { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
Logging
Logging, documented below.
Declaration
public Input<ClusterLoggingArgs> Logging { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<ClusterLoggingArgs> |
MasterPassword
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.
Declaration
public Input<string> MasterPassword { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
MasterUsername
Username for the master DB user.
Declaration
public Input<string> MasterUsername { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
NodeType
The node type to be provisioned for the cluster.
Declaration
public Input<string> NodeType { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
NumberOfNodes
The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as multi-node. Default is 1.
Declaration
public Input<int> NumberOfNodes { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.Int32> |
OwnerAccount
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.
Declaration
public Input<string> OwnerAccount { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
Port
The port number on which the cluster accepts incoming connections. The cluster is accessible only via the JDBC and ODBC connection strings. Part of the connection string requires the port on which the cluster will listen for incoming connections. Default port is 5439.
Declaration
public Input<int> Port { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.Int32> |
PreferredMaintenanceWindow
The weekly time range (in UTC) during which automated cluster maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi
Declaration
public Input<string> PreferredMaintenanceWindow { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
PubliclyAccessible
If true, the cluster can be accessed from a public network. Default is true.
Declaration
public Input<bool> PubliclyAccessible { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.Boolean> |
SkipFinalSnapshot
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.
Declaration
public Input<bool> SkipFinalSnapshot { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.Boolean> |
SnapshotClusterIdentifier
The name of the cluster the source snapshot was created from.
Declaration
public Input<string> SnapshotClusterIdentifier { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
SnapshotCopy
Configuration of automatic copy of snapshots from one region to another. Documented below.
Declaration
public Input<ClusterSnapshotCopyArgs> SnapshotCopy { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<ClusterSnapshotCopyArgs> |
SnapshotIdentifier
The name of the snapshot from which to create the new cluster.
Declaration
public Input<string> SnapshotIdentifier { get; set; }
Property Value
| Type | Description |
|---|---|
| Input<System.String> |
Tags
A map of tags to assign to the resource.
Declaration
public InputMap<object> Tags { get; set; }
Property Value
| Type | Description |
|---|---|
| InputMap<System.Object> |
VpcSecurityGroupIds
A list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.
Declaration
public InputList<string> VpcSecurityGroupIds { get; set; }
Property Value
| Type | Description |
|---|---|
| InputList<System.String> |