Scalr\Service\Aws\Rds\DataType\DBClusterData::delete PHP Method

DBClusterData Class Documentation Show file Open project: scalr/scalr

delete() public method

The DeleteDBCluster API deletes a previously provisioned RDS cluster. 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

public delete ( boolean $skipFinalSnapshot = null, string $finalDBSnapshotIdentifier = null ) : DBClusterData
$skipFinalSnapshot	boolean	optional Determines whether a final DB Snapshot is created before the DB Instance is deleted
$finalDBSnapshotIdentifier	string	optional The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false
return	DBClusterData	Returns created DBCluster

    public function delete($skipFinalSnapshot = null, $finalDBSnapshotIdentifier = null)
    {
        $this->throwExceptionIfNotInitialized();
        return $this->getRds()->dbCluster->delete($this->dBClusterIdentifier, $skipFinalSnapshot, $finalDBSnapshotIdentifier);
    }

DBClusterData

addTags

delete

describeTags

getModifyRequest

modify

refresh

removeTags

throwExceptionIfNotInitialized