Amazonka.DocumentDB.RebootDBInstance

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.

Creating a Request

data RebootDBInstance

Represents the input to RebootDBInstance.

See: newRebootDBInstance smart constructor.

Constructors

RebootDBInstance'

Fields

• forceFailover :: Maybe Bool

  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.

• dbInstanceIdentifier :: Text

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

  Constraints:

  • Must match the identifier of an existing DBInstance.

Instances

ToHeaders RebootDBInstance

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

toHeaders :: RebootDBInstance -> [Header]

ToPath RebootDBInstance

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

toPath :: RebootDBInstance -> ByteString

ToQuery RebootDBInstance

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

toQuery :: RebootDBInstance -> QueryString

AWSRequest RebootDBInstance

Defined in Amazonka.DocumentDB.RebootDBInstance

Associated Types

type AWSResponse RebootDBInstance

Methods

request :: (Service -> Service) -> RebootDBInstance -> Request RebootDBInstance

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RebootDBInstance -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RebootDBInstance)))

Generic RebootDBInstance

Defined in Amazonka.DocumentDB.RebootDBInstance

Associated Types

type Rep RebootDBInstance :: Type -> Type

Methods

from :: RebootDBInstance -> Rep RebootDBInstance x

to :: Rep RebootDBInstance x -> RebootDBInstance

Read RebootDBInstance

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

readsPrec :: Int -> ReadS RebootDBInstance

readList :: ReadS [RebootDBInstance]

readPrec :: ReadPrec RebootDBInstance

readListPrec :: ReadPrec [RebootDBInstance]

Show RebootDBInstance

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

showsPrec :: Int -> RebootDBInstance -> ShowS

show :: RebootDBInstance -> String

showList :: [RebootDBInstance] -> ShowS

NFData RebootDBInstance

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

rnf :: RebootDBInstance -> ()

Eq RebootDBInstance

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

(==) :: RebootDBInstance -> RebootDBInstance -> Bool

(/=) :: RebootDBInstance -> RebootDBInstance -> Bool

Hashable RebootDBInstance

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

hashWithSalt :: Int -> RebootDBInstance -> Int

hash :: RebootDBInstance -> Int

type AWSResponse RebootDBInstance

Defined in Amazonka.DocumentDB.RebootDBInstance

type AWSResponse RebootDBInstance = RebootDBInstanceResponse

type Rep RebootDBInstance

Defined in Amazonka.DocumentDB.RebootDBInstance

type Rep RebootDBInstance = D1 ('MetaData "RebootDBInstance" "Amazonka.DocumentDB.RebootDBInstance" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RebootDBInstance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "forceFailover") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dbInstanceIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newRebootDBInstance

Arguments

:: Text

RebootDBInstance

-> RebootDBInstance

Create a value of RebootDBInstance with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:forceFailover:RebootDBInstance', rebootDBInstance_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.

RebootDBInstance, rebootDBInstance_dbInstanceIdentifier - The instance identifier. This parameter is stored as a lowercase string.

Constraints:

• Must match the identifier of an existing DBInstance.

Request Lenses

rebootDBInstance_forceFailover :: Lens' RebootDBInstance (Maybe Bool)

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.

rebootDBInstance_dbInstanceIdentifier :: Lens' RebootDBInstance Text

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

Constraints:

• Must match the identifier of an existing DBInstance.

Destructuring the Response

data RebootDBInstanceResponse

See: newRebootDBInstanceResponse smart constructor.

Constructors

RebootDBInstanceResponse'

Fields

• dbInstance :: Maybe DBInstance
• httpStatus :: Int

  The response's http status code.

Instances

Generic RebootDBInstanceResponse

Defined in Amazonka.DocumentDB.RebootDBInstance

Associated Types

type Rep RebootDBInstanceResponse :: Type -> Type

Methods

from :: RebootDBInstanceResponse -> Rep RebootDBInstanceResponse x

to :: Rep RebootDBInstanceResponse x -> RebootDBInstanceResponse

Read RebootDBInstanceResponse

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

readsPrec :: Int -> ReadS RebootDBInstanceResponse

readList :: ReadS [RebootDBInstanceResponse]

readPrec :: ReadPrec RebootDBInstanceResponse

readListPrec :: ReadPrec [RebootDBInstanceResponse]

Show RebootDBInstanceResponse

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

showsPrec :: Int -> RebootDBInstanceResponse -> ShowS

show :: RebootDBInstanceResponse -> String

showList :: [RebootDBInstanceResponse] -> ShowS

NFData RebootDBInstanceResponse

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

rnf :: RebootDBInstanceResponse -> ()

Eq RebootDBInstanceResponse

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

(==) :: RebootDBInstanceResponse -> RebootDBInstanceResponse -> Bool

(/=) :: RebootDBInstanceResponse -> RebootDBInstanceResponse -> Bool

type Rep RebootDBInstanceResponse

Defined in Amazonka.DocumentDB.RebootDBInstance

type Rep RebootDBInstanceResponse = D1 ('MetaData "RebootDBInstanceResponse" "Amazonka.DocumentDB.RebootDBInstance" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" 'False) (C1 ('MetaCons "RebootDBInstanceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbInstance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBInstance)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRebootDBInstanceResponse

Arguments

:: Int

$sel:httpStatus:RebootDBInstanceResponse'

-> RebootDBInstanceResponse

Create a value of RebootDBInstanceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:dbInstance:RebootDBInstanceResponse', rebootDBInstanceResponse_dbInstance - Undocumented member.

$sel:httpStatus:RebootDBInstanceResponse', rebootDBInstanceResponse_httpStatus - The response's http status code.

Response Lenses

rebootDBInstanceResponse_dbInstance :: Lens' RebootDBInstanceResponse (Maybe DBInstance)

Undocumented member.

rebootDBInstanceResponse_httpStatus :: Lens' RebootDBInstanceResponse Int

The response's http status code.