amazonka-docdb-2.0: Amazon DocumentDB with MongoDB compatibility SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DocumentDB.RebootDBInstance

Description

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.

Synopsis

Creating a Request

data RebootDBInstance Source #

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

Instances details
ToHeaders RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

ToPath RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

ToQuery RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

AWSRequest RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Associated Types

type AWSResponse RebootDBInstance #

Generic RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Associated Types

type Rep RebootDBInstance :: Type -> Type #

Read RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Show RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

NFData RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Methods

rnf :: RebootDBInstance -> () #

Eq RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Hashable RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

type AWSResponse RebootDBInstance Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

type Rep RebootDBInstance Source # 
Instance details

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 Source #

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) Source #

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 Source #

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 Source #

See: newRebootDBInstanceResponse smart constructor.

Constructors

RebootDBInstanceResponse' 

Fields

Instances

Instances details
Generic RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Associated Types

type Rep RebootDBInstanceResponse :: Type -> Type #

Read RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Show RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

NFData RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

Eq RebootDBInstanceResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.RebootDBInstance

type Rep RebootDBInstanceResponse Source # 
Instance details

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 Source #

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