Class: Aws::RDS::Types::DeleteDBInstanceMessage
- Inherits:
-
Struct
- Object
- Struct
- Aws::RDS::Types::DeleteDBInstanceMessage
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-rds/types.rb
Overview
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",
delete_automated_backups: false,
}
Instance Attribute Summary collapse
-
#db_instance_identifier ⇒ 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.
-
#final_db_snapshot_identifier ⇒ String
The ‘DBSnapshotIdentifier` of the new DB snapshot created when `SkipFinalSnapshot` is set to `false`.
-
#skip_final_snapshot ⇒ Boolean
A value that indicates whether a final DB snapshot is created before the DB instance is deleted.
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.
^
6303 6304 6305 6306 6307 6308 6309 |
# File 'lib/aws-sdk-rds/types.rb', line 6303 class DeleteDBInstanceMessage < Struct.new( :db_instance_identifier, :skip_final_snapshot, :final_db_snapshot_identifier, :delete_automated_backups) include Aws::Structure end |
#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. This parameter defaults to ‘true`.
6303 6304 6305 6306 6307 6308 6309 |
# File 'lib/aws-sdk-rds/types.rb', line 6303 class DeleteDBInstanceMessage < Struct.new( :db_instance_identifier, :skip_final_snapshot, :final_db_snapshot_identifier, :delete_automated_backups) include Aws::Structure end |
#final_db_snapshot_identifier ⇒ String
The ‘DBSnapshotIdentifier` of the new DB snapshot 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 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.
6303 6304 6305 6306 6307 6308 6309 |
# File 'lib/aws-sdk-rds/types.rb', line 6303 class DeleteDBInstanceMessage < Struct.new( :db_instance_identifier, :skip_final_snapshot, :final_db_snapshot_identifier, :delete_automated_backups) include Aws::Structure end |
#skip_final_snapshot ⇒ Boolean
A value that indicates whether a final DB snapshot is created before the DB instance is deleted. If ‘true` is specified, no DB snapshot is created. If `false` is specified, a DB snapshot is created before the DB instance is deleted.
When a DB instance is in a failure state and has a status of ‘failed`, `incompatible-restore`, or `incompatible-network`, you can only delete it 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`
6303 6304 6305 6306 6307 6308 6309 |
# File 'lib/aws-sdk-rds/types.rb', line 6303 class DeleteDBInstanceMessage < Struct.new( :db_instance_identifier, :skip_final_snapshot, :final_db_snapshot_identifier, :delete_automated_backups) include Aws::Structure end |