Class: Aws::DocDB::Types::RebootDBInstanceMessage

Inherits:

Struct

• Object
• Struct
• Aws::DocDB::Types::RebootDBInstanceMessage

Includes:

Structure

Defined in:

lib/aws-sdk-docdb/types.rb

Overview

Note:

When making an API call, you may pass RebootDBInstanceMessage data as a hash:

{
  db_instance_identifier: "String", # required
  force_failover: false,
}

Represents the input to RebootDBInstance.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #db_instance_identifier ⇒ String

  The instance identifier.

• #force_failover ⇒ Boolean

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

Instance Attribute Details

#db_instance_identifier ⇒ String

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

Constraints:

• Must match the identifier of an existing `DBInstance`.

^

Returns:

• (String)

# File 'lib/aws-sdk-docdb/types.rb', line 5402

class RebootDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :force_failover)
  SENSITIVE = []
  include Aws::Structure
end

#force_failover ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-docdb/types.rb', line 5402

class RebootDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :force_failover)
  SENSITIVE = []
  include Aws::Structure
end