rds-reboot-db-instance

Description

Reboots a DB Instance. Once started, the process cannot be stopped, and the DB Instance is unavailable until the reboot is completed.

Syntax

rds-reboot-db-instance DBInstanceIdentifier

[-f (--force-failover) value ][General Options]

Options

Name Description Required

Name	Description	Required
`DBInstanceIdentifier`	DB Instance identifier. Constraints: Must contain 1 to 63 alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens.	Yes
`-f` `value` `--force-failover` `value`	When `true`, specifies that the reboot will be conducted through a Multi-AZ failover. You cannot specify `true` if the DB Instance is not configured for Multi-AZ. Type: Boolean Default: `false` Example: `--force-failover true`	No

DBInstanceIdentifier

DB Instance identifier.

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

Yes

-f value

--force-failover value

When true, specifies that the reboot will be conducted through a Multi-AZ failover. You cannot specify true if the DB Instance is not configured for Multi-AZ.

Type: Boolean

Default: false

Example: --force-failover true

No

Output

The command returns the following information:

DBInstanceId—User-supplied database identifier; this is the unique key that identifies a DB Instance
Created—When the instance was created, in UTC
Class—The compute and memory capacity of the DB Instance
Engine—Name of the database engine to be used for this DB Instance
Storage—Initially allocated storage size specified in GBs
Master Username—The master username for the instance
Status—The current status of the instance. Valid values: available | backing-up | creating | deleted | deleting | failed | modifying | rebooting | resetting-master-credentials
Endpoint Address—Address of the DB Instance
Port—Port used to connect to the DB Instance
AZ—The instance's Availability Zone
Backup Retention—The number of days that automated backups are retained before deletion
PendingClass—The class to which the instance will be scaled during the next maintenance window, or to which it is currently being scaled if the --apply-immediately option was specified.
PendingCredentials—The (hidden) master user password that will be applied to the DB Instance.
PendingVersion— The pending database engine version number. This column appears only in the --show-long view.
DB Name—Name of the initial database created when the instance was created (for the MySQL engine) or the Oracle System ID (SID) of the created DB Instance (for the Oracle engine). This column appears only in the --show-long view
Maintenance Window—The period during which patching and instance modifications will be performed. This column appears only in the --show-long view.
Backup Window—The daily period during which automated backups are created. This column appears only in the --show-long view.
Version—The version number of the database engine.
Auto Minor Version Upgrade—Indicates that minor version upgrades will be applied to the DB Instance during the maintenance window. This column appears only in the --show-long view.
Name—DB Security Group name.
Status—Status of authorization. Valid values: authorizing | authorized | revoking
Group Name—Name of DB Parameter Group applied to.
Apply Status—Status of applying the DB Parameter Group. Valid values: in-sync | pending-reboot | applying
Multi-AZ—Indicates if this is a Multi-AZ DB Instance.
EngineVersion—Database engine version number.

Examples

Reboot a Database Instance

This example reboots a DB Instance.

PROMPT> rds-reboot-db-instance databaseInstance1