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
Length Constraints: Maximum length of 2147483647.
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
ClusterIdentifierparameter does not refer to an existing cluster.HTTP Status Code: 404
- InvalidClusterState
-
The specified cluster is not in the
availablestate.HTTP Status Code: 400
Examples
Example
This example illustrates one usage of RebootCluster.
Sample Request
https://redshift.us-east-2.amazonaws.com/
?Action=RebootCluster
&ClusterIdentifier=mycluster
&SignatureMethod=HmacSHA256&SignatureVersion=4
&Version=2012-12-01
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE/20190817/us-east-2/redshift/aws4_request
&X-Amz-Date=20190825T160000Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=0aa1234bb5cc678ddddd901ee2ff3aa45678b90c12d345e6ff789012345a6b7bSample Response
<RebootClusterResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
<RebootClusterResult>
<Cluster>
<AllowVersionUpgrade>true</AllowVersionUpgrade>
<ClusterIdentifier>mycluster</ClusterIdentifier>
<NumberOfNodes>1</NumberOfNodes>
<AvailabilityZone>us-east-2a</AvailabilityZone>
<ClusterVersion>1.0</ClusterVersion>
<ManualSnapshotRetentionPeriod>-1</ManualSnapshotRetentionPeriod>
<ClusterAvailabilityStatus>Modifying</ClusterAvailabilityStatus>
<Endpoint>
<Port>5439</Port>
<Address>mycluster.cmeaswqeuae.us-east-2.redshift.amazonaws.com</Address>
</Endpoint>
<VpcId>vpc-a1abc1a1</VpcId>
<PubliclyAccessible>false</PubliclyAccessible>
<ClusterCreateTime>2019-12-27T17:48:01.504Z</ClusterCreateTime>
<ClusterSnapshotCopyStatus>
<ManualSnapshotRetentionPeriod>-1</ManualSnapshotRetentionPeriod>
<DestinationRegion>us-east-1</DestinationRegion>
<RetentionPeriod>15</RetentionPeriod>
</ClusterSnapshotCopyStatus>
<MasterUsername>adminuser</MasterUsername>
<DBName>dev</DBName>
<EnhancedVpcRouting>false</EnhancedVpcRouting>
<IamRoles/>
<ClusterSecurityGroups/>
<NodeType>dc2.large</NodeType>
<ClusterSubnetGroupName>default</ClusterSubnetGroupName>
<NextMaintenanceWindowStartTime>2020-01-26T23:15:00Z</NextMaintenanceWindowStartTime>
<DeferredMaintenanceWindows>
<DeferredMaintenanceWindow>
<DeferMaintenanceEndTime>2020-01-26T19:39:15.075Z</DeferMaintenanceEndTime>
<DeferMaintenanceIdentifier>dfm-VcfYqSYqQ4tdXOqbKwOo</DeferMaintenanceIdentifier>
<DeferMaintenanceStartTime>2019-12-27T19:39:15.075Z</DeferMaintenanceStartTime>
</DeferredMaintenanceWindow>
</DeferredMaintenanceWindows>
<Tags>
<Tag>
<Value>newtag</Value>
<Key>mytag</Key>
</Tag>
</Tags>
<VpcSecurityGroups>
<VpcSecurityGroup>
<VpcSecurityGroupId>sh-a1a123ab</VpcSecurityGroupId>
<Status>active</Status>
</VpcSecurityGroup>
</VpcSecurityGroups>
<ClusterParameterGroups>
<ClusterParameterGroup>
<ParameterGroupName>default.redshift-1.0</ParameterGroupName>
<ParameterApplyStatus>in-sync</ParameterApplyStatus>
</ClusterParameterGroup>
</ClusterParameterGroups>
<Encrypted>false</Encrypted>
<MaintenanceTrackName>current</MaintenanceTrackName>
<PendingModifiedValues/>
<PreferredMaintenanceWindow>sun:23:15-mon:03:15</PreferredMaintenanceWindow>
<AutomatedSnapshotRetentionPeriod>1</AutomatedSnapshotRetentionPeriod>
<ClusterStatus>rebooting</ClusterStatus>
</Cluster>
</RebootClusterResult>
<ResponseMetadata>
<RequestId>6f1299dc-28f5-11ea-9caa-c956bec1ce87</RequestId>
</ResponseMetadata>
</RebootClusterResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
