RebootDBInstanceCommand

Suggest an Edit

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

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DocDBClient, RebootDBInstanceCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, RebootDBInstanceCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // RebootDBInstanceMessage
  DBInstanceIdentifier: "STRING_VALUE", // required
  ForceFailover: true || false,
};
const command = new RebootDBInstanceCommand(input);
const response = await client.send(command);
// { // RebootDBInstanceResult
//   DBInstance: { // DBInstance
//     DBInstanceIdentifier: "STRING_VALUE",
//     DBInstanceClass: "STRING_VALUE",
//     Engine: "STRING_VALUE",
//     DBInstanceStatus: "STRING_VALUE",
//     Endpoint: { // Endpoint
//       Address: "STRING_VALUE",
//       Port: Number("int"),
//       HostedZoneId: "STRING_VALUE",
//     },
//     InstanceCreateTime: new Date("TIMESTAMP"),
//     PreferredBackupWindow: "STRING_VALUE",
//     BackupRetentionPeriod: Number("int"),
//     VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
//       { // VpcSecurityGroupMembership
//         VpcSecurityGroupId: "STRING_VALUE",
//         Status: "STRING_VALUE",
//       },
//     ],
//     AvailabilityZone: "STRING_VALUE",
//     DBSubnetGroup: { // DBSubnetGroup
//       DBSubnetGroupName: "STRING_VALUE",
//       DBSubnetGroupDescription: "STRING_VALUE",
//       VpcId: "STRING_VALUE",
//       SubnetGroupStatus: "STRING_VALUE",
//       Subnets: [ // SubnetList
//         { // Subnet
//           SubnetIdentifier: "STRING_VALUE",
//           SubnetAvailabilityZone: { // AvailabilityZone
//             Name: "STRING_VALUE",
//           },
//           SubnetStatus: "STRING_VALUE",
//         },
//       ],
//       DBSubnetGroupArn: "STRING_VALUE",
//     },
//     PreferredMaintenanceWindow: "STRING_VALUE",
//     PendingModifiedValues: { // PendingModifiedValues
//       DBInstanceClass: "STRING_VALUE",
//       AllocatedStorage: Number("int"),
//       MasterUserPassword: "STRING_VALUE",
//       Port: Number("int"),
//       BackupRetentionPeriod: Number("int"),
//       MultiAZ: true || false,
//       EngineVersion: "STRING_VALUE",
//       LicenseModel: "STRING_VALUE",
//       Iops: Number("int"),
//       DBInstanceIdentifier: "STRING_VALUE",
//       StorageType: "STRING_VALUE",
//       CACertificateIdentifier: "STRING_VALUE",
//       DBSubnetGroupName: "STRING_VALUE",
//       PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
//         LogTypesToEnable: [ // LogTypeList
//           "STRING_VALUE",
//         ],
//         LogTypesToDisable: [
//           "STRING_VALUE",
//         ],
//       },
//     },
//     LatestRestorableTime: new Date("TIMESTAMP"),
//     EngineVersion: "STRING_VALUE",
//     AutoMinorVersionUpgrade: true || false,
//     PubliclyAccessible: true || false,
//     StatusInfos: [ // DBInstanceStatusInfoList
//       { // DBInstanceStatusInfo
//         StatusType: "STRING_VALUE",
//         Normal: true || false,
//         Status: "STRING_VALUE",
//         Message: "STRING_VALUE",
//       },
//     ],
//     DBClusterIdentifier: "STRING_VALUE",
//     StorageEncrypted: true || false,
//     KmsKeyId: "STRING_VALUE",
//     DbiResourceId: "STRING_VALUE",
//     CACertificateIdentifier: "STRING_VALUE",
//     CopyTagsToSnapshot: true || false,
//     PromotionTier: Number("int"),
//     DBInstanceArn: "STRING_VALUE",
//     EnabledCloudwatchLogsExports: [
//       "STRING_VALUE",
//     ],
//     CertificateDetails: { // CertificateDetails
//       CAIdentifier: "STRING_VALUE",
//       ValidTill: new Date("TIMESTAMP"),
//     },
//     PerformanceInsightsEnabled: true || false,
//     PerformanceInsightsKMSKeyId: "STRING_VALUE",
//   },
// };

RebootDBInstanceCommand Input

See RebootDBInstanceCommandInput for more details

Parameter
Type
Description
DBInstanceIdentifier
Required
string | undefined

The instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must match the identifier of an existing DBInstance.

ForceFailover
boolean | undefined

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.

RebootDBInstanceCommand Output

See RebootDBInstanceCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DBInstance
DBInstance | undefined

Detailed information about an instance.

Throws

Name
Fault
Details
DBInstanceNotFoundFault
client

DBInstanceIdentifier doesn't refer to an existing instance.

InvalidDBInstanceStateFault
client

The specified instance isn't in the available state.

DocDBServiceException
Base exception class for all service exceptions from DocDB service.