AWS Tools for Windows PowerShell
Command 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.

Synopsis

Invokes the CreateCluster operation against Amazon Redshift.

Syntax

New-RSCluster
-DBName <String>
-ClusterIdentifier <String>
-ClusterType <String>
-NodeType <String>
-AdditionalInfo <String>
-AllowVersionUpgrade <Boolean>
-AutomatedSnapshotRetentionPeriod <Int32>
-AvailabilityZone <String>
-ClusterParameterGroupName <String>
-ClusterSecurityGroup <String[]>
-ClusterSubnetGroupName <String>
-ClusterVersion <String>
-ElasticIp <String>
-Encrypted <Boolean>
-EnhancedVpcRouting <Boolean>
-HsmClientCertificateIdentifier <String>
-HsmConfigurationIdentifier <String>
-IamRole <String[]>
-KmsKeyId <String>
-MasterUsername <String>
-MasterUserPassword <String>
-NumberOfNodes <Int32>
-Port <Int32>
-PreferredMaintenanceWindow <String>
-PubliclyAccessible <Boolean>
-Tag <Tag[]>
-VpcSecurityGroupId <String[]>
-Force <SwitchParameter>

Description

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.

Parameters

-AdditionalInfo <String>
Reserved.
Required?False
Position?Named
Accept pipeline input?False
-AllowVersionUpgrade <Boolean>
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
Required?False
Position?Named
Accept pipeline input?False
-AutomatedSnapshotRetentionPeriod <Int32>
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: 1Constraints: Must be a value from 0 to 35.
Required?False
Position?Named
Accept pipeline input?False
-AvailabilityZone <String>
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-1dConstraint: The specified Availability Zone must be in the same region as the current endpoint.
Required?False
Position?Named
Accept pipeline input?False
-ClusterIdentifier <String>
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
Required?False
Position?2
Accept pipeline input?True (ByPropertyName)
-ClusterParameterGroupName <String>
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 GroupsConstraints:
  • 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.
Required?False
Position?Named
Accept pipeline input?False
-ClusterSecurityGroup <String[]>
A list of security groups to be associated with this cluster.Default: The default cluster security group for Amazon Redshift.
Required?False
Position?Named
Accept pipeline input?False
-ClusterSubnetGroupName <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).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterType <String>
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-nodeDefault: multi-node
Required?False
Position?3
Accept pipeline input?False
-ClusterVersion <String>
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
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DBName <String>
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: devConstraints:
  • 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.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ElasticIp <String>
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.
Required?False
Position?Named
Accept pipeline input?False
-Encrypted <Boolean>
If true, the data in the cluster is encrypted at rest. Default: false
Required?False
Position?Named
Accept pipeline input?False
-EnhancedVpcRouting <Boolean>
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
Required?False
Position?Named
Accept pipeline input?False
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-HsmClientCertificateIdentifier <String>
Specifies the name of the HSM client certificate the Amazon Redshift cluster uses to retrieve the data encryption keys stored in an HSM.
Required?False
Position?Named
Accept pipeline input?False
-HsmConfigurationIdentifier <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IamRole <String[]>
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.
Required?False
Position?Named
Accept pipeline input?False
-KmsKeyId <String>
The AWS Key Management Service (KMS) key ID of the encryption key that you want to use to encrypt data in the cluster.
Required?False
Position?Named
Accept pipeline input?False
-MasterUsername <String>
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.
Required?False
Position?Named
Accept pipeline input?False
-MasterUserPassword <String>
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.
Required?False
Position?Named
Accept pipeline input?False
-NodeType <String>
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.
Required?False
Position?4
Accept pipeline input?False
-NumberOfNodes <Int32>
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: 1Constraints: Value must be at least 1 and no more than 100.
Required?False
Position?Named
Accept pipeline input?False
-Port <Int32>
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: 5439Valid Values: 1150-65535
Required?False
Position?Named
Accept pipeline input?False
-PreferredMaintenanceWindow <String>
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 | SunConstraints: Minimum 30-minute window.
Required?False
Position?Named
Accept pipeline input?False
-PubliclyAccessible <Boolean>
If true, the cluster can be accessed from a public network.
Required?False
Position?Named
Accept pipeline input?False
-Tag <Tag[]>
A list of tag instances.
Required?False
Position?Named
Accept pipeline input?False
-VpcSecurityGroupId <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.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String object to this cmdlet for the DBName parameter.

Outputs

This cmdlet returns a Cluster object. The service call response (type Amazon.Redshift.Model.CreateClusterResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z