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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-docdb/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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_instance_identifierString

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

Constraints:

  • Must match the identifier of an existing DBInstance.

^

Returns:

  • (String)


4497
4498
4499
4500
4501
4502
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4497

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

#force_failoverBoolean

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)


4497
4498
4499
4500
4501
4502
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4497

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