Copyright	(c) 2013-2018 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.RDS.DeleteDBCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.

For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.

Creating a Request

deleteDBCluster #

Arguments

:: Text	`ddbcDBClusterIdentifier`
-> DeleteDBCluster

Creates a value of DeleteDBCluster with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ddbcFinalDBSnapshotIdentifier - The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false . Constraints: * Must be 1 to 255 letters, numbers, or hyphens. * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens
ddbcSkipFinalSnapshot - Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted. Default: false
ddbcDBClusterIdentifier - The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive. Constraints: * Must match an existing DBClusterIdentifier.

data DeleteDBCluster #

See: deleteDBCluster smart constructor.

Instances

Eq DeleteDBCluster #
Methods (==) :: DeleteDBCluster -> DeleteDBCluster -> Bool # (/=) :: DeleteDBCluster -> DeleteDBCluster -> Bool #
Data DeleteDBCluster #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteDBCluster -> c DeleteDBCluster # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteDBCluster # toConstr :: DeleteDBCluster -> Constr # dataTypeOf :: DeleteDBCluster -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteDBCluster) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteDBCluster) # gmapT :: (forall b. Data b => b -> b) -> DeleteDBCluster -> DeleteDBCluster # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDBCluster -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDBCluster -> r # gmapQ :: (forall d. Data d => d -> u) -> DeleteDBCluster -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteDBCluster -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteDBCluster -> m DeleteDBCluster # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDBCluster -> m DeleteDBCluster # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDBCluster -> m DeleteDBCluster #
Read DeleteDBCluster #
Methods readsPrec :: Int -> ReadS DeleteDBCluster # readList :: ReadS [DeleteDBCluster] # readPrec :: ReadPrec DeleteDBCluster # readListPrec :: ReadPrec [DeleteDBCluster] #
Show DeleteDBCluster #
Methods showsPrec :: Int -> DeleteDBCluster -> ShowS # show :: DeleteDBCluster -> String # showList :: [DeleteDBCluster] -> ShowS #
Generic DeleteDBCluster #
Associated Types type Rep DeleteDBCluster :: * -> * # Methods from :: DeleteDBCluster -> Rep DeleteDBCluster x # to :: Rep DeleteDBCluster x -> DeleteDBCluster #
Hashable DeleteDBCluster #
Methods hashWithSalt :: Int -> DeleteDBCluster -> Int # hash :: DeleteDBCluster -> Int #
NFData DeleteDBCluster #
Methods rnf :: DeleteDBCluster -> () #
AWSRequest DeleteDBCluster #
Associated Types type Rs DeleteDBCluster :: * # Methods request :: DeleteDBCluster -> Request DeleteDBCluster # response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * DeleteDBCluster -> ClientResponse -> m (Response DeleteDBCluster) #
ToHeaders DeleteDBCluster #
Methods toHeaders :: DeleteDBCluster -> [Header] #
ToPath DeleteDBCluster #
Methods toPath :: DeleteDBCluster -> ByteString #
ToQuery DeleteDBCluster #
Methods toQuery :: DeleteDBCluster -> QueryString #
type Rep DeleteDBCluster #
type Rep DeleteDBCluster = D1 * (MetaData "DeleteDBCluster" "Network.AWS.RDS.DeleteDBCluster" "amazonka-rds-1.6.0-2158IlTVqH2A5Sz7rtHmOq" False) (C1 * (MetaCons "DeleteDBCluster'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_ddbcFinalDBSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((::) (S1 * (MetaSel (Just Symbol "_ddbcSkipFinalSnapshot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_ddbcDBClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))
type Rs DeleteDBCluster #
type Rs DeleteDBCluster = DeleteDBClusterResponse

Request Lenses

ddbcFinalDBSnapshotIdentifier :: Lens' DeleteDBCluster (Maybe Text) #

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is set to false . Constraints: * Must be 1 to 255 letters, numbers, or hyphens. * First character must be a letter * Cannot end with a hyphen or contain two consecutive hyphens

ddbcSkipFinalSnapshot :: Lens' DeleteDBCluster (Maybe Bool) #

Determines whether a final DB cluster snapshot is created before the DB cluster is deleted. If true is specified, no DB cluster snapshot is created. If false is specified, a DB cluster snapshot is created before the DB cluster is deleted. Default: false

ddbcDBClusterIdentifier :: Lens' DeleteDBCluster Text #

The DB cluster identifier for the DB cluster to be deleted. This parameter isn't case-sensitive. Constraints: * Must match an existing DBClusterIdentifier.

Destructuring the Response

deleteDBClusterResponse #

Arguments

:: Int	`ddbcrsResponseStatus`
-> DeleteDBClusterResponse

Creates a value of DeleteDBClusterResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ddbcrsDBCluster - Undocumented member.
ddbcrsResponseStatus - -- | The response status code.

data DeleteDBClusterResponse #

See: deleteDBClusterResponse smart constructor.

Instances

Eq DeleteDBClusterResponse #
Methods (==) :: DeleteDBClusterResponse -> DeleteDBClusterResponse -> Bool # (/=) :: DeleteDBClusterResponse -> DeleteDBClusterResponse -> Bool #
Data DeleteDBClusterResponse #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteDBClusterResponse -> c DeleteDBClusterResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteDBClusterResponse # toConstr :: DeleteDBClusterResponse -> Constr # dataTypeOf :: DeleteDBClusterResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c DeleteDBClusterResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteDBClusterResponse) # gmapT :: (forall b. Data b => b -> b) -> DeleteDBClusterResponse -> DeleteDBClusterResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDBClusterResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteDBClusterResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DeleteDBClusterResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteDBClusterResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteDBClusterResponse -> m DeleteDBClusterResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDBClusterResponse -> m DeleteDBClusterResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteDBClusterResponse -> m DeleteDBClusterResponse #
Read DeleteDBClusterResponse #
Methods readsPrec :: Int -> ReadS DeleteDBClusterResponse # readList :: ReadS [DeleteDBClusterResponse] # readPrec :: ReadPrec DeleteDBClusterResponse # readListPrec :: ReadPrec [DeleteDBClusterResponse] #
Show DeleteDBClusterResponse #
Methods showsPrec :: Int -> DeleteDBClusterResponse -> ShowS # show :: DeleteDBClusterResponse -> String # showList :: [DeleteDBClusterResponse] -> ShowS #
Generic DeleteDBClusterResponse #
Associated Types type Rep DeleteDBClusterResponse :: * -> * # Methods from :: DeleteDBClusterResponse -> Rep DeleteDBClusterResponse x # to :: Rep DeleteDBClusterResponse x -> DeleteDBClusterResponse #
NFData DeleteDBClusterResponse #
Methods rnf :: DeleteDBClusterResponse -> () #
type Rep DeleteDBClusterResponse #
type Rep DeleteDBClusterResponse = D1 * (MetaData "DeleteDBClusterResponse" "Network.AWS.RDS.DeleteDBCluster" "amazonka-rds-1.6.0-2158IlTVqH2A5Sz7rtHmOq" False) (C1 * (MetaCons "DeleteDBClusterResponse'" PrefixI True) ((::) (S1 * (MetaSel (Just Symbol "_ddbcrsDBCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe DBCluster))) (S1 * (MetaSel (Just Symbol "_ddbcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

ddbcrsDBCluster :: Lens' DeleteDBClusterResponse (Maybe DBCluster) #

Undocumented member.

ddbcrsResponseStatus :: Lens' DeleteDBClusterResponse Int #

- | The response status code.