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

RebootCluster

Reboots a cluster. This action is taken as soon as possible. It results in a momentary outage to the cluster, during which the cluster status is set to rebooting. A cluster event is created when the reboot is completed. Any pending cluster modifications (see ModifyCluster) are applied at this reboot. 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

The cluster identifier.

Type: String

Required: Yes

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.

ClusterNotFound

The ClusterIdentifier parameter does not refer to an existing cluster.

HTTP Status Code: 404

InvalidClusterState

The specified cluster is not in the available state.

HTTP Status Code: 400

Example

Sample Request

https://redshift.us-east-1.amazonaws.com/
    ?Action=RebootCluster
    &ClusterIdentifier=examplecluster
    &Version=2012-12-01
    &x-amz-algorithm=AWS4-HMAC-SHA256
    &x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-1/redshift/aws4_request
    &x-amz-date=20130123T021951Z
    &x-amz-signedheaders=content-type;host;x-amz-date

Sample Response

<RebootClusterResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
  <RebootClusterResult>
    <Cluster>
      <PendingModifiedValues/>
      <ClusterVersion>1.0</ClusterVersion>
      <VpcSecurityGroups/>
      <Endpoint>
        <Port>5439</Port>
        <Address>examplecluster.cobaosmlqshn.us-east-1.redshift.amazonaws.com</Address>
      </Endpoint>
      <ClusterStatus>rebooting</ClusterStatus>
      <NumberOfNodes>2</NumberOfNodes>
      <AutomatedSnapshotRetentionPeriod>1</AutomatedSnapshotRetentionPeriod>
      <PubliclyAccessible>true</PubliclyAccessible>
      <Encrypted>false</Encrypted>
      <DBName>dev</DBName>
      <PreferredMaintenanceWindow>sun:06:30-sun:07:00</PreferredMaintenanceWindow>
      <ClusterParameterGroups>
        <ClusterParameterGroup>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          <ParameterGroupName>default.redshift-1.0</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>
  </RebootClusterResult>
  <ResponseMetadata>
    <RequestId>5edee79e-6503-11e2-9e70-918437dd236d</RequestId>
  </ResponseMetadata>
</RebootClusterResponse>

See Also

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