PHP Class Scalr_UI_Controller_Tools_Aws_Rds_Clusters

Author: Vlad Dobrovolskiy ([email protected])

Inheritance: extends Scalr_UI_Controller

Public Methods

Method	Description
createAction ( )	Create page
defaultAction ( )	Forwards the controller to the default action
editAction ( string $cloudLocation, string $dBClusterIdentifier = null, string $vpcId = null )	Edit page
hasAccess ( )
restoreAction ( string $snapshot, string $cloudLocation )
viewAction ( )	List page
xDeleteAction ( string $cloudLocation, JsonData $dBClusterIdentifiers )	xDeleteAction
xGetDbClustersStatusAction ( string $cloudLocation, JsonData $dbClusters = null )	Action for polling db clusters' statuses
xListAction ( string $cloudLocation, string $dBClusterIdentifier = null )	xListAction
xModifyAction ( string $DBClusterIdentifier, string $cloudLocation, JsonData $VpcSecurityGroupIds = null, string $PreferredMaintenanceWindow = null, Scalr\UI\Request\RawData $MasterUserPassword = null, string $BackupRetentionPeriod = null, string $PreferredBackupWindow = null, string $OptionGroupName = null, boolean $ApplyImmediately = false, boolean $ignoreGovernance = null )	Modifies selected cluster
xRestoreClusterAction ( string $cloudLocation, string $DBClusterIdentifier, string $DBSnapshotIdentifier, string $Engine, string $VpcId, integer $Port, string $DBInstanceClass, boolean $PublicAccessible, Scalr\UI\Request\RawData $MasterUserPassword, JsonData $SubnetIds = null, string $OptionGroupName = null, JsonData $AvailabilityZones = null, string $DBSubnetGroupName = null, boolean $AutoMinorVersionUpgrade = null )	xRestoreClusterAction
xSaveAction ( string $cloudLocation, string $DBClusterIdentifier, string $Engine, string $MasterUsername, Scalr\UI\Request\RawData $MasterUserPassword, string $VpcId = null, integer $Port = null, string $DBName = null, string $CharacterSetName = null, string $DBParameterGroup = null, string $OptionGroupName = null, JsonData $AvailabilityZones = null, integer $BackupRetentionPeriod = null, string $PreferredBackupWindow = null, string $PreferredMaintenanceWindow = null, string $DBSubnetGroupName = null, string $EngineVersion = null, integer $farmId = null, JsonData $VpcSecurityGroups = null, JsonData $SubnetIds = null, boolean $StorageEncrypted = null, string $KmsKeyId = null )	Creates new DB Cluster from request data

Protected Methods

Method	Description
getAwsClient ( string $cloudLocation ) : Aws	Gets AWS Client for the current environment

Method Details

createAction() public method

Create page

public createAction ( )

defaultAction() public method

Forwards the controller to the default action

public defaultAction ( )

editAction() public method

Edit page

public editAction ( string $cloudLocation, string $dBClusterIdentifier = null, string $vpcId = null )
$cloudLocation	string	AWS region
$dBClusterIdentifier	string	optional DB Cluster identifier
$vpcId	string	Vpc id

getAwsClient() protected method

Gets AWS Client for the current environment

protected getAwsClient ( string $cloudLocation ) : Aws
$cloudLocation	string	Cloud location
return	Scalr\Service\Aws	Returns Aws client for current environment

hasAccess() public method

See also: Scalr_UI_Controller::hasAccess()

public hasAccess ( )

restoreAction() public method

public restoreAction ( string $snapshot, string $cloudLocation )
$snapshot	string
$cloudLocation	string

viewAction() public method

List page

public viewAction ( )

xDeleteAction() public method

xDeleteAction

public xDeleteAction ( string $cloudLocation, JsonData $dBClusterIdentifiers )
$cloudLocation	string	Aws region
$dBClusterIdentifiers	Scalr\UI\Request\JsonData	List of cluster ids

xGetDbClustersStatusAction() public method

Action for polling db clusters' statuses

public xGetDbClustersStatusAction ( string $cloudLocation, JsonData $dbClusters = null )
$cloudLocation	string	Aws region
$dbClusters	Scalr\UI\Request\JsonData	Db clusters to update

xListAction() public method

xListAction

public xListAction ( string $cloudLocation, string $dBClusterIdentifier = null )
$cloudLocation	string	Aws region
$dBClusterIdentifier	string	optional DB Cluster identifier

xModifyAction() public method

Modifies selected cluster

public xModifyAction ( string $DBClusterIdentifier, string $cloudLocation, JsonData $VpcSecurityGroupIds = null, string $PreferredMaintenanceWindow = null, Scalr\UI\Request\RawData $MasterUserPassword = null, string $BackupRetentionPeriod = null, string $PreferredBackupWindow = null, string $OptionGroupName = null, boolean $ApplyImmediately = false, boolean $ignoreGovernance = null )
$DBClusterIdentifier	string	DBClusterIdentifier field
$cloudLocation	string	Ec2 region
$VpcSecurityGroupIds	Scalr\UI\Request\JsonData	optional VPC Security groups list
$PreferredMaintenanceWindow	string	optional Preferred Maintenance Window
$MasterUserPassword	Scalr\UI\Request\RawData	optional User password
$BackupRetentionPeriod	string	optional Backup Retention Period
$PreferredBackupWindow	string	optional Preferred Backup Window
$OptionGroupName	string	optional Option group name
$ApplyImmediately	boolean	optional ApplyImmediately flag
$ignoreGovernance	boolean	optional Ignore governance if true

xRestoreClusterAction() public method

xRestoreClusterAction

public xRestoreClusterAction ( string $cloudLocation, string $DBClusterIdentifier, string $DBSnapshotIdentifier, string $Engine, string $VpcId, integer $Port, string $DBInstanceClass, boolean $PublicAccessible, Scalr\UI\Request\RawData $MasterUserPassword, JsonData $SubnetIds = null, string $OptionGroupName = null, JsonData $AvailabilityZones = null, string $DBSubnetGroupName = null, boolean $AutoMinorVersionUpgrade = null )
$cloudLocation	string	Ec2 region
$DBClusterIdentifier	string	DBClusterIdentifier field
$DBSnapshotIdentifier	string	DBSnapshotIdentifier field
$Engine	string	Aurora engine
$VpcId	string	Vpc id
$Port	integer	Port value
$DBInstanceClass	string	Db instance class
$PublicAccessible	boolean	True if instance is public accessible
$MasterUserPassword	Scalr\UI\Request\RawData	DB Password
$SubnetIds	Scalr\UI\Request\JsonData	optional List of subnet ids
$OptionGroupName	string	optional Option group name
$AvailabilityZones	Scalr\UI\Request\JsonData	optional List of availability zones
$DBSubnetGroupName	string	optional Subnet group name
$AutoMinorVersionUpgrade	boolean	optional Auto minor version upgrade

xSaveAction() public method

Creates new DB Cluster from request data

public xSaveAction ( string $cloudLocation, string $DBClusterIdentifier, string $Engine, string $MasterUsername, Scalr\UI\Request\RawData $MasterUserPassword, string $VpcId = null, integer $Port = null, string $DBName = null, string $CharacterSetName = null, string $DBParameterGroup = null, string $OptionGroupName = null, JsonData $AvailabilityZones = null, integer $BackupRetentionPeriod = null, string $PreferredBackupWindow = null, string $PreferredMaintenanceWindow = null, string $DBSubnetGroupName = null, string $EngineVersion = null, integer $farmId = null, JsonData $VpcSecurityGroups = null, JsonData $SubnetIds = null, boolean $StorageEncrypted = null, string $KmsKeyId = null )
$cloudLocation	string	Instance cloud location
$DBClusterIdentifier	string	DBClusterIdentifier field
$Engine	string	Database Db engine
$MasterUsername	string	User name
$MasterUserPassword	Scalr\UI\Request\RawData	User password
$VpcId	string	optional Ec2 vpc id
$Port	integer	optional DB Port
$DBName	string	optional DB name
$CharacterSetName	string	optional Character set name
$DBParameterGroup	string	optional Parameter group name
$OptionGroupName	string	optional Option group name
$AvailabilityZones	Scalr\UI\Request\JsonData	optional Aws availability zone list
$BackupRetentionPeriod	integer	optional Backup Retention Period
$PreferredBackupWindow	string	optional Preferred Backup Window
$PreferredMaintenanceWindow	string	optional Preferred Maintenance Window
$DBSubnetGroupName	string	optional Subnet group name
$EngineVersion	string	optional Engine's version
$farmId	integer	optional Farm identifier
$VpcSecurityGroups	Scalr\UI\Request\JsonData	optional VPC Security groups list
$SubnetIds	Scalr\UI\Request\JsonData	optional Subnets list
$StorageEncrypted	boolean	optional Storage encryption
$KmsKeyId	string	optional Kms key id