Class: Aws::RDS::Types::DeleteDBClusterMessage

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/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",
}

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)


6117
6118
6119
6120
6121
6122
# File 'lib/aws-sdk-rds/types.rb', line 6117

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

<note markdown=“1”> Specifying this parameter and also setting the ‘SkipFinalShapshot` parameter to true results in an error.

</note>

Constraints:

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

  • First character must be a letter

  • Can’t end with a hyphen or contain two consecutive hyphens

Returns:

  • (String)


6117
6118
6119
6120
6121
6122
# File 'lib/aws-sdk-rds/types.rb', line 6117

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.

<note markdown=“1”> You must specify a ‘FinalDBSnapshotIdentifier` parameter if `SkipFinalSnapshot` is `false`.

</note>

Default: ‘false`

Returns:

  • (Boolean)


6117
6118
6119
6120
6121
6122
# File 'lib/aws-sdk-rds/types.rb', line 6117

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