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.Redshift.DeleteCluster

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Deletes a previously provisioned cluster. A successful response from the web service indicates that the request was received correctly. Use DescribeClusters to monitor the status of the deletion. The delete operation cannot be canceled or reverted once submitted. For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .

If you want to shut down the cluster and retain it for future use, set SkipFinalClusterSnapshot to false and specify a name for FinalClusterSnapshotIdentifier . You can later restore this snapshot to resume using the cluster. If a final cluster snapshot is requested, the status of the cluster will be "final-snapshot" while the snapshot is being taken, then it's "deleting" once Amazon Redshift begins deleting the cluster.

For more information about managing clusters, go to Amazon Redshift Clusters in the Amazon Redshift Cluster Management Guide .

Creating a Request

deleteCluster #

Arguments

:: Text	`delClusterIdentifier`
-> DeleteCluster

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

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

delSkipFinalClusterSnapshot - Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default: false
delFinalClusterSnapshotIdentifier - The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false . Constraints: * Must be 1 to 255 alphanumeric characters. * First character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens.
delClusterIdentifier - The identifier of the cluster to be deleted. Constraints: * Must contain lowercase characters. * Must contain from 1 to 63 alphanumeric characters or hyphens. * First character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens.

data DeleteCluster #

See: deleteCluster smart constructor.

Instances

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

Request Lenses

delSkipFinalClusterSnapshot :: Lens' DeleteCluster (Maybe Bool) #

Determines whether a final snapshot of the cluster is created before Amazon Redshift deletes the cluster. If true , a final cluster snapshot is not created. If false , a final cluster snapshot is created before the cluster is deleted. Default: false

delFinalClusterSnapshotIdentifier :: Lens' DeleteCluster (Maybe Text) #

The identifier of the final snapshot that is to be created immediately before deleting the cluster. If this parameter is provided, SkipFinalClusterSnapshot must be false . Constraints: * Must be 1 to 255 alphanumeric characters. * First character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens.

delClusterIdentifier :: Lens' DeleteCluster Text #

The identifier of the cluster to be deleted. Constraints: * Must contain lowercase characters. * Must contain from 1 to 63 alphanumeric characters or hyphens. * First character must be a letter. * Cannot end with a hyphen or contain two consecutive hyphens.

Destructuring the Response

deleteClusterResponse #

Arguments

:: Int	`drsResponseStatus`
-> DeleteClusterResponse

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

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

drsCluster - Undocumented member.
drsResponseStatus - -- | The response status code.

data DeleteClusterResponse #

See: deleteClusterResponse smart constructor.

Instances

Eq DeleteClusterResponse #
Instance details Defined in Network.AWS.Redshift.DeleteCluster Methods (==) :: DeleteClusterResponse -> DeleteClusterResponse -> Bool # (/=) :: DeleteClusterResponse -> DeleteClusterResponse -> Bool #
Data DeleteClusterResponse #
Instance details Defined in Network.AWS.Redshift.DeleteCluster Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DeleteClusterResponse -> c DeleteClusterResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DeleteClusterResponse # toConstr :: DeleteClusterResponse -> Constr # dataTypeOf :: DeleteClusterResponse -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DeleteClusterResponse) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DeleteClusterResponse) # gmapT :: (forall b. Data b => b -> b) -> DeleteClusterResponse -> DeleteClusterResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DeleteClusterResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DeleteClusterResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> DeleteClusterResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DeleteClusterResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DeleteClusterResponse -> m DeleteClusterResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteClusterResponse -> m DeleteClusterResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DeleteClusterResponse -> m DeleteClusterResponse #
Read DeleteClusterResponse #
Instance details Defined in Network.AWS.Redshift.DeleteCluster Methods readsPrec :: Int -> ReadS DeleteClusterResponse # readList :: ReadS [DeleteClusterResponse] # readPrec :: ReadPrec DeleteClusterResponse # readListPrec :: ReadPrec [DeleteClusterResponse] #
Show DeleteClusterResponse #
Instance details Defined in Network.AWS.Redshift.DeleteCluster Methods showsPrec :: Int -> DeleteClusterResponse -> ShowS # show :: DeleteClusterResponse -> String # showList :: [DeleteClusterResponse] -> ShowS #
Generic DeleteClusterResponse #
Instance details Defined in Network.AWS.Redshift.DeleteCluster Associated Types type Rep DeleteClusterResponse :: Type -> Type # Methods from :: DeleteClusterResponse -> Rep DeleteClusterResponse x # to :: Rep DeleteClusterResponse x -> DeleteClusterResponse #
NFData DeleteClusterResponse #
Instance details Defined in Network.AWS.Redshift.DeleteCluster Methods rnf :: DeleteClusterResponse -> () #
type Rep DeleteClusterResponse #
Instance details Defined in Network.AWS.Redshift.DeleteCluster type Rep DeleteClusterResponse = D1 (MetaData "DeleteClusterResponse" "Network.AWS.Redshift.DeleteCluster" "amazonka-redshift-1.6.1-7E7pXybui4gHstewEovezS" False) (C1 (MetaCons "DeleteClusterResponse'" PrefixI True) (S1 (MetaSel (Just "_drsCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Cluster)) :*: S1 (MetaSel (Just "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)))

Response Lenses

drsCluster :: Lens' DeleteClusterResponse (Maybe Cluster) #

Undocumented member.

drsResponseStatus :: Lens' DeleteClusterResponse Int #

- | The response status code.