PHP 클래스 Scalr\Service\Aws\Rds\DataType\DBClusterData

저자: N.V.
상속: extends Scalr\Service\Aws\Rds\AbstractRdsDataType
파일 보기 프로젝트 열기: scalr/scalr 1 사용 예제들

공개 프로퍼티들

프로퍼티 타입 설명
$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.

보호된 프로퍼티들

프로퍼티 타입 설명
$_properties array List of the public properties which is managed by magic getter and setters internally.

공개 메소드들

메소드 설명
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.

보호된 메소드들

메소드 설명
throwExceptionIfNotInitialized ( )

메소드 상세

addTags() 공개 메소드

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
리턴 array Returns array of added tags

delete() 공개 메소드

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
리턴 DBClusterData Returns created DBCluster

describeTags() 공개 메소드

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

getModifyRequest() 공개 메소드

Creates and returns new ModifyDBClusterRequestData object for this DBCluster
public getModifyRequest ( ) : ModifyDBClusterRequestData
리턴 ModifyDBClusterRequestData Returns new ModifyDBClusterRequestData object for this DBCluster

modify() 공개 메소드

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
리턴 DBClusterData Returns modified DBCluster

refresh() 공개 메소드

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
리턴 DBClusterData Return refreshed object

removeTags() 공개 메소드

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
리턴 boolean

throwExceptionIfNotInitialized() 보호된 메소드

프로퍼티 상세

$_properties 보호되어 있는 프로퍼티

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

$allocatedStorage 공개적으로 프로퍼티

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

$backupRetentionPeriod 공개적으로 프로퍼티

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

$characterSetName 공개적으로 프로퍼티

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

$dBClusterIdentifier 공개적으로 프로퍼티

This is the unique key that identifies a DB Instance
public string $dBClusterIdentifier
리턴 string

$dBClusterParameterGroup 공개적으로 프로퍼티

Specifies the name of the DB cluster parameter group for the DB cluster.
public string $dBClusterParameterGroup
리턴 string

$dBSubnetGroup 공개적으로 프로퍼티

Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group.
public string $dBSubnetGroup
리턴 string

$databaseName 공개적으로 프로퍼티

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
리턴 string

$earliestRestorableTime 공개적으로 프로퍼티

Specifies the earliest time to which a database can be restored with point-in-time restore.
public DateTime $earliestRestorableTime
리턴 DateTime

$endpoint 공개적으로 프로퍼티

Specifies the connection endpoint for the primary instance of the DB cluster.
public string $endpoint
리턴 string

$engine 공개적으로 프로퍼티

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

$engineVersion 공개적으로 프로퍼티

Indicates the database engine version.
public string $engineVersion
리턴 string

$hostedZoneId 공개적으로 프로퍼티

Specifies the ID that Amazon Route 53 assigns when you create a hosted zone.
public string $hostedZoneId
리턴 string

$kmsKeyId 공개적으로 프로퍼티

If StorageEncrypted is true, the KMS key identifier for the encrypted DB cluster.
public string $kmsKeyId
리턴 string

$latestRestorableTime 공개적으로 프로퍼티

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

$masterUsername 공개적으로 프로퍼티

Contains the master username for the DB Instance
public string $masterUsername
리턴 string

$percentageProgress 공개적으로 프로퍼티

Specifies the progress of the operation as a percentage.
public string $percentageProgress
리턴 string

$port 공개적으로 프로퍼티

Specifies the port that the database engine is listening on.
public int $port
리턴 integer

$preferredBackupWindow 공개적으로 프로퍼티

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

$preferredMaintenanceWindow 공개적으로 프로퍼티

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

$status 공개적으로 프로퍼티

Specifies the current state of this database
public string $status
리턴 string

$storageEncrypted 공개적으로 프로퍼티

Specifies whether the DB cluster is encrypted.
public bool $storageEncrypted
리턴 boolean