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

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.

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_identifierString

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

Constraints:

  • Must match an existing DBClusterIdentifier.

^

Returns:

  • (String)


1938
1939
1940
1941
1942
1943
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1938

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

#final_db_snapshot_identifierString

The DB cluster snapshot identifier of the new DB 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)


1938
1939
1940
1941
1942
1943
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1938

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

#skip_final_snapshotBoolean

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

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

Default: false

Returns:

  • (Boolean)


1938
1939
1940
1941
1942
1943
# File 'gems/aws-sdk-docdb/lib/aws-sdk-docdb/types.rb', line 1938

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