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.StopDBInstance

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary.

For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide.

This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.

Creating a Request

data StopDBInstance Source #

See: newStopDBInstance smart constructor.

Constructors

StopDBInstance'
Fields dbSnapshotIdentifier :: Maybe Text The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped. dbInstanceIdentifier :: Text The user-supplied instance identifier.

Instances

Instances details

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

newStopDBInstance Source #

Arguments

:: Text	`StopDBInstance`
-> StopDBInstance

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

StopDBInstance, stopDBInstance_dbSnapshotIdentifier - The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

StopDBInstance, stopDBInstance_dbInstanceIdentifier - The user-supplied instance identifier.

Request Lenses

stopDBInstance_dbSnapshotIdentifier :: Lens' StopDBInstance (Maybe Text) Source #

The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

stopDBInstance_dbInstanceIdentifier :: Lens' StopDBInstance Text Source #

The user-supplied instance identifier.

Destructuring the Response

data StopDBInstanceResponse Source #

See: newStopDBInstanceResponse smart constructor.

Constructors

StopDBInstanceResponse'
Fields dbInstance :: Maybe DBInstance httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStopDBInstanceResponse Source #

Arguments

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

Create a value of StopDBInstanceResponse 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:StopDBInstanceResponse', stopDBInstanceResponse_dbInstance - Undocumented member.

$sel:httpStatus:StopDBInstanceResponse', stopDBInstanceResponse_httpStatus - The response's http status code.

Response Lenses

stopDBInstanceResponse_dbInstance :: Lens' StopDBInstanceResponse (Maybe DBInstance) Source #

Undocumented member.

stopDBInstanceResponse_httpStatus :: Lens' StopDBInstanceResponse Int Source #

The response's http status code.