You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DocDB::Types::DeleteDBClusterMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DeleteDBClusterMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  db_cluster_identifier: "String", # required
  skip_final_snapshot: false,
  final_db_snapshot_identifier: "String",
}

Represents the input to DeleteDBCluster.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_identifier ⇒ String

The cluster identifier for the cluster to be deleted. This parameter isn\'t case sensitive.

Constraints:

  • Must match an existing DBClusterIdentifier.

^

Returns:

  • (String) —

    The cluster identifier for the cluster to be deleted.

#final_db_snapshot_identifier ⇒ String

The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

Specifying this parameter and also setting the SkipFinalShapshot parameter to true results in an error.

Constraints:

  • Must be from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Returns:

  • (String) —

    The cluster snapshot identifier of the new cluster snapshot created when SkipFinalSnapshot is set to false.

#skip_final_snapshot ⇒ Boolean

Determines whether a final cluster snapshot is created before the cluster is deleted. If true is specified, no cluster snapshot is created. If false is specified, a cluster snapshot is created before the DB cluster is deleted.

If SkipFinalSnapshot is false, you must specify a FinalDBSnapshotIdentifier parameter.

Default: false

Returns:

  • (Boolean) —

    Determines whether a final cluster snapshot is created before the cluster is deleted.