rds_delete_db_instance: The DeleteDBInstance action deletes a previously provisioned...

In paws.database: 'Amazon Web Services' Database Services

The DeleteDBInstance action deletes a previously provisioned DB instance

Description

The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to be deleted by delete_db_instance are not deleted.

See https://www.paws-r-sdk.com/docs/rds_delete_db_instance/ for full documentation.

Usage

rds_delete_db_instance(
  DBInstanceIdentifier,
  SkipFinalSnapshot = NULL,
  FinalDBSnapshotIdentifier = NULL,
  DeleteAutomatedBackups = NULL
)

Arguments

DBInstanceIdentifier	[required] 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.
SkipFinalSnapshot	A value that indicates 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. If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter. 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.
FinalDBSnapshotIdentifier	The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled. If you enable this parameter and also enable SkipFinalShapshot, the command results in an error. 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.
DeleteAutomatedBackups	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.

paws.database documentation built on Sept. 12, 2023, 1:21 a.m.