delete_db_snapshot ( $db_snapshot_identifier, $opt )

Deletes a DBSnapshot.

The DBSnapshot must be in the available state to be deleted.

Access

public

Parameters

Parameter

Type

Required

Description

$db_snapshot_identifier

string

Required

The DBSnapshot identifier. Constraints: Must be the name of an existing DB Snapshot in the available state.

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • curlopts - array - Optional - A set of values to pass directly into curl_setopt(), where the key is a pre-defined CURLOPT_* constant.
  • returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests.

Returns

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Delete a database snapshot.

// Instantiate the class
$rds = new AmazonRDS();

$response = $rds->delete_db_snapshot('mySnapshot');

// Success?
var_dump($response->isOK());
Result:
bool(true)

Related Methods

Source

Method defined in services/rds.class.php | Toggle source view (7 lines) | View on GitHub

public function delete_db_snapshot($db_snapshot_identifier, $opt = null)
{
    if (!$opt) $opt = array();
    $opt['DBSnapshotIdentifier'] = $db_snapshot_identifier;
    
    return $this->authenticate('DeleteDBSnapshot', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback