amazonka-redshift-1.5.0: Amazon Redshift SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Redshift.DeleteCluster

Contents

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 .

Synopsis

Creating a Request

deleteCluster Source #

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

See: deleteCluster smart constructor.

Instances

Eq DeleteCluster Source # 
Data DeleteCluster Source # 

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 Source # 
Show DeleteCluster Source # 
Generic DeleteCluster Source # 

Associated Types

type Rep DeleteCluster :: * -> * #

Hashable DeleteCluster Source # 
NFData DeleteCluster Source # 

Methods

rnf :: DeleteCluster -> () #

AWSRequest DeleteCluster Source # 
ToQuery DeleteCluster Source # 
ToPath DeleteCluster Source # 
ToHeaders DeleteCluster Source # 
type Rep DeleteCluster Source # 
type Rep DeleteCluster = D1 (MetaData "DeleteCluster" "Network.AWS.Redshift.DeleteCluster" "amazonka-redshift-1.5.0-Dab3rZV2tPBCgimwpoJly0" False) (C1 (MetaCons "DeleteCluster'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_delSkipFinalClusterSnapshot") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_delFinalClusterSnapshotIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_delClusterIdentifier") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))
type Rs DeleteCluster Source # 

Request Lenses

delSkipFinalClusterSnapshot :: Lens' DeleteCluster (Maybe Bool) Source #

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

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

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

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:

data DeleteClusterResponse Source #

See: deleteClusterResponse smart constructor.

Instances

Eq DeleteClusterResponse Source # 
Data DeleteClusterResponse Source # 

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 Source # 
Show DeleteClusterResponse Source # 
Generic DeleteClusterResponse Source # 
NFData DeleteClusterResponse Source # 

Methods

rnf :: DeleteClusterResponse -> () #

type Rep DeleteClusterResponse Source # 
type Rep DeleteClusterResponse = D1 (MetaData "DeleteClusterResponse" "Network.AWS.Redshift.DeleteCluster" "amazonka-redshift-1.5.0-Dab3rZV2tPBCgimwpoJly0" False) (C1 (MetaCons "DeleteClusterResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_drsCluster") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Cluster))) (S1 (MetaSel (Just Symbol "_drsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

drsResponseStatus :: Lens' DeleteClusterResponse Int Source #

  • - | The response status code.