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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#db_instance_identifierString

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.

#final_db_snapshot_identifierString

The DBSnapshotIdentifier of the new DBSnapshot 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 1 to 255 letters or numbers.

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

  • Cannot be specified when deleting a Read Replica.

Returns:

  • (String)

    The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false.

#skip_final_snapshotBoolean

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

Note that 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 the SkipFinalSnapshot parameter is set to \"true\".

Specify true when deleting a Read Replica.

The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is false.

Default: false

Returns:

  • (Boolean)

    Determines whether a final DB snapshot is created before the DB instance is deleted.