Menu
Amazon Redshift
API Reference (API Version 2012-12-01)

CreateCluster

Creates a new cluster.

To create the 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.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

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

Type: String

Required: Yes

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.

Type: String

Required: Yes

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.

Type: String

Required: Yes

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: ds1.xlarge | ds1.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge

Type: String

Required: Yes

AdditionalInfo

Reserved.

Type: String

Required: No

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

Type: Boolean

Required: No

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

Constraints: Must be a value from 0 to 35.

Type: Integer

Required: No

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-1d

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

Type: String

Required: No

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.

Type: String

Required: No

ClusterSecurityGroups.ClusterSecurityGroupName.N

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

Default: The default cluster security group for Amazon Redshift.

Type: Array of strings

Required: No

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

Type: String

Required: No

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

Type: String

Required: No

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

Type: String

Required: No

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.

Type: String

Required: No

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

Type: String

Required: No

Encrypted

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

Default: false

Type: Boolean

Required: No

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

Type: Boolean

Required: No

HsmClientCertificateIdentifier

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

Type: String

Required: No

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.

Type: String

Required: No

IamRoles.IamRoleArn.N

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

A cluster can have up to 10 IAM roles associated with it at any time.

Type: Array of strings

Required: No

KmsKeyId

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

Type: String

Required: No

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.

Type: Integer

Required: No

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: 1150-65535

Type: Integer

Required: No

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.

Type: String

Required: No

PubliclyAccessible

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

Type: Boolean

Required: No

Tags.Tag.N

A list of tag instances.

Type: Array of Tag objects

Required: No

VpcSecurityGroupIds.VpcSecurityGroupId.N

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.

Type: Array of strings

Required: No

Response Elements

The following element is returned by the service.

Cluster

Describes a cluster.

Type: Cluster object

Errors

For information about the errors that are common to all actions, see Common Errors.

ClusterAlreadyExists

The account already has a cluster with the given identifier.

HTTP Status Code: 400

ClusterParameterGroupNotFound

The parameter group name does not refer to an existing parameter group.

HTTP Status Code: 404

ClusterQuotaExceeded

The request would exceed the allowed number of cluster instances for this account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

HTTP Status Code: 400

ClusterSecurityGroupNotFound

The cluster security group name does not refer to an existing cluster security group.

HTTP Status Code: 404

ClusterSubnetGroupNotFoundFault

The cluster subnet group name does not refer to an existing cluster subnet group.

HTTP Status Code: 400

DependentServiceRequestThrottlingFault

The request cannot be completed because a dependent service is throttling requests made by Amazon Redshift on your behalf. Wait and retry the request.

HTTP Status Code: 400

HsmClientCertificateNotFoundFault

There is no Amazon Redshift HSM client certificate with the specified identifier.

HTTP Status Code: 400

HsmConfigurationNotFoundFault

There is no Amazon Redshift HSM configuration with the specified identifier.

HTTP Status Code: 400

InsufficientClusterCapacity

The number of nodes specified exceeds the allotted capacity of the cluster.

HTTP Status Code: 400

InvalidClusterSubnetGroupStateFault

The cluster subnet group cannot be deleted because it is in use.

HTTP Status Code: 400

InvalidElasticIpFault

The Elastic IP (EIP) is invalid or cannot be found.

HTTP Status Code: 400

InvalidSubnet

The requested subnet is not valid, or not all of the subnets are in the same VPC.

HTTP Status Code: 400

InvalidTagFault

The tag is invalid.

HTTP Status Code: 400

InvalidVPCNetworkStateFault

The cluster subnet group does not cover all Availability Zones.

HTTP Status Code: 400

LimitExceededFault

The encryption key has exceeded its grant limit in AWS KMS.

HTTP Status Code: 400

NumberOfNodesPerClusterLimitExceeded

The operation would exceed the number of nodes allowed for a cluster.

HTTP Status Code: 400

NumberOfNodesQuotaExceeded

The operation would exceed the number of nodes allotted to the account. For information about increasing your quota, go to Limits in Amazon Redshift in the Amazon Redshift Cluster Management Guide.

HTTP Status Code: 400

TagLimitExceededFault

The request exceeds the limit of 10 tags for the resource.

HTTP Status Code: 400

UnauthorizedOperation

Your account is not authorized to perform the requested operation.

HTTP Status Code: 400

Examples

Example

Create a non-VPC cluster.

Sample Request

https://redshift.us-east-1.amazonaws.com/ ?Action=CreateCluster &ClusterIdentifier=examplecluster &MasterUsername=masteruser &MasterUserPassword=12345678Aa &NumberOfNodes=2 &NodeType=ds2.xlarge &Version=2012-12-01 &x-amz-algorithm=AWS4-HMAC-SHA256 &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request &x-amz-date=20130123T000028Z &x-amz-signedheaders=content-type;host;x-amz-date

Sample Response

<CreateClusterResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <CreateClusterResult> <Cluster> <PendingModifiedValues> <MasterUserPassword>****</MasterUserPassword> </PendingModifiedValues> <ClusterVersion>1.0</ClusterVersion> <VpcSecurityGroups/> <ClusterStatus>creating</ClusterStatus> <NumberOfNodes>2</NumberOfNodes> <AutomatedSnapshotRetentionPeriod>1</AutomatedSnapshotRetentionPeriod> <PubliclyAccessible>true</PubliclyAccessible> <Encrypted>false</Encrypted> <EnhancedVpcRouting>false</EnhancedVpcRouting> <DBName>dev</DBName> <PreferredMaintenanceWindow>sun:10:30-sun:11:00</PreferredMaintenanceWindow> <ClusterParameterGroups> <ClusterParameterGroup> <ParameterApplyStatus>in-sync</ParameterApplyStatus> <ParameterGroupName>default.redshift-1.0</ParameterGroupName> </ClusterParameterGroup> </ClusterParameterGroups> <ClusterSecurityGroups> <ClusterSecurityGroup> <Status>active</Status> <ClusterSecurityGroupName>default</ClusterSecurityGroupName> </ClusterSecurityGroup> </ClusterSecurityGroups> <NodeType>ds2.xlarge</NodeType> <ClusterIdentifier>examplecluster</ClusterIdentifier> <AllowVersionUpgrade>true</AllowVersionUpgrade> <MasterUsername>masteruser</MasterUsername> </Cluster> </CreateClusterResult> <ResponseMetadata> <RequestId>e69b1294-64ef-11e2-b07c-f7fbdd006c67</RequestId> </ResponseMetadata> </CreateClusterResponse>

Example

Create cluster in virtual private cloud (VPC). This example request specifies a ClusterSubnetGroupName to identify the subnets that can be used when creating the cluster.

Sample Request

https://redshift.us-east-1.amazonaws.com/ ?Action=CreateCluster &ClusterIdentifier=exampleclusterinvpc &MasterUsername=master &MasterUserPassword=1234abcdA &NodeType=ds2.xlarge &NumberOfNodes=2 &ClusterSubnetGroupName=mysubnetgroup1 &Version=2012-12-01 &x-amz-algorithm=AWS4-HMAC-SHA256 &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request &x-amz-date=20130123T000028Z &x-amz-signedheaders=content-type;host;x-amz-date

Sample Response

<CreateClusterResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/"> <CreateClusterResult> <Cluster> <PendingModifiedValues> <MasterUserPassword>****</MasterUserPassword> </PendingModifiedValues> <ClusterSubnetGroupName>mysubnetgroup1</ClusterSubnetGroupName> <ClusterVersion>1.0</ClusterVersion> <VpcSecurityGroups/> <ClusterStatus>creating</ClusterStatus> <NumberOfNodes>2</NumberOfNodes> <AutomatedSnapshotRetentionPeriod>1</AutomatedSnapshotRetentionPeriod> <PubliclyAccessible>false</PubliclyAccessible> <Encrpyted>false</Encrypted> <EnhancedVpcRouting>false</EnhancedVpcRouting> <DBName>dev</DBName> <PreferredMaintenanceWindow>sat:08:30-sat:09:00</PreferredMaintenanceWindow> <ClusterParameterGroups> <ClusterParameterGroup> <ParameterApplyStatus>in-sync</ParameterApplyStatus> <ParameterGroupName>default.redshift-1.0</ParameterGroupName> </ClusterParameterGroup> </ClusterParameterGroups> <VpcId>vpc-796a5913</VpcId> <ClusterSecurityGroups/> <NodeType>ds2.xlarge</NodeType> <ClusterIdentifier>exampleclusterinvpc</ClusterIdentifier> <AllowVersionUpgrade>true</AllowVersionUpgrade> <MasterUsername>master</MasterUsername> </Cluster> </CreateClusterResult> <ResponseMetadata> <RequestId>fa337bb4-6a4d-11e2-a12a-cb8076a904bd</RequestId> </ResponseMetadata> </CreateClusterResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: