You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#db_instance_identifierString

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

Constraints:

  • Must match the identifier of an existing DBInstance.

^

Returns:

  • (String)


4171
4172
4173
4174
4175
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4171

class RebootDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :force_failover)
  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)


4171
4172
4173
4174
4175
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 4171

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