The DeleteDBInstance API deletes a previously provisioned RDS instance. A successful response from the web service indicates the request was received correctly. If a final DBSnapshot is requested the status of the RDS instance will be “deleting” until the DBSnapshot is created. DescribeDBInstance is used to monitor the status of this operation. This cannot be canceled or reverted once submitted.
Access
public
Parameters
Parameter |
Type |
Required |
Description |
---|---|---|---|
|
Required |
The DB Instance identifier for the DB Instance to be deleted. This parameter isn’t case sensitive. Constraints:
|
|
|
Optional |
An associative array of parameters that can have the following keys:
|
Returns
Type |
Description |
---|---|
A |
Examples
Delete a database instance.
// Instantiate the class $rds = new AmazonRDS(); $response = $rds->delete_db_instance('myInstance', array( 'SkipFinalSnapshot' => true )); // Success? var_dump($response->isOK());
Related Methods
Source
Method defined in services/rds.class.php | Toggle source view (7 lines) | View on GitHub