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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-rds/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#db_cluster_identifier ⇒ String

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) 


11531
11532
11533
11534
11535
11536
11537
11538
 
# File 'lib/aws-sdk-rds/types.rb', line 11531

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

#delete_automated_backups ⇒ Boolean

Specifies whether to remove automated backups immediately after the DB cluster is deleted. This parameter isn’t case-sensitive. The default is to remove automated backups immediately after the DB cluster is deleted.

Returns:

  • (Boolean) 


11531
11532
11533
11534
11535
11536
11537
11538
 
# File 'lib/aws-sdk-rds/types.rb', line 11531

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

#final_db_snapshot_identifier ⇒ String

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

<note markdown=“1”> If you specify this parameter and also skip the creation of a final DB cluster snapshot with the ‘SkipFinalShapshot` parameter, the request 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) 


11531
11532
11533
11534
11535
11536
11537
11538
 
# File 'lib/aws-sdk-rds/types.rb', line 11531

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

#skip_final_snapshot ⇒ Boolean

Specifies whether to skip the creation of a final DB cluster snapshot before RDS deletes the DB cluster. If you set this value to ‘true`, RDS doesn’t create a final DB cluster snapshot. If you set this value to ‘false` or don’t specify it, RDS creates a DB cluster snapshot before it deletes the DB cluster. By default, this parameter is disabled, so RDS creates a final DB cluster snapshot.

<note markdown=“1”> If ‘SkipFinalSnapshot` is disabled, you must specify a value for the `FinalDBSnapshotIdentifier` parameter.

</note>

Returns:

  • (Boolean) 


11531
11532
11533
11534
11535
11536
11537
11538
 
# File 'lib/aws-sdk-rds/types.rb', line 11531

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