AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb

Overview

Note:

When making an API call, you may pass DeleteDBClusterMessage data as a hash:

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

Represents the input to DeleteDBCluster.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_identifierString

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

Constraints:

  • Must match an existing DBClusterIdentifier.

^

Returns:

  • (String)


2386
2387
2388
2389
2390
2391
2392
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2386

class DeleteDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :skip_final_snapshot,
  :final_db_snapshot_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#final_db_snapshot_identifierString

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)


2386
2387
2388
2389
2390
2391
2392
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2386

class DeleteDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :skip_final_snapshot,
  :final_db_snapshot_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#skip_final_snapshotBoolean

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)


2386
2387
2388
2389
2390
2391
2392
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 2386

class DeleteDBClusterMessage < Struct.new(
  :db_cluster_identifier,
  :skip_final_snapshot,
  :final_db_snapshot_identifier)
  SENSITIVE = []
  include Aws::Structure
end