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

Author: N.V.

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.
$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	This is the unique key that identifies a DB Instance
$dBClusterParameterGroup	string	Specifies the name of the DB cluster parameter group for the DB cluster.
$dBSubnetGroup	string	Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
$databaseName	string	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.
$earliestRestorableTime	DateTime	Specifies the earliest time to which a database can be restored with point-in-time restore.
$endpoint	string	Specifies the connection endpoint for the primary instance of the DB cluster.
$engine	string	Provides the name of the database engine to be used for this DB Instance.
$engineVersion	string	Indicates the database engine version.
$hostedZoneId	string	Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
$kmsKeyId	string	If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.
$latestRestorableTime	DateTime	Specifies the latest time to which a database can be restored with point-in-time restore
$masterUsername	string	Contains the master username for the DB Instance
$percentageProgress	string	Specifies the progress of the operation as a percentage.
$port	integer	Specifies the port that the database engine is listening on.
$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
$status	string	Specifies the current state of this database
$storageEncrypted	boolean	Specifies whether the DB cluster is encrypted.

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.
delete ( boolean $skipFinalSnapshot = null, string $finalDBSnapshotIdentifier = null ) : DBClusterData	DeleteDBCluster action
describeTags ( ) : Scalr\Service\Aws\Rds\DataType\TagsList	Lists all tags on an Amazon RDS resource.
getModifyRequest ( ) : ModifyDBClusterRequestData	Creates and returns new ModifyDBClusterRequestData object for this DBCluster
modify ( ModifyDBClusterRequestData $request ) : DBClusterData	ModifyDBCluster action
refresh ( ) : DBClusterData	DescribeDBClusters action
removeTags ( array \| ListDataType $tagsKeys ) : boolean	Removes metadata tags from an Amazon RDS resource.

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

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

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 ModifyDBClusterRequestData object for this DBCluster

public getModifyRequest ( ) : ModifyDBClusterRequestData
return	ModifyDBClusterRequestData	Returns new ModifyDBClusterRequestData object for this DBCluster

modify() public method

Modify settings for a DB Cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

public modify ( ModifyDBClusterRequestData $request ) : DBClusterData
$request	ModifyDBClusterRequestData	Modify DB Cluster request object
return	DBClusterData	Returns modified DBCluster

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 ( ) : DBClusterData
return	DBClusterData	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

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

$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

This is the unique key that identifies a DB Instance

public string $dBClusterIdentifier
return	string

$dBClusterParameterGroup public property

Specifies the name of the DB cluster parameter group for the DB cluster.

public string $dBClusterParameterGroup
return	string

$dBSubnetGroup public property

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.

public string $dBSubnetGroup
return	string

$databaseName public property

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.

public string $databaseName
return	string

$earliestRestorableTime public property

Specifies the earliest time to which a database can be restored with point-in-time restore.

public DateTime $earliestRestorableTime
return	DateTime

$endpoint public property

Specifies the connection endpoint for the primary instance of the DB cluster.

public string $endpoint
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

$hostedZoneId public property

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.

public string $hostedZoneId
return	string

$kmsKeyId public property

If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.

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

$masterUsername public property

Contains the master username for the DB Instance

public string $masterUsername
return	string

$percentageProgress public property

Specifies the progress of the operation as a percentage.

public string $percentageProgress
return	string

$port public property

Specifies the port that the database engine is listening on.

public int $port
return	integer

$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

$status public property

Specifies the current state of this database

public string $status
return	string

$storageEncrypted public property

Specifies whether the DB cluster is encrypted.

public bool $storageEncrypted
return	boolean