Learn R Programming

paws.database (version 0.1.5)

docdb_reboot_db_instance: You might need to reboot your DB instance, usually for maintenance reasons

Description

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

Usage

docdb_reboot_db_instance(DBInstanceIdentifier, ForceFailover)

Arguments

DBInstanceIdentifier

[required] The DB instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

ForceFailover

When true, the reboot is conducted through a Multi-AZ failover.

Constraint: You can't specify true if the instance is not configured for Multi-AZ.

Request syntax

svc$reboot_db_instance(
  DBInstanceIdentifier = "string",
  ForceFailover = TRUE|FALSE
)

Details

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.