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

Class: Aws::RDS::Types::DeleteDBInstanceMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DeleteDBInstanceMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  db_instance_identifier: "String", # required
  skip_final_snapshot: false,
  final_db_snapshot_identifier: "String",
  delete_automated_backups: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#db_instance_identifier ⇒ String

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

Constraints:

  • Must match the name of an existing DB instance.

^

Returns:

  • (String) —

    The DB instance identifier for the DB instance to be deleted.

#delete_automated_backups ⇒ Boolean

A value that indicates whether to remove automated backups immediately after the DB instance is deleted. This parameter isn\'t case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.

Returns:

  • (Boolean) —

    A value that indicates whether to remove automated backups immediately after the DB instance is deleted.

#final_db_snapshot_identifier ⇒ String

The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

Specifying this parameter and also specifying to skip final DB snapshot creation in SkipFinalShapshot results in an error.

Constraints:

  • Must be 1 to 255 letters or numbers.

  • First character must be a letter.

  • Can\'t end with a hyphen or contain two consecutive hyphens.

  • Can\'t be specified when deleting a read replica.

Returns:

  • (String) —

    The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.

#skip_final_snapshot ⇒ Boolean

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

When a DB instance is in a failure state and has a status of \'failed\', \'incompatible-restore\', or \'incompatible-network\', it can only be deleted when skip is specified.

Specify skip when deleting a read replica.

The FinalDBSnapshotIdentifier parameter must be specified if skip isn\'t specified.

Returns:

  • (Boolean) —

    A value that indicates whether to skip the creation of a final DB snapshot before the DB instance is deleted.