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 |
Deletes a previously provisioned cluster without its final snapshot being created. 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
- data DeleteCluster = DeleteCluster' {}
- newDeleteCluster :: Text -> DeleteCluster
- deleteCluster_finalClusterSnapshotIdentifier :: Lens' DeleteCluster (Maybe Text)
- deleteCluster_finalClusterSnapshotRetentionPeriod :: Lens' DeleteCluster (Maybe Int)
- deleteCluster_skipFinalClusterSnapshot :: Lens' DeleteCluster (Maybe Bool)
- deleteCluster_clusterIdentifier :: Lens' DeleteCluster Text
- data DeleteClusterResponse = DeleteClusterResponse' {
- cluster :: Maybe Cluster
- httpStatus :: Int
- newDeleteClusterResponse :: Int -> DeleteClusterResponse
- deleteClusterResponse_cluster :: Lens' DeleteClusterResponse (Maybe Cluster)
- deleteClusterResponse_httpStatus :: Lens' DeleteClusterResponse Int
Creating a Request
data DeleteCluster Source #
See: newDeleteCluster
smart constructor.
DeleteCluster' | |
|
Instances
Create a value of DeleteCluster
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:finalClusterSnapshotIdentifier:DeleteCluster'
, deleteCluster_finalClusterSnapshotIdentifier
- 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.
$sel:finalClusterSnapshotRetentionPeriod:DeleteCluster'
, deleteCluster_finalClusterSnapshotRetentionPeriod
- The number of days that a manual snapshot is retained. If the value is
-1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
$sel:skipFinalClusterSnapshot:DeleteCluster'
, deleteCluster_skipFinalClusterSnapshot
- 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
DeleteCluster
, deleteCluster_clusterIdentifier
- 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.
Request Lenses
deleteCluster_finalClusterSnapshotIdentifier :: 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.
deleteCluster_finalClusterSnapshotRetentionPeriod :: Lens' DeleteCluster (Maybe Int) Source #
The number of days that a manual snapshot is retained. If the value is -1, the manual snapshot is retained indefinitely.
The value must be either -1 or an integer between 1 and 3,653.
The default value is -1.
deleteCluster_skipFinalClusterSnapshot :: 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
deleteCluster_clusterIdentifier :: 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
data DeleteClusterResponse Source #
See: newDeleteClusterResponse
smart constructor.
DeleteClusterResponse' | |
|
Instances
newDeleteClusterResponse Source #
Create a value of DeleteClusterResponse
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:cluster:DeleteClusterResponse'
, deleteClusterResponse_cluster
- Undocumented member.
$sel:httpStatus:DeleteClusterResponse'
, deleteClusterResponse_httpStatus
- The response's http status code.
Response Lenses
deleteClusterResponse_cluster :: Lens' DeleteClusterResponse (Maybe Cluster) Source #
Undocumented member.
deleteClusterResponse_httpStatus :: Lens' DeleteClusterResponse Int Source #
The response's http status code.