RebootDBInstance
You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect.
Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting.
For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
This command doesn't apply to RDS Custom.
If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBInstanceIdentifier
-
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
-
Must match the identifier of an existing DBInstance.
Type: String
Required: Yes
-
- ForceFailover
-
Specifies whether the reboot is conducted through a Multi-AZ failover.
Constraint: You can't enable force failover if the instance isn't configured for Multi-AZ.
Type: Boolean
Required: No
Response Elements
The following element is returned by the service.
- DBInstance
-
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations
CreateDBInstance,CreateDBInstanceReadReplica,DeleteDBInstance,DescribeDBInstances,ModifyDBInstance,PromoteReadReplica,RebootDBInstance,RestoreDBInstanceFromDBSnapshot,RestoreDBInstanceFromS3,RestoreDBInstanceToPointInTime,StartDBInstance, andStopDBInstance.Type: DBInstance object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBInstanceNotFound
-
DBInstanceIdentifierdoesn't refer to an existing DB instance.HTTP Status Code: 404
- InvalidDBInstanceState
-
The DB instance isn't in a valid state.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of RebootDBInstance.
Sample Request
https://rds.us-east-1.amazonaws.com/
?Action=RebootDBInstance
&DBInstanceIdentifier=mysqldb
&SignatureMethod=HmacSHA256
&SignatureVersion=4
&Version=2014-10-31
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIADQKE4SARGYLE/20140428/us-east-1/rds/aws4_request
&X-Amz-Date=20140428T222011Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=1c48f44c14183cff26fde7d912946f87f3bb9d715f66448f457a8f9e99602af5
Sample Response
<RebootDBInstanceResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
<RebootDBInstanceResult>
<DBInstance>
<BackupRetentionPeriod>7</BackupRetentionPeriod>
<DBInstanceStatus>rebooting</DBInstanceStatus>
<MultiAZ>false</MultiAZ>
<VpcSecurityGroups/>
<DBInstanceIdentifier>mysqldb</DBInstanceIdentifier>
<PreferredBackupWindow>08:14-08:44</PreferredBackupWindow>
<PreferredMaintenanceWindow>fri:04:50-fri:05:20</PreferredMaintenanceWindow>
<AvailabilityZone>us-east-1a</AvailabilityZone>
<ReadReplicaDBInstanceIdentifiers/>
<LatestRestorableTime>2014-04-28T22:15:00Z</LatestRestorableTime>
<Engine>mysql</Engine>
<PendingModifiedValues/>
<LicenseModel>general-public-license</LicenseModel>
<EngineVersion>5.6.13</EngineVersion>
<Endpoint>
<Port>3306</Port>
<Address>mysqldb.cb036hpkmopt.us-east-1.rds.amazonaws.com</Address>
</Endpoint>
<DBParameterGroups>
<DBParameterGroup>
<ParameterApplyStatus>in-sync</ParameterApplyStatus>
<DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
</DBParameterGroup>
</DBParameterGroups>
<OptionGroupMemberships>
<OptionGroupMembership>
<OptionGroupName>default:mysql-5-6</OptionGroupName>
<Status>in-sync</Status>
</OptionGroupMembership>
</OptionGroupMemberships>
<PubliclyAccessible>true</PubliclyAccessible>
<DBSecurityGroups>
<DBSecurityGroup>
<Status>active</Status>
<DBSecurityGroupName>default</DBSecurityGroupName>
</DBSecurityGroup>
</DBSecurityGroups>
<DBName>mysqldb</DBName>
<AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
<InstanceCreateTime>2014-04-21T22:24:26.573Z</InstanceCreateTime>
<AllocatedStorage>100</AllocatedStorage>
<MasterUsername>myawsuser</MasterUsername>
<DBInstanceClass>db.m1.medium</DBInstanceClass>
</DBInstance>
</RebootDBInstanceResult>
<ResponseMetadata>
<RequestId>33c99cd2-be22-11d3-abdb-7cb19376fb1c</RequestId>
</ResponseMetadata>
</RebootDBInstanceResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
