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

Inherits:

Struct

• Object
• Struct
• Aws::RDS::Types::DeleteDBInstanceMessage

Includes:

Structure

Defined in:

lib/aws-sdk-rds/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #db_instance_identifier ⇒ String

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

• #delete_automated_backups ⇒ Boolean

  Specifies 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.

• #skip_final_snapshot ⇒ Boolean

  Specifies whether to skip the creation of a final DB snapshot before deleting the instance.

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)

# File 'lib/aws-sdk-rds/types.rb', line 11645

class DeleteDBInstanceMessage < Struct.new(
  :db_instance_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 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)

# File 'lib/aws-sdk-rds/types.rb', line 11645

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

#final_db_snapshot_identifier ⇒ String

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

<note markdown=“1”> If you enable this parameter and also enable SkipFinalShapshot, the command results in an error.

</note>

This setting doesn’t apply to RDS Custom.

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)

# File 'lib/aws-sdk-rds/types.rb', line 11645

class DeleteDBInstanceMessage < Struct.new(
  :db_instance_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 snapshot before deleting the instance. If you enable this parameter, RDS doesn’t create a DB snapshot. If you don’t enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn’t enabled, and the DB snapshot is created.

<note markdown=“1”> If you don’t enable this parameter, you must specify the ‘FinalDBSnapshotIdentifier` parameter.

</note>

When a DB instance is in a failure state and has a status of ‘failed`, `incompatible-restore`, or `incompatible-network`, RDS can delete the instance only if you enable this parameter.

If you delete a read replica or an RDS Custom instance, you must enable this setting.

This setting is required for RDS Custom.

Returns:

• (Boolean)

# File 'lib/aws-sdk-rds/types.rb', line 11645

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