PHP Class Scalr\Service\Aws\Rds\V20130110\RdsApi

Implements Rds Low-Level API Actions.
Since: 07.03.2013
Author: Vitaliy Demidov ([email protected])
Inheritance: extends Scalr\Service\Aws\AbstractApi
Mostra file Open project: scalr/scalr

Protected Properties

Property Type Description
$rds Scalr\Service\Aws\Rds
$versiondate string

Public Methods

Method Description
__construct ( Scalr\Service\Aws\Rds $rds, Scalr\Service\Aws\Client\ClientInterface $client ) Constructor
_loadAvailabilityZoneData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\AvailabilityZoneData Loads AvailabilityZoneData from simple xml object
_loadDBEngineVersionData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBEngineVersionData Loads DBEngineVersionData from simple xml object
authorizeDBSecurityGroupIngress ( Scalr\Service\Aws\Rds\DataType\DBSecurityGroupIngressRequestData $request ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData AuthorizeDBSecurityGroupIngress action
createDBInstance ( Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData $request ) : DBInstanceData CreateDBInstance action
createDBParameterGroup ( Scalr\Service\Aws\Rds\DataType\DBParameterGroupData $request ) : Scalr\Service\Aws\Rds\DataType\DBParameterGroupData CreateDBParameterGroup action
createDBSecurityGroup ( string $name, string $description ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData CreateDBSecurityGroup
createDBSnapshot ( string $dBInstanceIdentifier, string $dBSnapshotIdentifier ) : DBSnapshotData CreateDBSnapshot
createDBSubnetGroup ( Scalr\Service\Aws\Rds\DataType\CreateDBSubnetGroupRequestData $request ) : Scalr\Service\Aws\Rds\DataType\DBSubnetGroupData Creates a new DB subnet group.
deleteDBInstance ( string $dBInstanceIdentifier, boolean $skipFinalSnapshot = null, string $finalDBSnapshotIdentifier = null ) : DBInstanceData DeleteDBInstance action
deleteDBParameterGroup ( string $dBParameterGroupName ) : boolean DeleteDBParameterGroup action
deleteDBSecurityGroup ( string $dBSecurityGroupName ) : boolean DeleteDBSecurityGroup action
deleteDBSnapshot ( string $dBSnapshotIdentifier ) : DBSnapshotData DeleteDBSnapshot action
deleteDBSubnetGroup ( string $dBSubnetGroupName ) : boolean DeleteDBSubnetGroup action Deletes a DB subnet group.
describeDBEngineVersions ( Scalr\Service\Aws\Rds\DataType\DescribeDBEngineVersionsData $request = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBEngineVersionList Returns a list of the available DB engines.
describeDBInstances ( string $dbInstanceIdentifier = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBInstanceList DescribeDBInstances action
describeDBParameterGroups ( string $dBParameterGroupName = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBParameterGroupList DescribeDBParameterGroups action
describeDBParameters ( string $dBParameterGroupName, string $source = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\ParameterList DescribeDBParameters action
describeDBSecurityGroups ( string $dBSecurityGroupName = null, string $marker = null, string $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupList DescribeDBSecurityGroups action
describeDBSnapshots ( $dBInstanceIdentifier = null, $dBSnapshotIdentifier = null, $snapshotType = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBSnapshotList DescribeDBSnapshots action
describeDBSubnetGroups ( string $dBSubnetGroupName = null, string $marker = null, string $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBSubnetGroupList Returns a list of DBSubnetGroup descriptions.
describeEvents ( DescribeEventRequestData $request = null ) : Scalr\Service\Aws\Rds\DataType\EventList DescribeEvents action
getEntityManager ( ) : Scalr\Service\Aws\EntityManager Gets an entity manager
modifyDBInstance ( Scalr\Service\Aws\Rds\DataType\ModifyDBInstanceRequestData $request ) : DBInstanceData ModifyDBInstance action
modifyDBParameterGroup ( string $dBParameterGroupName, Scalr\Service\Aws\Rds\DataType\ParameterList $parameters ) : string ModifyDBParameterGroup action
modifyDBSubnetGroup ( Scalr\Service\Aws\Rds\DataType\ModifyDBSubnetGroupRequestData $request ) : Scalr\Service\Aws\Rds\DataType\DBSubnetGroupData Modifies an existing DB subnet group.
rebootDBInstance ( string $dBInstanceIdentifier, boolean $forceFailover = null ) : DBInstanceData RebootDBInstance action
resetDBParameterGroup ( string $dBParameterGroupName, Scalr\Service\Aws\Rds\DataType\ParameterList $parameters = null, boolean $resetAllParameters = null ) : string ResetDBParameterGroup action
restoreDBInstanceFromDBSnapshot ( Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData $request ) : DBInstanceData RestoreDBInstanceFromDBSnapshot action
revokeDBSecurityGroupIngress ( Scalr\Service\Aws\Rds\DataType\DBSecurityGroupIngressRequestData $request ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData RevokeDBSecurityGroupIngress action

Protected Methods

Method Description
_loadDBInstanceData ( SimpleXMLElement $sxml ) : DBInstanceData Loads DBInstanceData from simple xml object
_loadDBParameterGroupData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBParameterGroupData Loads DBParameterGroupData from simple xml object
_loadDBParameterGroupStatusList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBParameterGroupStatusList Loads DBParameterGroupStatusList from simple xml object
_loadDBSecurityGroupData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData Loads DBSecurityGroupData from simple xml object
_loadDBSecurityGroupMembershipList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupMembershipList Loads DBSecurityGroupMembershipList from simple xml object
_loadDBSnapshotData ( SimpleXMLElement $sxml ) : DBSnapshotData Loads DBSnapshotData from simple xml object
_loadDBSubnetGroupData ( SimpleXMLElement $sxml ) : null | Scalr\Service\Aws\Rds\DataType\DBSubnetGroupData Loads DBSubnetGroupData from simple xml object
_loadEC2SecurityGroupList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\EC2SecurityGroupList Loads EC2SecurityGroupList from simple xml object
_loadEndpointData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\EndpointData Loads EndpointData from simple xml object
_loadEventData ( SimpleXMLElement $sxml ) : EventData Loads EventData from simple xml object
_loadIPRangeList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\IPRangeList Loads IPRangeList from simple xml object
_loadOptionGroupMembershipData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionGroupMembershipData Loads OptionGroupMembershipData from simple xml object
_loadParameterData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\ParameterData Loads ParameterData from simple xml object
_loadPendingModifiedValuesData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\PendingModifiedValuesData Loads PendingModifiedValuesData from simple xml object
_loadSubnetsList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\SubnetList Loads SubnetList from simple xml object
_loadVpcSecurityGroupMembershipList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\VpcSecurityGroupMembershipList Loads VpcSecurityGroupMembershipList from simple xml object

Method Details

__construct() public method

Constructor
public __construct ( Scalr\Service\Aws\Rds $rds, Scalr\Service\Aws\Client\ClientInterface $client )
$rds Scalr\Service\Aws\Rds Rds instance
$client Scalr\Service\Aws\Client\ClientInterface Client Interface

_loadAvailabilityZoneData() public method

Loads AvailabilityZoneData from simple xml object
public _loadAvailabilityZoneData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\AvailabilityZoneData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\AvailabilityZoneData

_loadDBEngineVersionData() public method

Loads DBEngineVersionData from simple xml object
public _loadDBEngineVersionData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBEngineVersionData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\DBEngineVersionData

_loadDBInstanceData() protected method

Loads DBInstanceData from simple xml object
protected _loadDBInstanceData ( SimpleXMLElement $sxml ) : DBInstanceData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\DBInstanceData Returns DBInstanceData

_loadDBParameterGroupData() protected method

Loads DBParameterGroupData from simple xml object
protected _loadDBParameterGroupData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBParameterGroupData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\DBParameterGroupData Returns DBParameterGroupData

_loadDBParameterGroupStatusList() protected method

Loads DBParameterGroupStatusList from simple xml object
protected _loadDBParameterGroupStatusList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBParameterGroupStatusList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\DBParameterGroupStatusList Returns DBParameterGroupStatusList

_loadDBSecurityGroupData() protected method

Loads DBSecurityGroupData from simple xml object
protected _loadDBSecurityGroupData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData Returns DBSecurityGroupData

_loadDBSecurityGroupMembershipList() protected method

Loads DBSecurityGroupMembershipList from simple xml object
protected _loadDBSecurityGroupMembershipList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupMembershipList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\DBSecurityGroupMembershipList Returns DBSecurityGroupMembershipList

_loadDBSnapshotData() protected method

Loads DBSnapshotData from simple xml object
protected _loadDBSnapshotData ( SimpleXMLElement $sxml ) : DBSnapshotData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\DBSnapshotData Returns DBSnapshotData

_loadDBSubnetGroupData() protected method

Loads DBSubnetGroupData from simple xml object
protected _loadDBSubnetGroupData ( SimpleXMLElement $sxml ) : null | Scalr\Service\Aws\Rds\DataType\DBSubnetGroupData
$sxml SimpleXMLElement
return null | Scalr\Service\Aws\Rds\DataType\DBSubnetGroupData

_loadEC2SecurityGroupList() protected method

Loads EC2SecurityGroupList from simple xml object
protected _loadEC2SecurityGroupList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\EC2SecurityGroupList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\EC2SecurityGroupList Returns EC2SecurityGroupList

_loadEndpointData() protected method

Loads EndpointData from simple xml object
protected _loadEndpointData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\EndpointData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\EndpointData Returns EndpointData

_loadEventData() protected method

Loads EventData from simple xml object
protected _loadEventData ( SimpleXMLElement $sxml ) : EventData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\EventData Returns EventData

_loadIPRangeList() protected method

Loads IPRangeList from simple xml object
protected _loadIPRangeList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\IPRangeList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\IPRangeList Returns IPRangeList

_loadOptionGroupMembershipData() protected method

Loads OptionGroupMembershipData from simple xml object
protected _loadOptionGroupMembershipData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionGroupMembershipData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\OptionGroupMembershipData Returns OptionGroupMembershipData

_loadParameterData() protected method

Loads ParameterData from simple xml object
protected _loadParameterData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\ParameterData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\ParameterData Returns ParameterData

_loadPendingModifiedValuesData() protected method

Loads PendingModifiedValuesData from simple xml object
protected _loadPendingModifiedValuesData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\PendingModifiedValuesData
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\PendingModifiedValuesData Returns PendingModifiedValuesData

_loadSubnetsList() protected method

Loads SubnetList from simple xml object
protected _loadSubnetsList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\SubnetList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\SubnetList Returns SubnetList

_loadVpcSecurityGroupMembershipList() protected method

Loads VpcSecurityGroupMembershipList from simple xml object
protected _loadVpcSecurityGroupMembershipList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\VpcSecurityGroupMembershipList
$sxml SimpleXMLElement
return Scalr\Service\Aws\Rds\DataType\VpcSecurityGroupMembershipList Returns VpcSecurityGroupMembershipList

authorizeDBSecurityGroupIngress() public method

Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC Security Groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). Note! You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS DB Instance in another.You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB Instance in another.
public authorizeDBSecurityGroupIngress ( Scalr\Service\Aws\Rds\DataType\DBSecurityGroupIngressRequestData $request ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData
$request Scalr\Service\Aws\Rds\DataType\DBSecurityGroupIngressRequestData
return Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData Returns DBSecurityGroupData on success or throws an exception.

createDBInstance() public method

Creates a new DB instance.
public createDBInstance ( Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData $request ) : DBInstanceData
$request Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData Created DB Instance request object
return Scalr\Service\Aws\Rds\DataType\DBInstanceData Returns created DBInstance

createDBParameterGroup() public method

Creates a new DB Parameter Group. A DB Parameter Group is initially created with the default parameters for the database engine used by the DB Instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB Parameter Group, you need to associate it with your DB Instance using ModifyDBInstance. When you associate a new DB Parameter Group with a running DB Instance, you need to reboot the DB Instance for the new DB Parameter Group and associated settings to take effect.
public createDBParameterGroup ( Scalr\Service\Aws\Rds\DataType\DBParameterGroupData $request ) : Scalr\Service\Aws\Rds\DataType\DBParameterGroupData
$request Scalr\Service\Aws\Rds\DataType\DBParameterGroupData DBParameterGroupData object to create
return Scalr\Service\Aws\Rds\DataType\DBParameterGroupData Returns DBParameterGroupData on success or throws an exception.

createDBSecurityGroup() public method

Creates a new DB Security Group. DB Security Groups control access to a DB Instance
public createDBSecurityGroup ( string $name, string $description ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData
$name string The name for the DB Security Group. This value is stored as a lowercase string
$description string The description for the DB Security Group
return Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData Returns DBSecurityGroupData on success or throws an exception.

createDBSnapshot() public method

Creates a DBSnapshot. The source DBInstance must be in "available" state.
public createDBSnapshot ( string $dBInstanceIdentifier, string $dBSnapshotIdentifier ) : DBSnapshotData
$dBInstanceIdentifier string The DB Instance Identifier
$dBSnapshotIdentifier string The identifier for the DB Snapshot.
return Scalr\Service\Aws\Rds\DataType\DBSnapshotData Returns DBSnapshotData on success or throws an exception.

createDBSubnetGroup() public method

DB subnet groups must contain at least one subnet in at least two AZs in the region.
public createDBSubnetGroup ( Scalr\Service\Aws\Rds\DataType\CreateDBSubnetGroupRequestData $request ) : Scalr\Service\Aws\Rds\DataType\DBSubnetGroupData
$request Scalr\Service\Aws\Rds\DataType\CreateDBSubnetGroupRequestData
return Scalr\Service\Aws\Rds\DataType\DBSubnetGroupData

deleteDBInstance() 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 deleteDBInstance ( string $dBInstanceIdentifier, boolean $skipFinalSnapshot = null, string $finalDBSnapshotIdentifier = null ) : DBInstanceData
$dBInstanceIdentifier string The DB Instance identifier for the DB Instance to be deleted.
$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 Scalr\Service\Aws\Rds\DataType\DBInstanceData Returns created DBInstance

deleteDBParameterGroup() public method

Deletes a specified DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted. Note! The specified DB Parameter Group cannot be associated with any DB Instances
public deleteDBParameterGroup ( string $dBParameterGroupName ) : boolean
$dBParameterGroupName string The name of the DB Parameter Group
return boolean Returns true on success or throws an exception.

deleteDBSecurityGroup() public method

Deletes a DB Security Group. Note! The specified DB Security Group must not be associated with any DB Instances.
public deleteDBSecurityGroup ( string $dBSecurityGroupName ) : boolean
$dBSecurityGroupName string The Name of the DB security group to delete.
return boolean Returns true on success or throws an exception.

deleteDBSnapshot() public method

Deletes a DBSnapshot. Note! The DBSnapshot must be in the available state to be deleted
public deleteDBSnapshot ( string $dBSnapshotIdentifier ) : DBSnapshotData
$dBSnapshotIdentifier string The Identifier for the DB Snapshot to delete.
return Scalr\Service\Aws\Rds\DataType\DBSnapshotData Returns DBSnapshotData on success or throws an exception.

deleteDBSubnetGroup() public method

DeleteDBSubnetGroup action Deletes a DB subnet group.
public deleteDBSubnetGroup ( string $dBSubnetGroupName ) : boolean
$dBSubnetGroupName string Subnet group name
return boolean Returns true on success or throws an exception.

describeDBEngineVersions() public method

Returns a list of the available DB engines.
public describeDBEngineVersions ( Scalr\Service\Aws\Rds\DataType\DescribeDBEngineVersionsData $request = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBEngineVersionList
$request Scalr\Service\Aws\Rds\DataType\DescribeDBEngineVersionsData
$marker string
$maxRecords integer
return Scalr\Service\Aws\Rds\DataType\DBEngineVersionList

describeDBInstances() public method

Returns information about provisioned RDS instances. This API supports pagination
public describeDBInstances ( string $dbInstanceIdentifier = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBInstanceList
$dbInstanceIdentifier string optional The user-specified instance identifier.
$marker string optional The response includes only records beyond the marker.
$maxRecords integer optional The maximum number of records to include in the response.
return Scalr\Service\Aws\Rds\DataType\DBInstanceList Returns the list of DB Instances

describeDBParameterGroups() public method

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DBParameterGroup.
public describeDBParameterGroups ( string $dBParameterGroupName = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBParameterGroupList
$dBParameterGroupName string optional The name of a specific DB Parameter Group to return details for.
$marker string optional An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
$maxRecords integer optional The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
return Scalr\Service\Aws\Rds\DataType\DBParameterGroupList Returns DBParameterGroupList on success or throws an exception.

describeDBParameters() public method

Returns the detailed parameter list for a particular DBParameterGroup.
public describeDBParameters ( string $dBParameterGroupName, string $source = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\ParameterList
$dBParameterGroupName string The name of the DB Parameter Group.
$source string optional The parameter types to return.
$marker string optional An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
$maxRecords integer optional The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
return Scalr\Service\Aws\Rds\DataType\ParameterList Returns ParameterList on success or throws an exception.

describeDBSecurityGroups() public method

Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DBSecurityGroup.
public describeDBSecurityGroups ( string $dBSecurityGroupName = null, string $marker = null, string $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupList
$dBSecurityGroupName string optional The name of the DB Security Group to return details for.
$marker string optional Pagination token, provided by a previous request.
$maxRecords string optional The maximum number of records to include in the response.
return Scalr\Service\Aws\Rds\DataType\DBSecurityGroupList Returns the list of the DBSecurityGroupData

describeDBSnapshots() public method

Returns the detailed parameter list for a particular DBParameterGroup.
public describeDBSnapshots ( $dBInstanceIdentifier = null, $dBSnapshotIdentifier = null, $snapshotType = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBSnapshotList
$marker string optional An optional pagination token provided by a previous DescribeDBParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
$maxRecords integer optional The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved.
return Scalr\Service\Aws\Rds\DataType\DBSnapshotList Returns DBSnapshotList on success or throws an exception.

describeDBSubnetGroups() public method

If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
public describeDBSubnetGroups ( string $dBSubnetGroupName = null, string $marker = null, string $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBSubnetGroupList
$dBSubnetGroupName string optional Subnet group name
$marker string optional Pagination token, provided by a previous request.
$maxRecords string optional The maximum number of records to include in the response.
return Scalr\Service\Aws\Rds\DataType\DBSubnetGroupList Returns the list of the DBSubnetGroupData

describeEvents() public method

Returns events related to DB instances, DB security groups, DB Snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB Iinstance, DB security group, DB Snapshot, or DB parameter group can be obtained by providing the source identifier as a parameter. By default, the past hour of events are returned.
public describeEvents ( DescribeEventRequestData $request = null ) : Scalr\Service\Aws\Rds\DataType\EventList
$request Scalr\Service\Aws\Rds\DataType\DescribeEventRequestData optional Request object.
return Scalr\Service\Aws\Rds\DataType\EventList Returns EventList on success or throws an exception.

getEntityManager() public method

Gets an entity manager
public getEntityManager ( ) : Scalr\Service\Aws\EntityManager
return Scalr\Service\Aws\EntityManager

modifyDBInstance() 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 modifyDBInstance ( Scalr\Service\Aws\Rds\DataType\ModifyDBInstanceRequestData $request ) : DBInstanceData
$request Scalr\Service\Aws\Rds\DataType\ModifyDBInstanceRequestData Modify DB Instance request object
return Scalr\Service\Aws\Rds\DataType\DBInstanceData Returns modified DBInstance

modifyDBParameterGroup() public method

Modifies the parameters of a DBParameterGroup. To modify more than one parameter submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. Note! The apply-immediate method can be used only for dynamic parameters; the pending-reboot method can be used with MySQL and Oracle DB Instances for either dynamic or static parameters. For Microsoft SQL Server DB Instances, the pending-reboot method can be used only for static parameters.
public modifyDBParameterGroup ( string $dBParameterGroupName, Scalr\Service\Aws\Rds\DataType\ParameterList $parameters ) : string
$dBParameterGroupName string The name of DB Parameter Group to modify.
$parameters Scalr\Service\Aws\Rds\DataType\ParameterList An list of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request. Valid Values (for the application method): immediate | pending-reboot
return string Returns DBParameterGroupName on success or throws an exception.

modifyDBSubnetGroup() public method

DB subnet groups must contain at least one subnet in at least two AZs in the region.
public modifyDBSubnetGroup ( Scalr\Service\Aws\Rds\DataType\ModifyDBSubnetGroupRequestData $request ) : Scalr\Service\Aws\Rds\DataType\DBSubnetGroupData
$request Scalr\Service\Aws\Rds\DataType\ModifyDBSubnetGroupRequestData
return Scalr\Service\Aws\Rds\DataType\DBSubnetGroupData

rebootDBInstance() 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 rebootDBInstance ( string $dBInstanceIdentifier, boolean $forceFailover = null ) : DBInstanceData
$dBInstanceIdentifier string The DB Instance identifier. This parameter is stored as a lowercase string
$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 Scalr\Service\Aws\Rds\DataType\DBInstanceData Returns DBInstance

resetDBParameterGroup() public method

Modifies the parameters of a DBParameterGroup to the engine/system default value. To reset specific parameters submit a list of the following: ParameterName and ApplyMethod. To reset the entire DBParameterGroup specify the DBParameterGroup name and ResetAllParameters parameters. When resetting the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance restart or RebootDBInstance request.
public resetDBParameterGroup ( string $dBParameterGroupName, Scalr\Service\Aws\Rds\DataType\ParameterList $parameters = null, boolean $resetAllParameters = null ) : string
$dBParameterGroupName string The name of DB Parameter Group to modify.
$parameters Scalr\Service\Aws\Rds\DataType\ParameterList optional An list of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters may be modified in a single request. Valid Values (for the application method): immediate | pending-reboot
$resetAllParameters boolean optional Specifies whether (true) or not (false) to reset all parameters in the DB Parameter Group to default values.
return string Returns DBParameterGroupName on success or throws an exception.

restoreDBInstanceFromDBSnapshot() 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 restoreDBInstanceFromDBSnapshot ( Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData $request ) : DBInstanceData
$request Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData The request object.
return Scalr\Service\Aws\Rds\DataType\DBInstanceData Returns DBInstanceData on success or throws an exception.

revokeDBSecurityGroupIngress() public method

Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups. Required parameters for this API are one of CIDRIP, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId).
public revokeDBSecurityGroupIngress ( Scalr\Service\Aws\Rds\DataType\DBSecurityGroupIngressRequestData $request ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData
$request Scalr\Service\Aws\Rds\DataType\DBSecurityGroupIngressRequestData
return Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData Returns DBSecurityGroupData on success or throws an exception.

Property Details

$rds protected_oe property

protected Rds,Scalr\Service\Aws $rds
return Scalr\Service\Aws\Rds

$versiondate protected_oe property

protected string $versiondate
return string