aws redshift create-cluster

Creates a new cluster with the specified parameters. AWS CLI reference

1 example 41 options Its page in the AWS CLI reference

Examples

from aws-cli, each command read by CmdID

To create a cluster with minimal parameters

The following create-cluster example creates a cluster with the minimal set of parameters. By default, the output is in JSON format.

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

Identify

--node-typeThe node type to be provisioned for the cluster.

--number-of-nodesThe number of compute nodes in the cluster.

--master-usernameThe user name associated with the admin user account for the cluster that is being created.

--master-user-passwordThe password associated with the admin user account for the cluster that is being created.

--cluster-identifierA unique identifier for the cluster.

Its output

{
    "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": "****"
        }
    }
}

For more information, see Creating a cluster in the Amazon Redshift Management Guide.

Options

41 in the AWS CLI reference

Show its 41 options

--additional-infoReserved.

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

--aqua-configuration-statusThis parameter is retired.

--automated-snapshot-retention-periodThe number of days that automated snapshots are retained.

--availability-zone-relocationThe option to enable relocation for an Amazon Redshift cluster between Availability Zones after the cluster is created.

--availability-zoneThe EC2 Availability Zone (AZ) in which you want Amazon Redshift to provision the cluster.

--catalog-nameThe name of the Glue data catalog that will be associated with the cluster enabled with Amazon Redshift federated permissions.

--cluster-identifierA unique identifier for the cluster.

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

--cluster-security-groupsA list of security groups to be associated with this cluster.

--cluster-subnet-group-nameThe name of a cluster subnet group to be associated with this cluster.

--cluster-typeThe type of the cluster.

--cluster-versionThe version of the Amazon Redshift engine software that you want to deploy on the cluster.

--db-nameThe name of the first database to be created when the cluster is created.

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

--elastic-ipThe Elastic IP (EIP) address for the cluster.

--encryptedIf true, the data in the cluster is encrypted at rest.

--enhanced-vpc-routingAn option that specifies whether to create the cluster with enhanced VPC routing enabled.

--extra-compute-for-automatic-optimizationIf true, allocates additional compute resources for running automatic optimization operations.

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

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

--iam-rolesA list of Identity and Access Management (IAM) roles that can be used by the cluster to access other Amazon Web Services services.

--ip-address-typeThe IP address types that the cluster supports.

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

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

--maintenance-track-nameAn optional parameter for the name of the maintenance track for the cluster.

--manage-master-passwordIf true, Amazon Redshift uses Secrets Manager to manage this cluster's admin credentials.

--manual-snapshot-retention-periodThe default number of days to retain a manual snapshot.

--master-password-secret-kms-key-idThe ID of the Key Management Service (KMS) key used to encrypt and store the cluster's admin credentials secret.

--master-user-passwordThe password associated with the admin user account for the cluster that is being created.

--master-usernameThe user name associated with the admin user account for the cluster that is being created.

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

--node-typeThe node type to be provisioned for the cluster.

--number-of-nodesThe number of compute nodes in the cluster.

--portThe port number on which the cluster accepts incoming connections.

--preferred-maintenance-windowThe weekly time range (in UTC) during which automated cluster maintenance can occur.

--publicly-accessibleIf true, the cluster can be accessed from a public network.

--redshift-idc-application-arnThe Amazon resource name (ARN) of the Amazon Redshift IAM Identity Center application.

--snapshot-schedule-identifierA unique identifier for the snapshot schedule.

--tagsA list of tag instances.

--vpc-security-group-idsA list of Virtual Private Cloud (VPC) security groups to be associated with the cluster.