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

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

Public Properties

Property Type Description
$allocatedStorage integer Specifies the allocated storage size specified in gigabytes.
$autoMinorVersionUpgrade boolean Indicates that minor version patches are applied automatically
$availabilityZone string Specifies the name of the Availability Zone the DB Instance is located in.
$backupRetentionPeriod integer Specifies the number of days for which automatic DB Snapshots are retained
$characterSetName string If present, specifies the name of the character set that this instance is associated with
$dBClusterIdentifier string If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
$dBInstanceClass string Contains the name of the compute and memory capacity class of the DB Instance
$dBInstanceIdentifier string This is the unique key that identifies a DB Instance
$dBInstanceStatus string Specifies the current state of this database
$dBName string MySQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance. Oracle Contains the Oracle System ID (SID) of the created DB Instance
$engine string Provides the name of the database engine to be used for this DB Instance.
$engineVersion string Indicates the database engine version.
$instanceCreateTime DateTime Provides the date and time the DB Instance was created.
$iops integer Specifies the Provisioned IOPS (I/O operations per second) value
$kmsKeyId string If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.
$latestRestorableTime DateTime Specifies the latest time to which a database can be restored with point-in-time restore
$licenseModel string License model information for this DB Instance
$masterUsername string Contains the master username for the DB Instance
$multiAZ boolean Specifies if the DB Instance is a Multi-AZ deployment.
$preferredBackupWindow string Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod
$preferredMaintenanceWindow string Specifies the weekly time range (in UTC) during which system maintenance can occur
$publiclyAccessible boolean publiclyAccessible
$readReplicaDBInstanceIdentifiers array Contains one or more identifiers of the Read Replicas associated with this DB Instance
$readReplicaSourceDBInstanceIdentifier string Contains the identifier of the source DB Instance if this DB Instance is a Read Replica
$secondaryAvailabilityZone string If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
$storageEncrypted boolean Specifies whether the DB instance is encrypted.
$storageType string Specifies the storage type to be associated with the DB instance.

Protected Properties

Property Type Description
$_properties array List of the public properties which is managed by magic getter and setters internally.

Public Methods

Method Description
addTags ( array | Scalr\Service\Aws\Rds\DataType\TagsList $tagsList ) : array Adds metadata tags to an Amazon RDS resource.
createSnapshot ( string $dBSnapshotIdentifier ) : DBSnapshotData CreateDBSnapshot
delete ( boolean $skipFinalSnapshot = null, string $finalDBSnapshotIdentifier = null ) : DBInstanceData DeleteDBInstance action
describeTags ( ) : Scalr\Service\Aws\Rds\DataType\TagsList Lists all tags on an Amazon RDS resource.
getModifyRequest ( ) : Scalr\Service\Aws\Rds\DataType\ModifyDBInstanceRequestData Creates and returns new ModifyDbInstanceRequestData object for this DBInstance
getRestoreFromSnapshotRequest ( string $dbSnapshotIdentifier ) : Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData Gets a new RestoreDBInstanceFromDBSnapshotRequestData object for this DB Instance
modify ( Scalr\Service\Aws\Rds\DataType\ModifyDBInstanceRequestData $request ) : DBInstanceData ModifyDBInstance action
reboot ( boolean $forceFailover = null ) : DBInstanceData RebootDBInstance action
refresh ( ) : DBInstanceData DescribeDBInstances action
removeTags ( array | ListDataType $tagsKeys ) : boolean Removes metadata tags from an Amazon RDS resource.
restoreFromSnapshot ( Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData | string $request ) : DBInstanceData RestoreDBInstanceFromDBSnapshot action

Protected Methods

Method Description
throwExceptionIfNotInitialized ( )

Method Details

addTags() public method

Adds metadata tags to an Amazon RDS resource.
public addTags ( array | Scalr\Service\Aws\Rds\DataType\TagsList $tagsList ) : array
$tagsList array | Scalr\Service\Aws\Rds\DataType\TagsList List of tags to add
return array Returns array of added tags

createSnapshot() public method

Creates a DBSnapshot. The source DBInstance must be in "available" state.
public createSnapshot ( string $dBSnapshotIdentifier ) : DBSnapshotData
$dBSnapshotIdentifier string The identifier for the DB Snapshot.
return DBSnapshotData Returns DBSnapshotData on success or throws an exception.

delete() public method

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
public delete ( boolean $skipFinalSnapshot = null, string $finalDBSnapshotIdentifier = null ) : DBInstanceData
$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 DBInstanceData Returns created DBInstance

describeTags() public method

Lists all tags on an Amazon RDS resource.
public describeTags ( ) : Scalr\Service\Aws\Rds\DataType\TagsList
return Scalr\Service\Aws\Rds\DataType\TagsList

getModifyRequest() public method

Creates and returns new ModifyDbInstanceRequestData object for this DBInstance
public getModifyRequest ( ) : Scalr\Service\Aws\Rds\DataType\ModifyDBInstanceRequestData
return Scalr\Service\Aws\Rds\DataType\ModifyDBInstanceRequestData Returns new ModifyDbInstanceRequestData object for this DBInstance

getRestoreFromSnapshotRequest() public method

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

modify() public method

Modify settings for a DB Instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
public modify ( Scalr\Service\Aws\Rds\DataType\ModifyDBInstanceRequestData $request ) : DBInstanceData
$request Scalr\Service\Aws\Rds\DataType\ModifyDBInstanceRequestData Modify DB Instance request object
return DBInstanceData Returns modified DBInstance

reboot() public method

Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS instance during which the RDS instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. A DBInstance event is created when the reboot is completed.
public reboot ( boolean $forceFailover = null ) : DBInstanceData
$forceFailover boolean optional When true, the reboot will be conducted through a MultiAZ failover. You cannot specify true if the instance is not configured for MultiAZ.
return DBInstanceData Returns DBInstance

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 ( ) : DBInstanceData
return DBInstanceData Return refreshed object

removeTags() public method

Removes metadata tags from an Amazon RDS resource.
public removeTags ( array | ListDataType $tagsKeys ) : boolean
$tagsKeys array | Scalr\Service\Aws\DataType\ListDataType Array of tag keys to remove
return boolean

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 Snapshot Identifier
return DBInstanceData Returns DBInstanceData on success or throws an exception.

throwExceptionIfNotInitialized() protected method

protected throwExceptionIfNotInitialized ( )

Property Details

$_properties protected property

List of the public properties which is managed by magic getter and setters internally.
protected array $_properties
return array

$allocatedStorage public property

Specifies the allocated storage size specified in gigabytes.
public int $allocatedStorage
return integer

$autoMinorVersionUpgrade public property

Indicates that minor version patches are applied automatically
public bool $autoMinorVersionUpgrade
return boolean

$availabilityZone public property

Specifies the name of the Availability Zone the DB Instance is located in.
public string $availabilityZone
return string

$backupRetentionPeriod public property

Specifies the number of days for which automatic DB Snapshots are retained
public int $backupRetentionPeriod
return integer

$characterSetName public property

If present, specifies the name of the character set that this instance is associated with
public string $characterSetName
return string

$dBClusterIdentifier public property

If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of.
public string $dBClusterIdentifier
return string

$dBInstanceClass public property

Contains the name of the compute and memory capacity class of the DB Instance
public string $dBInstanceClass
return string

$dBInstanceIdentifier public property

This is the unique key that identifies a DB Instance
public string $dBInstanceIdentifier
return string

$dBInstanceStatus public property

Specifies the current state of this database
public string $dBInstanceStatus
return string

$dBName public property

MySQL Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB Instance was created. This same name is returned for the life of the DB Instance. Oracle Contains the Oracle System ID (SID) of the created DB Instance
public string $dBName
return string

$engine public property

Provides the name of the database engine to be used for this DB Instance.
public string $engine
return string

$engineVersion public property

Indicates the database engine version.
public string $engineVersion
return string

$instanceCreateTime public property

Provides the date and time the DB Instance was created.
public DateTime $instanceCreateTime
return DateTime

$iops public property

Specifies the Provisioned IOPS (I/O operations per second) value
public int $iops
return integer

$kmsKeyId public property

If StorageEncrypted is true, the KMS key identifier for the encrypted DB instance.
public string $kmsKeyId
return string

$latestRestorableTime public property

Specifies the latest time to which a database can be restored with point-in-time restore
public DateTime $latestRestorableTime
return DateTime

$licenseModel public property

License model information for this DB Instance
public string $licenseModel
return string

$masterUsername public property

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

$multiAZ public property

Specifies if the DB Instance is a Multi-AZ deployment.
public bool $multiAZ
return boolean

$preferredBackupWindow public property

Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod
public string $preferredBackupWindow
return string

$preferredMaintenanceWindow public property

Specifies the weekly time range (in UTC) during which system maintenance can occur
public string $preferredMaintenanceWindow
return string

$publiclyAccessible public property

publiclyAccessible
public bool $publiclyAccessible
return boolean

$readReplicaDBInstanceIdentifiers public property

Contains one or more identifiers of the Read Replicas associated with this DB Instance
public array $readReplicaDBInstanceIdentifiers
return array

$readReplicaSourceDBInstanceIdentifier public property

Contains the identifier of the source DB Instance if this DB Instance is a Read Replica
public string $readReplicaSourceDBInstanceIdentifier
return string

$secondaryAvailabilityZone public property

If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
public string $secondaryAvailabilityZone
return string

$storageEncrypted public property

Specifies whether the DB instance is encrypted.
public bool $storageEncrypted
return boolean

$storageType public property

Specifies the storage type to be associated with the DB instance.
public string $storageType
return string