AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateCluster operation. Creates a new cluster with the specified parameters.

To create a cluster in Virtual Private Cloud (VPC), you must provide a cluster subnet group name. The cluster subnet group identifies the subnets of your VPC that Amazon Redshift uses when creating the cluster. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Redshift.AmazonRedshiftRequest
      Amazon.Redshift.Model.CreateClusterRequest

Namespace: Amazon.Redshift.Model
Assembly: AWSSDK.Redshift.dll
Version: 3.x.y.z

Syntax

C# 
public class CreateClusterRequest : AmazonRedshiftRequest
         IAmazonWebServiceRequest

The CreateClusterRequest type exposes the following members

Constructors

NameDescription
Public Method CreateClusterRequest()

Properties

NameTypeDescription
Public Property AdditionalInfo System.String

Gets and sets the property AdditionalInfo.

Reserved.

Public Property AllowVersionUpgrade System.Boolean

Gets and sets the property AllowVersionUpgrade.

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

When a new major 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: true
Public Property AquaConfigurationStatus Amazon.Redshift.AquaConfigurationStatus

Gets and sets the property AquaConfigurationStatus.

This parameter is retired. It does not set the AQUA configuration status. Amazon Redshift automatically determines whether to use AQUA (Advanced Query Accelerator).

Public Property AutomatedSnapshotRetentionPeriod System.Int32

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.

You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.

Default: 1

Constraints: Must be a value from 0 to 35.

Public Property AvailabilityZone System.String

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: us-east-2d

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

Public Property AvailabilityZoneRelocation System.Boolean

Gets and sets the property AvailabilityZoneRelocation.

The option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

Public Property ClusterIdentifier System.String

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 Amazon Web Services account.

Example: myexamplecluster
Public Property ClusterParameterGroupName System.String

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.

Public Property ClusterSecurityGroups System.Collections.Generic.List<System.String>

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.

Public Property ClusterSubnetGroupName System.String

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

Public Property ClusterType System.String

Gets and sets the property ClusterType.

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

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

  • multi-node, the NumberOfNodes parameter is required.

Valid Values: multi-node | single-node

Default: multi-node
Public Property ClusterVersion System.String

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: 1.0
Public Property DBName System.String

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

Public Property DefaultIamRoleArn System.String

Gets and sets the property DefaultIamRoleArn.

The Amazon Resource Name (ARN) for the IAM role that was set as default for the cluster when the cluster was created.

Public Property ElasticIp System.String

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. Don't specify the Elastic IP address for a publicly accessible cluster with availability zone relocation turned on. For more information about provisioning clusters in EC2-VPC, go to Supported Platforms to Launch Your Cluster in the Amazon Redshift Cluster Management Guide.

Public Property Encrypted System.Boolean

Gets and sets the property Encrypted.

If true, the data in the cluster is encrypted at rest.

Default: false

Public Property EnhancedVpcRouting System.Boolean

Gets and sets the property EnhancedVpcRouting.

An option that specifies whether to create the cluster with enhanced VPC routing enabled. To create a cluster that uses enhanced VPC routing, the cluster must be in a VPC. For more information, see Enhanced VPC Routing in the Amazon Redshift Cluster Management Guide.

If this option is true, enhanced VPC routing is enabled.

Default: false

Public Property HsmClientCertificateIdentifier System.String

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.

Public Property HsmConfigurationIdentifier System.String

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.

Public Property IamRoles System.Collections.Generic.List<System.String>

Gets and sets the property IamRoles.

A list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services. You must supply the IAM roles in their Amazon Resource Name (ARN) format.

The maximum number of IAM roles that you can associate is subject to a quota. For more information, go to Quotas and limits in the Amazon Redshift Cluster Management Guide.

Public Property IpAddressType System.String

Gets and sets the property IpAddressType.

The IP address types that the cluster supports. Possible values are ipv4 and dualstack.

Public Property KmsKeyId System.String

Gets and sets the property KmsKeyId.

The Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.

Public Property LoadSampleData System.String

Gets and sets the property LoadSampleData.

A flag that specifies whether to load sample data once the cluster is created.

Public Property MaintenanceTrackName System.String

Gets and sets the property MaintenanceTrackName.

An optional parameter for the name of the maintenance track for the cluster. If you don't provide a maintenance track name, the cluster is assigned to the current track.

Public Property ManageMasterPassword System.Boolean

Gets and sets the property ManageMasterPassword.

If true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials. You can't use MasterUserPassword if ManageMasterPassword is true. If ManageMasterPassword is false or not set, Amazon Redshift uses MasterUserPassword for the admin user account's password.

Public Property ManualSnapshotRetentionPeriod System.Int32

Gets and sets the property ManualSnapshotRetentionPeriod.

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.

The value must be either -1 or an integer between 1 and 3,653.

Public Property MasterPasswordSecretKmsKeyId System.String

Gets and sets the property MasterPasswordSecretKmsKeyId.

The ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret. You can only use this parameter if ManageMasterPassword is true.

Public Property MasterUsername System.String

Gets and sets the property MasterUsername.

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

Constraints:

  • Must be 1 - 128 alphanumeric characters or hyphens. The user name can't be PUBLIC.

  • Must contain only lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen.

  • The first character must be a letter.

  • Must not contain a colon (:) or a slash (/).

  • Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.

Public Property MasterUserPassword System.String

Gets and sets the property MasterUserPassword.

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

You can't use MasterUserPassword if ManageMasterPassword is true.

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-126) except ' (single quote), " (double quote), \, /, or @.

Public Property MultiAZ System.Boolean

Gets and sets the property MultiAZ.

If true, Amazon Redshift will deploy the cluster in two Availability Zones (AZ).

Public Property NodeType System.String

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 Cluster Management Guide.

Valid Values: ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge | ra3.xlplus | ra3.4xlarge | ra3.16xlarge
Public Property NumberOfNodes System.Int32

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

For information about determining how many nodes you need, go to Working with Clusters in the Amazon Redshift Cluster 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: 1

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

Public Property Port System.Int32

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: 5439

Valid Values:

  • For clusters with ra3 nodes - Select a port within the ranges 5431-5455 or 8191-8215. (If you have an existing cluster with ra3 nodes, it isn't required that you change the port to these ranges.)

  • For clusters with ds2 or dc2 nodes - Select a port within the range 1150-65535.

Public Property PreferredMaintenanceWindow System.String

Gets and sets the property PreferredMaintenanceWindow.

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

Format: 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. For more information about the time blocks for each region, see Maintenance Windows in Amazon Redshift Cluster Management Guide.

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

Constraints: Minimum 30-minute window.

Public Property PubliclyAccessible System.Boolean

Gets and sets the property PubliclyAccessible.

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

Public Property RedshiftIdcApplicationArn System.String

Gets and sets the property RedshiftIdcApplicationArn.

The Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.

Public Property SnapshotScheduleIdentifier System.String

Gets and sets the property SnapshotScheduleIdentifier.

A unique identifier for the snapshot schedule.

Public Property Tags System.Collections.Generic.List<Amazon.Redshift.Model.Tag>

Gets and sets the property Tags.

A list of tag instances.

Public Property VpcSecurityGroupIds System.Collections.Generic.List<System.String>

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.

Examples

This example creates a cluster with the minimal set of parameters. By default, the output is in JSON format.

To create a cluster with minimal parameters


var client = new AmazonRedshiftClient();
var response = client.CreateCluster(new CreateClusterRequest 
{
    ClusterIdentifier = "mycluster",
    MasterUserPassword = "TopSecret1",
    MasterUsername = "adminuser ",
    NodeType = "dw.hs1.xlarge"
});

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5