PHP Class Scalr\Service\Aws\Rds\DataType\DBSnapshotData

Since: 27.03.2013
Author: Vitaliy Demidov ([email protected])
Inheritance: extends Scalr\Service\Aws\Rds\AbstractRdsDataType
Exibir arquivo Open project: scalr/scalr Class Usage Examples

Public Properties

Property Type Description
$allocatedStorage integer Specifies the allocated storage size in gigabytes (GB).
$availabilityZone string Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.
$dBInstanceIdentifier string Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from
$dBSnapshotIdentifier string Specifies the identifier for the DB Snapshot.
$engine string Specifies the name of the database engine
$engineVersion string Specifies the version of the database engine
$instanceCreateTime DateTime Specifies the time (UTC) when the snapshot was taken
$iops integer Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot
$licenseModel string License model information for the restored DB Instance
$masterUsername string Provides the master username for the DB Instance
$port integer Specifies the port that the database engine was listening on at the time of the snapshot
$snapshotCreateTime DateTime Provides the time (UTC) when the snapshot was taken.
$snapshotType string Provides the type of the DB Snapshot
$status string Specifies the status of this DB Snapshot
$storageType string Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified; otherwise standard
$vpcId string Provides the Vpc Id associated with the DB Snapshot

Public Methods

Method Description
delete ( ) : DBSnapshotData DeleteDBSnapshot action
getRestoreFromSnapshotRequest ( string $dbInstanceIdentifier ) : Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData Gets a new RestoreDBInstanceFromDBSnapshotRequestData object for this DB Instance
refresh ( ) : DBSnapshotData DescribeDBSnapshots action
restoreFromSnapshot ( Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData | string $request ) : DBInstanceData RestoreDBInstanceFromDBSnapshot action

Protected Methods

Method Description
throwExceptionIfNotInitialized ( )

Method Details

delete() public method

Deletes a DBSnapshot. Note! The DBSnapshot must be in the available state to be deleted
public delete ( ) : DBSnapshotData
return DBSnapshotData Returns DBSnapshotData on success or throws an exception.

getRestoreFromSnapshotRequest() public method

Gets a new RestoreDBInstanceFromDBSnapshotRequestData object for this DB Instance
public getRestoreFromSnapshotRequest ( string $dbInstanceIdentifier ) : Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData
$dbInstanceIdentifier string The DB Instance Identifier.
return Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData

refresh() public method

Refreshes description of the object using request to Amazon. NOTE! It refreshes object itself only when EntityManager is enabled. If not, solution is to use $object = object->refresh() instead.
public refresh ( ) : DBSnapshotData
return DBSnapshotData Returns DBSnapshotData on success or throws an exception.

restoreFromSnapshot() public method

Creates a new DB Instance from a DB snapshot.The target database is created from the source database restore point with the same configuration as the original source database, except that the new RDS instance is created with the default security group.
public restoreFromSnapshot ( Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData | string $request ) : DBInstanceData
$request Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData | string The request object or DB Instance Identifier
return DBInstanceData Returns DBInstanceData on success or throws an exception.

throwExceptionIfNotInitialized() protected method

protected throwExceptionIfNotInitialized ( )

Property Details

$allocatedStorage public_oe property

Specifies the allocated storage size in gigabytes (GB).
public int $allocatedStorage
return integer

$availabilityZone public_oe property

Specifies the name of the Availability Zone the DB Instance was located in at the time of the DB Snapshot.
public string $availabilityZone
return string

$dBInstanceIdentifier public_oe property

Specifies the the DBInstanceIdentifier of the DB Instance this DB Snapshot was created from
public string $dBInstanceIdentifier
return string

$dBSnapshotIdentifier public_oe property

Specifies the identifier for the DB Snapshot.
public string $dBSnapshotIdentifier
return string

$engine public_oe property

Specifies the name of the database engine
public string $engine
return string

$engineVersion public_oe property

Specifies the version of the database engine
public string $engineVersion
return string

$instanceCreateTime public_oe property

Specifies the time (UTC) when the snapshot was taken
public DateTime $instanceCreateTime
return DateTime

$iops public_oe property

Specifies the Provisioned IOPS (I/O operations per second) value of the DB Instance at the time of the snapshot
public int $iops
return integer

$licenseModel public_oe property

License model information for the restored DB Instance
public string $licenseModel
return string

$masterUsername public_oe property

Provides the master username for the DB Instance
public string $masterUsername
return string

$port public_oe property

Specifies the port that the database engine was listening on at the time of the snapshot
public int $port
return integer

$snapshotCreateTime public_oe property

Provides the time (UTC) when the snapshot was taken.
public DateTime $snapshotCreateTime
return DateTime

$snapshotType public_oe property

Provides the type of the DB Snapshot
public string $snapshotType
return string

$status public_oe property

Specifies the status of this DB Snapshot
public string $status
return string

$storageType public_oe property

Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified; otherwise standard
public string $storageType
return string

$vpcId public_oe property

Provides the Vpc Id associated with the DB Snapshot
public string $vpcId
return string