| Copyright | (c) 2013-2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.Redshift.DeleteCluster
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 .
See: AWS API Reference for DeleteCluster.
- deleteCluster :: Text -> DeleteCluster
- data DeleteCluster
- delSkipFinalClusterSnapshot :: Lens' DeleteCluster (Maybe Bool)
- delFinalClusterSnapshotIdentifier :: Lens' DeleteCluster (Maybe Text)
- delClusterIdentifier :: Lens' DeleteCluster Text
- deleteClusterResponse :: Int -> DeleteClusterResponse
- data DeleteClusterResponse
- drsCluster :: Lens' DeleteClusterResponse (Maybe Cluster)
- drsResponseStatus :: Lens' DeleteClusterResponse Int
Creating a Request
Arguments
| :: Text | |
| -> 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:
data DeleteCluster Source
See: deleteCluster smart constructor.
Instances
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.
The FinalClusterSnapshotIdentifier parameter must be specified if
SkipFinalClusterSnapshot is false.
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
Arguments
| :: Int | |
| -> 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:
data DeleteClusterResponse Source
See: deleteClusterResponse smart constructor.
Response Lenses
drsCluster :: Lens' DeleteClusterResponse (Maybe Cluster) Source
Undocumented member.
drsResponseStatus :: Lens' DeleteClusterResponse Int Source
The response status code.