redshift_delete_cluster: Deletes a previously provisioned cluster without its final...

View source: R/redshift_operations.R

redshift_delete_clusterR Documentation

Deletes a previously provisioned cluster without its final snapshot being created

Description

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 describe_clusters 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.

See https://www.paws-r-sdk.com/docs/redshift_delete_cluster/ for full documentation.

Usage

redshift_delete_cluster(
  ClusterIdentifier,
  SkipFinalClusterSnapshot = NULL,
  FinalClusterSnapshotIdentifier = NULL,
  FinalClusterSnapshotRetentionPeriod = NULL
)

Arguments

ClusterIdentifier

[required] 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.

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

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.

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.


paws.database documentation built on Sept. 12, 2023, 1:21 a.m.