AWS SDK for .NET Documentation
CreateClusterRequest Class
AmazonAmazon.Redshift.ModelCreateClusterRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the CreateCluster operation. Creates a new cluster. To create the cluster in virtual private cloud (VPC), you must provide cluster subnet group name. If you don't provide a cluster subnet group name or the cluster security group parameter, Amazon Redshift creates a non-VPC cluster, it associates the default cluster security group with the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Management Guide.
Declaration Syntax
C#
public class CreateClusterRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
CreateClusterRequest()()()()
Initializes a new instance of the CreateClusterRequest class

AllowVersionUpgrade
Gets and sets the property AllowVersionUpgrade.

If

CopyC#
true
, upgrades can be applied during the maintenance window to the Amazon Redshift engine that is running on the cluster.

When a new version of the Amazon Redshift engine is released, you can request that the service automatically apply upgrades during the maintenance window to the Amazon Redshift engine that is running on your cluster.

Default:

CopyC#
true


AutomatedSnapshotRetentionPeriod
Gets and sets the property 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 CreateClusterSnapshot.

Default:

CopyC#
1

Constraints: Must be a value from 0 to 35.


AvailabilityZone
Gets and sets the property 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.

Default: A random, system-chosen Availability Zone in the region that is specified by the endpoint.

Example:

CopyC#
us-east-1d

Constraint: The specified Availability Zone must be in the same region as the current endpoint.


ClusterIdentifier
Gets and sets the property ClusterIdentifier.

A unique identifier for the cluster. You use this identifier to refer to the cluster for any subsequent cluster operations such as deleting or modifying. The identifier also appears in the Amazon Redshift console.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.
  • Alphabetic characters must be lowercase.
  • First character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.
  • Must be unique for all clusters within an AWS account.

Example:

CopyC#
myexamplecluster


ClusterParameterGroupName
Gets and sets the property ClusterParameterGroupName.

The name of the parameter group to be associated with this cluster.

Default: The default Amazon Redshift cluster parameter group. For information about the default parameter group, go to Working with Amazon Redshift Parameter Groups

Constraints:

  • Must be 1 to 255 alphanumeric characters or hyphens.
  • First character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

ClusterSecurityGroups
Gets and sets the property ClusterSecurityGroups.

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

Default: The default cluster security group for Amazon Redshift.


ClusterSubnetGroupName
Gets and sets the property 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).


ClusterType
Gets and sets the property ClusterType.

The type of the cluster. When cluster type is specified as

  • CopyC#
    single-node
    , the NumberOfNodes parameter is not required.
  • CopyC#
    multi-node
    , the NumberOfNodes parameter is required.

Valid Values:

CopyC#
multi-node
|
CopyC#
single-node

Default:

CopyC#
multi-node


ClusterVersion
Gets and sets the property 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.

Constraints: Only version 1.0 is currently available.

Example:

CopyC#
1.0


DBName
Gets and sets the property DBName.

The name of the first database to be created when the cluster is created.

To create additional databases after the cluster is created, connect to the cluster with a SQL client and use SQL commands to create a database. For more information, go to Create a Database in the Amazon Redshift Database Developer Guide.

Default:

CopyC#
dev

Constraints:

  • Must contain 1 to 64 alphanumeric characters.
  • Must contain only lowercase letters.
  • Cannot be a word that is reserved by the service. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

ElasticIp
Gets and sets the property ElasticIp.

The Elastic IP (EIP) address for the cluster.

Constraints: The cluster must be provisioned in EC2-VPC and publicly-accessible through an Internet gateway. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Management Guide.


Encrypted
Gets and sets the property Encrypted.

If

CopyC#
true
, the data in the cluster is encrypted at rest.

Default: false


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
HsmClientCertificateIdentifier
Gets and sets the property HsmClientCertificateIdentifier.

Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.


HsmConfigurationIdentifier
Gets and sets the property HsmConfigurationIdentifier.

Specifies the name of the HSM configuration that contains the information the Amazon Redshift cluster can use to retrieve and store keys in an HSM.


MasterUsername
Gets and sets the property MasterUsername.

The user name associated with the master user account for the cluster that is being created.

Constraints:

  • Must be 1 - 128 alphanumeric characters.
  • First character must be a letter.
  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

MasterUserPassword
Gets and sets the property MasterUserPassword.

The password associated with the master user account for the cluster that is being created.

Constraints:

  • Must be between 8 and 64 characters in length.
  • Must contain at least one uppercase letter.
  • Must contain at least one lowercase letter.
  • Must contain one number.
  • Can be any printable ASCII character (ASCII code 33 to 126) except ' (single quote), " (double quote), \, /, @, or space.

NodeType
Gets and sets the property NodeType.

The node type to be provisioned for the cluster. For information about node types, go to Working with Clusters in the Amazon Redshift Management Guide.

Valid Values:

CopyC#
dw1.xlarge
|
CopyC#
dw1.8xlarge
|
CopyC#
dw2.large
|
CopyC#
dw2.8xlarge
.


NumberOfNodes
Gets and sets the property NumberOfNodes.

The number of compute nodes in the cluster. This parameter is required when the ClusterType parameter is specified as

CopyC#
multi-node
.

For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Management Guide.

If you don't specify this parameter, you get a single-node cluster. When requesting a multi-node cluster, you must specify the number of nodes that you want in the cluster.

Default:

CopyC#
1

Constraints: Value must be at least 1 and no more than 100.


Port
Gets and sets the property 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:

CopyC#
5439

Valid Values:

CopyC#
1150-65535


PreferredMaintenanceWindow
Gets and sets the property PreferredMaintenanceWindow.

The weekly time range (in UTC) during which automated cluster maintenance can occur.

Format:

CopyC#
ddd:hh24:mi-ddd:hh24:mi

Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.

  • US-East (Northern Virginia) Region: 03:00-11:00 UTC
  • US-West (Oregon) Region 06:00-14:00 UTC
  • EU (Ireland) Region 22:00-06:00 UTC
  • Asia Pacific (Singapore) Region 14:00-22:00 UTC
  • Asia Pacific (Sydney) Region 12:00-20:00 UTC
  • Asia Pacific (Tokyo) Region 17:00-03:00 UTC

Valid Days: Mon | Tue | Wed | Thu | Fri | Sat | Sun

Constraints: Minimum 30-minute window.


PubliclyAccessible
Gets and sets the property PubliclyAccessible.

If

CopyC#
true
, the cluster can be accessed from a public network.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
VpcSecurityGroupIds
Gets and sets the property VpcSecurityGroupIds.

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

Default: The default VPC security group is associated with the cluster.


WithAllowVersionUpgrade(Boolean) Obsolete.
Sets the AllowVersionUpgrade property

WithAutomatedSnapshotRetentionPeriod(Int32) Obsolete.
Sets the AutomatedSnapshotRetentionPeriod property

WithAvailabilityZone(String) Obsolete.
Sets the AvailabilityZone property

WithClusterIdentifier(String) Obsolete.
Sets the ClusterIdentifier property

WithClusterParameterGroupName(String) Obsolete.
Sets the ClusterParameterGroupName property

WithClusterSecurityGroups(array<String>[]()[][]) Obsolete.
Sets the ClusterSecurityGroups property

WithClusterSecurityGroups(IEnumerable<(Of <<'(String>)>>)) Obsolete.
Sets the ClusterSecurityGroups property

WithClusterSubnetGroupName(String) Obsolete.
Sets the ClusterSubnetGroupName property

WithClusterType(String) Obsolete.
Sets the ClusterType property

WithClusterVersion(String) Obsolete.
Sets the ClusterVersion property

WithDBName(String) Obsolete.
Sets the DBName property

WithElasticIp(String) Obsolete.
Sets the ElasticIp property

WithEncrypted(Boolean) Obsolete.
Sets the Encrypted property

WithHsmClientCertificateIdentifier(String) Obsolete.
Sets the HsmClientCertificateIdentifier property

WithHsmConfigurationIdentifier(String) Obsolete.
Sets the HsmConfigurationIdentifier property

WithMasterUsername(String) Obsolete.
Sets the MasterUsername property

WithMasterUserPassword(String) Obsolete.
Sets the MasterUserPassword property

WithNodeType(String) Obsolete.
Sets the NodeType property

WithNumberOfNodes(Int32) Obsolete.
Sets the NumberOfNodes property

WithPort(Int32) Obsolete.
Sets the Port property

WithPreferredMaintenanceWindow(String) Obsolete.
Sets the PreferredMaintenanceWindow property

WithPubliclyAccessible(Boolean) Obsolete.
Sets the PubliclyAccessible property

WithVpcSecurityGroupIds(array<String>[]()[][]) Obsolete.
Sets the VpcSecurityGroupIds property

WithVpcSecurityGroupIds(IEnumerable<(Of <<'(String>)>>)) Obsolete.
Sets the VpcSecurityGroupIds property

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 CreateClusterRequest

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)