RebootDBInstance - Amazon Relational Database Service

Description

Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS instance during which the RDS instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. A DBInstance event is created when the reboot is completed.

Request Parameters

For information about the common parameters that all actions use, see Common Query Parameters.

Name Description Required

Name	Description	Required
`DBInstanceIdentifier`	The DB Instance identifier. This parameter is stored as a lowercase string. Constraints: Must contain from 1 to 63 alphanumeric characters or hyphens First character must be a letter Cannot end with a hyphen or contain two consecutive hyphens Type: String	Yes
`ForceFailover`	When `true`, the reboot will be conducted through a MultiAZ failover. Constraint: You cannot specify `true` if the instance is not configured for MultiAZ. Type: Boolean	No

DBInstanceIdentifier

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

Constraints:

Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens

Type: String

Yes

ForceFailover

When true, the reboot will be conducted through a MultiAZ failover.

Constraint: You cannot specify true if the instance is not configured for MultiAZ.

Type: Boolean

No

Response Elements

The following elements come wrapped in a DBInstance structure.

Name	Description
`AllocatedStorage`	Specifies the allocated storage size specified in gigabytes. Type: Integer
`AutoMinorVersionUpgrade`	Indicates that minor version patches are applied automatically. Type: Boolean
`AvailabilityZone`	Specifies the name of the Availability Zone the DB Instance is located in. Type: String
`BackupRetentionPeriod`	Specifies the number of days for which automatic DB Snapshots are retained. Type: Integer
`CharacterSetName`	If present, specifies the name of the character set that this instance is associated with. Type: String
`DBInstanceClass`	Contains the name of the compute and memory capacity class of the DB Instance. Type: String
`DBInstanceIdentifier`	Contains a user-supplied database identifier. This is the unique key that identifies a DB Instance. Type: String
`DBInstanceStatus`	Specifies the current state of this database. Type: String
`DBName`	The meaning of this parameter differs according to the database engine you use. MySQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance. Type: String Oracle Contains the Oracle System ID (SID) of the created DB Instance. Type: String
`DBParameterGroups`	Provides the list of DB Parameter Groups applied to this DB Instance. Type: DBParameterGroupStatus list
`DBSecurityGroups`	Provides List of DB Security Group elements containing only `DBSecurityGroup.Name` and `DBSecurityGroup.Status` subelements. Type: DBSecurityGroupMembership list
`DBSubnetGroup`	Provides the inforamtion of the subnet group associated with the DB instance, including the name, descrption and subnets in the subnet group. Type: DBSubnetGroup
`Endpoint`	Specifies the connection endpoint. Type: Endpoint
`Engine`	Provides the name of the database engine to be used for this DB Instance. Type: String
`EngineVersion`	Indicates the database engine version. Type: String
`InstanceCreateTime`	Provides the date and time the DB Instance was created. Type: DateTime
`LatestRestorableTime`	Specifies the latest time to which a database can be restored with point-in-time restore. Type: DateTime
`LicenseModel`	License model information for this DB Instance. Type: String
`MasterUsername`	Contains the master username for the DB Instance. Type: String
`MultiAZ`	Specifies if the DB Instance is a Multi-AZ deployment. Type: Boolean
`OptionGroupMembership`	Specifies the name and status of the option group that this instance belongs to. Type: OptionGroupMembership
`PendingModifiedValues`	Specifies that changes to the DB Instance are pending. This element is only included when changes are pending. Specific changes are identified by subelements. Type: PendingModifiedValues
`PreferredBackupWindow`	Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`. Type: String
`PreferredMaintenanceWindow`	Specifies the weekly time range (in UTC) during which system maintenance can occur. Type: String
`ReadReplicaDBInstanceIdentifiers`	Contains one or more identifiers of the Read Replicas associated with this DB Instance. Type: String list
`ReadReplicaSourceDBInstanceIdentifier`	Contains the identifier of the source DB Instance if this DB Instance is a Read Replica. Type: String

Errors

For information about the common errors that all actions use, see Common Errors.

Error	Description	HTTP Status Code
`DBInstanceNotFound`	DBInstanceIdentifier does not refer to an existing DB Instance.	404
`InvalidDBInstanceState`	The specified DB Instance is not in the available state.	400

Examples

Sample Request

https://rds.amazonaws.com/
    ?Action=RebootDBInstance
    &DBInstanceIdentifier=simcoprod01
    &Version=2012-04-23
    &SignatureVersion=2
    &SignatureMethod=HmacSHA256
    &Timestamp=2011-05-23T06%3A10%3A31.216Z
    &AWSAccessKeyId=<AWS Access Key ID>
    &Signature=<Signature>

Sample Response

<RebootDBInstanceResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
  <RebootDBInstanceResult>
    <DBInstance>
      <ReadReplicaDBInstanceIdentifiers/>
      <LatestRestorableTime>2011-05-23T06:07:38.831Z</LatestRestorableTime>
      <Engine>mysql</Engine>
      <PendingModifiedValues/>
      <BackupRetentionPeriod>1</BackupRetentionPeriod>
      <MultiAZ>false</MultiAZ>
      <LicenseModel>general-public-license</LicenseModel>
      <DBInstanceStatus>rebooting</DBInstanceStatus>
      <EngineVersion>5.1.50</EngineVersion>
      <Endpoint>
        <Port>3306</Port>
        <Address>simcoprod01.cu7u2t4uz396.us-east-1.rds.amazonaws.com</Address>
      </Endpoint>
      <DBInstanceIdentifier>simcoprod01</DBInstanceIdentifier>
      <DBParameterGroups>
        <DBParameterGroup>
          <ParameterApplyStatus>in-sync</ParameterApplyStatus>
          <DBParameterGroupName>default.mysql5.1</DBParameterGroupName>
        </DBParameterGroup>
      </DBParameterGroups>
      <DBSecurityGroups>
        <DBSecurityGroup>
          <Status>active</Status>
          <DBSecurityGroupName>default</DBSecurityGroupName>
        </DBSecurityGroup>
      </DBSecurityGroups>
      <PreferredBackupWindow>00:00-00:30</PreferredBackupWindow>
      <AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
      <PreferredMaintenanceWindow>sat:07:30-sat:08:00</PreferredMaintenanceWindow>
      <AvailabilityZone>us-east-1a</AvailabilityZone>
      <InstanceCreateTime>2011-05-23T06:06:43.110Z</InstanceCreateTime>
      <AllocatedStorage>10</AllocatedStorage>
      <DBInstanceClass>db.m1.large</DBInstanceClass>
      <MasterUsername>master</MasterUsername>
    </DBInstance>
  </RebootDBInstanceResult>
  <ResponseMetadata>
    <RequestId>5d5df758-8503-11e0-90aa-eb648410240d</RequestId>
  </ResponseMetadata>
</RebootDBInstanceResponse>