Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.RebootDBCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

You might need to reboot your DB cluster, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB cluster parameter group associated with the DB cluster, reboot the DB cluster for the changes to take effect.

Rebooting a DB cluster restarts the database engine service. Rebooting a DB cluster results in a momentary outage, during which the DB cluster status is set to rebooting.

Use this operation only for a non-Aurora Multi-AZ DB cluster.

For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.

Creating a Request

data RebootDBCluster Source #

See: newRebootDBCluster smart constructor.

Constructors

RebootDBCluster'
Fields dbClusterIdentifier :: Text The DB cluster identifier. This parameter is stored as a lowercase string. Constraints: Must match the identifier of an existing DBCluster.

Instances

Instances details

ToHeaders RebootDBCluster Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Methods toHeaders :: RebootDBCluster -> [Header] #
ToPath RebootDBCluster Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Methods toPath :: RebootDBCluster -> ByteString #
ToQuery RebootDBCluster Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Methods toQuery :: RebootDBCluster -> QueryString #
AWSRequest RebootDBCluster Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Associated Types type AWSResponse RebootDBCluster # Methods request :: (Service -> Service) -> RebootDBCluster -> Request RebootDBCluster # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RebootDBCluster -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RebootDBCluster))) #
Generic RebootDBCluster Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Associated Types type Rep RebootDBCluster :: Type -> Type # Methods from :: RebootDBCluster -> Rep RebootDBCluster x # to :: Rep RebootDBCluster x -> RebootDBCluster #
Read RebootDBCluster Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Methods readsPrec :: Int -> ReadS RebootDBCluster # readList :: ReadS [RebootDBCluster] # readPrec :: ReadPrec RebootDBCluster # readListPrec :: ReadPrec [RebootDBCluster] #
Show RebootDBCluster Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Methods showsPrec :: Int -> RebootDBCluster -> ShowS # show :: RebootDBCluster -> String # showList :: [RebootDBCluster] -> ShowS #
NFData RebootDBCluster Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Methods rnf :: RebootDBCluster -> () #
Eq RebootDBCluster Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Methods (==) :: RebootDBCluster -> RebootDBCluster -> Bool # (/=) :: RebootDBCluster -> RebootDBCluster -> Bool #
Hashable RebootDBCluster Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Methods hashWithSalt :: Int -> RebootDBCluster -> Int # hash :: RebootDBCluster -> Int #
type AWSResponse RebootDBCluster Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster type AWSResponse RebootDBCluster = RebootDBClusterResponse
type Rep RebootDBCluster Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster type Rep RebootDBCluster = D1 ('MetaData "RebootDBCluster" "Amazonka.RDS.RebootDBCluster" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "RebootDBCluster'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newRebootDBCluster Source #

Arguments

:: Text	`RebootDBCluster`
-> RebootDBCluster

Create a value of RebootDBCluster 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:

RebootDBCluster, rebootDBCluster_dbClusterIdentifier - The DB cluster identifier. This parameter is stored as a lowercase string.

Constraints:

Must match the identifier of an existing DBCluster.

Request Lenses

rebootDBCluster_dbClusterIdentifier :: Lens' RebootDBCluster Text Source #

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

Constraints:

Must match the identifier of an existing DBCluster.

Destructuring the Response

data RebootDBClusterResponse Source #

See: newRebootDBClusterResponse smart constructor.

Constructors

RebootDBClusterResponse'
Fields dbCluster :: Maybe DBCluster httpStatus :: Int The response's http status code.

Instances

Instances details

Generic RebootDBClusterResponse Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Associated Types type Rep RebootDBClusterResponse :: Type -> Type # Methods from :: RebootDBClusterResponse -> Rep RebootDBClusterResponse x # to :: Rep RebootDBClusterResponse x -> RebootDBClusterResponse #
Read RebootDBClusterResponse Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Methods readsPrec :: Int -> ReadS RebootDBClusterResponse # readList :: ReadS [RebootDBClusterResponse] # readPrec :: ReadPrec RebootDBClusterResponse # readListPrec :: ReadPrec [RebootDBClusterResponse] #
Show RebootDBClusterResponse Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Methods showsPrec :: Int -> RebootDBClusterResponse -> ShowS # show :: RebootDBClusterResponse -> String # showList :: [RebootDBClusterResponse] -> ShowS #
NFData RebootDBClusterResponse Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Methods rnf :: RebootDBClusterResponse -> () #
Eq RebootDBClusterResponse Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster Methods (==) :: RebootDBClusterResponse -> RebootDBClusterResponse -> Bool # (/=) :: RebootDBClusterResponse -> RebootDBClusterResponse -> Bool #
type Rep RebootDBClusterResponse Source #
Instance details Defined in Amazonka.RDS.RebootDBCluster type Rep RebootDBClusterResponse = D1 ('MetaData "RebootDBClusterResponse" "Amazonka.RDS.RebootDBCluster" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "RebootDBClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbCluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DBCluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRebootDBClusterResponse Source #

Arguments

:: Int	`$sel:httpStatus:RebootDBClusterResponse'`
-> RebootDBClusterResponse

Create a value of RebootDBClusterResponse 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:dbCluster:RebootDBClusterResponse', rebootDBClusterResponse_dbCluster - Undocumented member.

$sel:httpStatus:RebootDBClusterResponse', rebootDBClusterResponse_httpStatus - The response's http status code.

Response Lenses

rebootDBClusterResponse_dbCluster :: Lens' RebootDBClusterResponse (Maybe DBCluster) Source #

Undocumented member.

rebootDBClusterResponse_httpStatus :: Lens' RebootDBClusterResponse Int Source #

The response's http status code.