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

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 DeleteDBInstanceMessage data as a hash:

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

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 contain from 1 to 63 alphanumeric characters or hyphens

  • First character must be a letter

  • Cannot end with a hyphen or contain two consecutive hyphens

Returns:

  • (String) 


5282
5283
5284
5285
5286
5287
 
# File 'lib/aws-sdk-rds/types.rb', line 5282

class DeleteDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :skip_final_snapshot,
  :final_db_snapshot_identifier)
  include Aws::Structure
end

#final_db_snapshot_identifier ⇒ String

The DBSnapshotIdentifier of the new DBSnapshot 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 alphanumeric characters

  • 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) 


5282
5283
5284
5285
5286
5287
 
# File 'lib/aws-sdk-rds/types.rb', line 5282

class DeleteDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :skip_final_snapshot,
  :final_db_snapshot_identifier)
  include Aws::Structure
end

#skip_final_snapshot ⇒ Boolean

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.

<note markdown=“1”> The FinalDBSnapshotIdentifier parameter must be specified if SkipFinalSnapshot is ‘false`.

</note>

Default: ‘false`

Returns:

  • (Boolean) 


5282
5283
5284
5285
5286
5287
 
# File 'lib/aws-sdk-rds/types.rb', line 5282

class DeleteDBInstanceMessage < Struct.new(
  :db_instance_identifier,
  :skip_final_snapshot,
  :final_db_snapshot_identifier)
  include Aws::Structure
end