create-cluster

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.

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

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

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: dc2.large | dc2.8xlarge | ra3.large | ra3.xlplus | ra3.4xlarge | ra3.16xlarge

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.

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

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

Default: The default cluster security group for Amazon Redshift.

(string)

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.

(string)

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

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.

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.

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.

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.

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 dc2 nodes - Select a port within the range 1150-65535 .

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

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

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.

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

Default: false

If true , the data in the cluster is encrypted at rest. If you set the value on this parameter to false , the request will fail.

Default: true

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.

A list of tag instances.

(structure)

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

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 .

(string)

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

Possible values:

• enabled
• disabled
• auto

Create a Cluster with Minimal Parameters

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

Command:

aws redshift create-cluster --node-type dw.hs1.xlarge --number-of-nodes 2 --master-username adminuser --master-user-password TopSecret1 --cluster-identifier mycluster

Result:

{
   "Cluster": {
      "NodeType": "dw.hs1.xlarge",
      "ClusterVersion": "1.0",
      "PubliclyAccessible": "true",
      "MasterUsername": "adminuser",
      "ClusterParameterGroups": [
         {
            "ParameterApplyStatus": "in-sync",
            "ParameterGroupName": "default.redshift-1.0"
         } ],
      "ClusterSecurityGroups": [
         {
            "Status": "active",
            "ClusterSecurityGroupName": "default"
         } ],
      "AllowVersionUpgrade": true,
      "VpcSecurityGroups": \[],
      "PreferredMaintenanceWindow": "sat:03:30-sat:04:00",
      "AutomatedSnapshotRetentionPeriod": 1,
      "ClusterStatus": "creating",
      "ClusterIdentifier": "mycluster",
      "DBName": "dev",
      "NumberOfNodes": 2,
      "PendingModifiedValues": {
         "MasterUserPassword": "\****"
      }
   },
   "ResponseMetadata": {
      "RequestId": "7cf4bcfc-64dd-11e2-bea9-49e0ce183f07"
   }
}

Describes a cluster.

ClusterIdentifier -> (string)

NodeType -> (string)

ClusterStatus -> (string)

ClusterAvailabilityStatus -> (string)

ModifyStatus -> (string)

MasterUsername -> (string)

DBName -> (string)

Endpoint -> (structure)

ClusterCreateTime -> (timestamp)

AutomatedSnapshotRetentionPeriod -> (integer)

ManualSnapshotRetentionPeriod -> (integer)

ClusterSecurityGroups -> (list)

VpcSecurityGroups -> (list)

ClusterParameterGroups -> (list)

ClusterSubnetGroupName -> (string)

VpcId -> (string)

AvailabilityZone -> (string)

PreferredMaintenanceWindow -> (string)

PendingModifiedValues -> (structure)

ClusterVersion -> (string)

AllowVersionUpgrade -> (boolean)

NumberOfNodes -> (integer)

PubliclyAccessible -> (boolean)

Encrypted -> (boolean)

RestoreStatus -> (structure)

DataTransferProgress -> (structure)

HsmStatus -> (structure)

ClusterSnapshotCopyStatus -> (structure)

ClusterPublicKey -> (string)

ClusterNodes -> (list)

ElasticIpStatus -> (structure)

ClusterRevisionNumber -> (string)

Tags -> (list)

KmsKeyId -> (string)

EnhancedVpcRouting -> (boolean)

IamRoles -> (list)

PendingActions -> (list)

MaintenanceTrackName -> (string)

ElasticResizeNumberOfNodeOptions -> (string)

DeferredMaintenanceWindows -> (list)

SnapshotScheduleIdentifier -> (string)

SnapshotScheduleState -> (string)

ExpectedNextSnapshotScheduleTime -> (timestamp)

ExpectedNextSnapshotScheduleTimeStatus -> (string)

NextMaintenanceWindowStartTime -> (timestamp)

ResizeInfo -> (structure)

AvailabilityZoneRelocationStatus -> (string)

ClusterNamespaceArn -> (string)

TotalStorageCapacityInMegaBytes -> (long)

AquaConfiguration -> (structure)

DefaultIamRoleArn -> (string)

ReservedNodeExchangeStatus -> (structure)

CustomDomainName -> (string)

CustomDomainCertificateArn -> (string)

CustomDomainCertificateExpiryDate -> (timestamp)

MasterPasswordSecretArn -> (string)

MasterPasswordSecretKmsKeyId -> (string)

IpAddressType -> (string)

MultiAZ -> (string)

MultiAZSecondary -> (structure)