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

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

Constant Summary collapse

SENSITIVE =
[]

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)


7851
7852
7853
7854
7855
7856
7857
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7851

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

#final_db_snapshot_identifierString

The DB cluster snapshot identifier of the new DB cluster snapshot created when SkipFinalSnapshot is disabled.

Specifying this parameter and also skipping the creation of a final DB cluster snapshot with the SkipFinalShapshot parameter results in an error.

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)


7851
7852
7853
7854
7855
7856
7857
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7851

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

#skip_final_snapshotBoolean

A value that indicates whether to skip the creation of a final DB cluster snapshot before the DB cluster is deleted. If skip is specified, no DB cluster snapshot is created. If skip isn't specified, a DB cluster snapshot is created before the DB cluster is deleted. By default, skip isn't specified, and the DB cluster snapshot is created. By default, this parameter is disabled.

You must specify a FinalDBSnapshotIdentifier parameter if SkipFinalSnapshot is disabled.

Returns:

  • (Boolean)


7851
7852
7853
7854
7855
7856
7857
# File 'gems/aws-sdk-rds/lib/aws-sdk-rds/types.rb', line 7851

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