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

ModifyCluster

Modifies the settings for a cluster. For example, you can add another security or parameter group, update the preferred maintenance window, or change the master user password. Resetting a cluster password or modifying the security groups associated with a cluster do not need a reboot. However, modifying a parameter group requires a reboot for parameters to take effect. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide.

You can also change node type and the number of nodes to scale up or down the cluster. When resizing a cluster, you must specify both the number of nodes and the node type even if one of the parameters does not change.

Request Parameters

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

ClusterIdentifier

The unique identifier of the cluster to be modified.

Example: examplecluster

Type: String

Required: Yes

AdditionalInfo

Reserved.

Type: String

Required: No

AllowVersionUpgrade

If true, major version upgrades will be applied automatically to the cluster during the maintenance window.

Default: false

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.

If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.

Default: Uses existing setting.

Constraints: Must be a value from 0 to 35.

Type: Integer

Required: No

ClusterParameterGroupName

The name of the cluster parameter group to apply to this cluster. This change is applied only after the cluster is rebooted. To reboot a cluster use RebootCluster.

Default: Uses existing setting.

Constraints: The cluster parameter group must be in the same parameter group family that matches the cluster version.

Type: String

Required: No

ClusterSecurityGroups.ClusterSecurityGroupName.N

A list of cluster security groups to be authorized on this cluster. This change is asynchronously applied as soon as possible.

Security groups currently associated with the cluster, and not in the list of groups to apply, will be revoked from the cluster.

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: Array of strings

Required: No

ClusterType

The new cluster type.

When you submit your cluster resize request, your existing cluster goes into a read-only mode. After Amazon Redshift provisions a new cluster based on your resize requirements, there will be outage for a period while the old cluster is deleted and your connection is switched to the new cluster. You can use DescribeResize to track the progress of the resize request.

Valid Values: multi-node | single-node

Type: String

Required: No

ClusterVersion

The new version number of the Amazon Redshift engine to upgrade to.

For major version upgrades, if a non-default cluster parameter group is currently in use, a new cluster parameter group in the cluster parameter group family for the new version must be specified. The new cluster parameter group can be the default for that cluster parameter group family. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

Example: 1.0

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

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

MasterUserPassword

The new password for the cluster master user. This change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.

Note

Operations never return the password, so this operation provides a way to regain access to the master user account for a cluster if the password is lost.

Default: Uses existing setting.

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

NewClusterIdentifier

The new identifier for the cluster.

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

Type: String

Required: No

NodeType

The new node type of the cluster. If you specify a new node type, you must also specify the number of nodes parameter.

When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

Valid Values: ds1.xlarge | ds1.8xlarge | ds2.xlarge | ds2.8xlarge | dc1.large | dc1.8xlarge | dc2.large | dc2.8xlarge

Type: String

Required: No

NumberOfNodes

The new number of nodes of the cluster. If you specify a new number of nodes, you must also specify the node type parameter.

When you submit your request to resize a cluster, Amazon Redshift sets access permissions for the cluster to read-only. After Amazon Redshift provisions a new cluster according to your resize requirements, there will be a temporary outage while the old cluster is deleted and your connection is switched to the new cluster. When the new connection is complete, the original access permissions for the cluster are restored. You can use DescribeResize to track the progress of the resize request.

Valid Values: Integer greater than 0.

Type: Integer

Required: No

PreferredMaintenanceWindow

The weekly time range (in UTC) during which system maintenance can occur, if necessary. If system maintenance is necessary during the window, it may result in an outage.

This maintenance window change is made immediately. If the new maintenance window indicates the current time, there must be at least 120 minutes between the current time and end of the window in order to ensure that pending changes are applied.

Default: Uses existing setting.

Format: ddd:hh24:mi-ddd:hh24:mi, for example wed:07:30-wed:08:00.

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

Constraints: Must be at least 30 minutes.

Type: String

Required: No

PubliclyAccessible

If true, the cluster can be accessed from a public network. Only clusters in VPCs can be set to be publicly available.

Type: Boolean

Required: No

VpcSecurityGroupIds.VpcSecurityGroupId.N

A list of virtual private cloud (VPC) security groups to be 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

ClusterNotFound

The ClusterIdentifier parameter does not refer to an existing cluster.

HTTP Status Code: 404

ClusterParameterGroupNotFound

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

HTTP Status Code: 404

ClusterSecurityGroupNotFound

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

HTTP Status Code: 404

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

InvalidClusterSecurityGroupState

The state of the cluster security group is not available.

HTTP Status Code: 400

InvalidClusterState

The specified cluster is not in the available state.

HTTP Status Code: 400

InvalidElasticIpFault

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

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

UnauthorizedOperation

Your account is not authorized to perform the requested operation.

HTTP Status Code: 400

UnsupportedOptionFault

A request option was specified that is not supported.

HTTP Status Code: 400

Example

Sample Request

https://redshift.us-east-1.amazonaws.com/
    ?Action=ModifyCluster
    &AllowVersionUpgrade=true
    &AutomatedSnapshotRetentionPeriod=2
    &ClusterIdentifier=examplecluster
    &ClusterParameterGroupName=parametergroup1
    &PreferredMaintenanceWindow=wed:07:30-wed:08:00
    &Version=2012-12-01
    &x-amz-algorithm=AWS4-HMAC-SHA256
    &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request
    &x-amz-date=20130123T022911Z
    &x-amz-signedheaders=content-type;host;x-amz-date

Sample Response

<ModifyClusterResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
  <ModifyClusterResult>
    <Cluster>
      <PendingModifiedValues/>
      <ClusterVersion>1.0</ClusterVersion>
      <VpcSecurityGroups/>
      <Endpoint>
        <Port>5439</Port>
        <Address>examplecluster.coqoarplqhsn.us-east-1.redshift.amazonaws.com</Address>
      </Endpoint>
      <ClusterStatus>available</ClusterStatus>
      <NumberOfNodes>2</NumberOfNodes>
      <AutomatedSnapshotRetentionPeriod>2</AutomatedSnapshotRetentionPeriod>
      <PubliclyAccessible>true</PubliclyAccessible>
      <Encrypted>false</Encrypted>
      <EnhancedVpcRouting>false</EnhancedVpcRouting>
      <DBName>dev</DBName>
      <PreferredMaintenanceWindow>wed:07:30-wed:08:00</PreferredMaintenanceWindow>
      <ClusterParameterGroups>
        <ClusterParameterGroup>
          <ParameterApplyStatus>applying</ParameterApplyStatus>
          <ParameterGroupName>parametergroup1</ParameterGroupName>
        </ClusterParameterGroup>
      </ClusterParameterGroups>
      <ClusterCreateTime>2013-01-22T19:23:59.368Z</ClusterCreateTime>
      <ClusterSecurityGroups>
        <ClusterSecurityGroup>
          <Status>active</Status>
          <ClusterSecurityGroupName>default</ClusterSecurityGroupName>
        </ClusterSecurityGroup>
      </ClusterSecurityGroups>
      <AvailabilityZone>us-east-1c</AvailabilityZone>
      <NodeType>ds2.xlarge</NodeType>
      <ClusterIdentifier>examplecluster</ClusterIdentifier>
      <AllowVersionUpgrade>true</AllowVersionUpgrade>
      <MasterUsername>adminuser</MasterUsername>
    </Cluster>
  </ModifyClusterResult>
  <ResponseMetadata>
    <RequestId>acbc43d5-6504-11e2-bea9-49e0ce183f07</RequestId>
  </ResponseMetadata>
</ModifyClusterResponse>

See Also

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