Skip to content

RDS  >  Operations  >  reboot_db_cluster

reboot_db_cluster

Operation

reboot_db_cluster async 

reboot_db_cluster(input: RebootDBClusterInput, plugins: list[Plugin] | None = None) -> RebootDBClusterOutput

You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.

Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

Use this operation only for a non-Aurora Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Parameters:

Name Type Description Default
input RebootDBClusterInput

An instance of RebootDBClusterInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
RebootDBClusterOutput

An instance of RebootDBClusterOutput.

Input

RebootDBClusterInput dataclass

Bases: _SerdeShape

Dataclass for RebootDBClusterInput structure.

Attributes

db_cluster_identifier class-attribute instance-attribute 
db_cluster_identifier: str | None = ...

The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBCluster.

Output

RebootDBClusterOutput dataclass

Bases: _SerdeShape

Dataclass for RebootDBClusterOutput structure.

Attributes

db_cluster class-attribute instance-attribute 
db_cluster: DBCluster | None = ...

Contains the details of an Amazon Aurora DB cluster or Multi-AZ DB cluster.

For an Amazon Aurora DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, PromoteReadReplicaDBCluster, RestoreDBClusterFromS3, RestoreDBClusterFromSnapshot, RestoreDBClusterToPointInTime, StartDBCluster, and StopDBCluster.

For a Multi-AZ DB cluster, this data type is used as a response element in the operations CreateDBCluster, DeleteDBCluster, DescribeDBClusters, FailoverDBCluster, ModifyDBCluster, RebootDBCluster, RestoreDBClusterFromSnapshot, and RestoreDBClusterToPointInTime.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.