Property | Type | Description | |
---|---|---|---|
$rds | Scalr\Service\Aws\Rds | ||
$versiondate | string |
Method | Description | |
---|---|---|
__construct ( Scalr\Service\Aws\Rds $rds, Scalr\Service\Aws\Client\ClientInterface $client ) | Constructor | |
_loadTagData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\TagsData | Loads TagsData from simple xml object | |
addTagsToResource ( string $resourceName, string $resourceType, Scalr\Service\Aws\Rds\DataType\TagsList $tagsList ) : array | Adds metadata tags to an Amazon RDS resource. | |
authorizeDBSecurityGroupIngress ( Scalr\Service\Aws\Rds\DataType\DBSecurityGroupIngressRequestData $request ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData | AuthorizeDBSecurityGroupIngress action | |
copyDBClusterSnapshot ( string $sourceDbClusterSnapshotIdentifier, string $targetDbClusterSnapshotIdentifier, Scalr\Service\Aws\Rds\DataType\TagsList $tags = null ) : Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotData | CopyDBClusterSnapshot action | |
createDBCluster ( |
CreateDBCluster action | |
createDBClusterSnapshot ( string $dbClusterIdentifier, string $dbClusterSnapshotIdentifier, Scalr\Service\Aws\Rds\DataType\TagsList $tags = null ) : Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotData | CreateDBClusterSnapshot action | |
createDBInstance ( Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData $request ) : |
CreateDBInstance action | |
createDBInstanceReadReplica ( Scalr\Service\Aws\Rds\DataType\CreateDBInstanceReadReplicaData $request ) : |
Creates a DB instance that acts as a Read Replica of a source DB instance. | |
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 ) : |
CreateDBSnapshot | |
createDBSubnetGroup ( Scalr\Service\Aws\Rds\DataType\CreateDBSubnetGroupRequestData $request ) : Scalr\Service\Aws\Rds\DataType\DBSubnetGroupData | Creates a new DB subnet group. | |
deleteDBCluster ( string $dBClusterIdentifier, boolean $skipFinalSnapshot = true, string $finalDBSnapshotIdentifier = null ) : |
DeleteDBCluster action | |
deleteDBClusterSnapshot ( string $dbClusterSnapshotIdentifier ) : Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotData | DeleteDBClusterSnapshot action | |
deleteDBInstance ( string $dBInstanceIdentifier, boolean $skipFinalSnapshot = null, string $finalDBSnapshotIdentifier = null ) : |
DeleteDBInstance action | |
deleteDBParameterGroup ( string $dBParameterGroupName ) : boolean | DeleteDBParameterGroup action | |
deleteDBSecurityGroup ( string $dBSecurityGroupName ) : boolean | DeleteDBSecurityGroup action | |
deleteDBSnapshot ( string $dBSnapshotIdentifier ) : |
DeleteDBSnapshot action | |
deleteDBSubnetGroup ( string $dBSubnetGroupName ) : boolean | DeleteDBSubnetGroup action Deletes a DB subnet group. | |
describeDBClusterSnapshots ( string $dbClusterIdentifier = null, string $dbClusterSnapshotIdentifier = null, string $snapshotType = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotList | DescribeDBClusterSnapshots action | |
describeDBClusters ( string $dbClusterIdentifier = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBClusterList | DescribeDBClusters action | |
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 ( |
DescribeEvents action | |
describeOptionGroups ( string $engineName = null, string $majorEngineVersion = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\OptionGroupsList | Describes the available option groups. | |
describeOrderableDBInstanceOptions ( Scalr\Service\Aws\Rds\DataType\DescribeOrderableDBInstanceOptionsData $request, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\OrderableDBInstanceOptionsList | Describe DBInstance Types action | |
getEntityManager ( ) : Scalr\Service\Aws\EntityManager | Gets an entity manager | |
listTagsForResource ( string $resourceName, string $resourceType ) : Scalr\Service\Aws\Rds\DataType\TagsList | Lists all tags on an Amazon RDS resource. | |
modifyDBCluster ( Scalr\Service\Aws\Rds\DataType\ModifyDBClusterRequestData $request ) : |
ModifyDBCluster action | |
modifyDBInstance ( Scalr\Service\Aws\Rds\DataType\ModifyDBInstanceRequestData $request ) : |
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. | |
promoteReadReplica ( string $dBInstanceIdentifier, integer $backupRetentionPeriod = null, string $preferredBackupWindow = null ) : |
Promotes a Read Replica DB instance to a standalone DB instance. | |
rebootDBInstance ( string $dBInstanceIdentifier, boolean $forceFailover = null ) : |
RebootDBInstance action | |
removeTagsFromResource ( string $resourceName, string $resourceType, |
Removes metadata tags from an Amazon RDS resource. | |
resetDBParameterGroup ( string $dBParameterGroupName, Scalr\Service\Aws\Rds\DataType\ParameterList $parameters = null, boolean $resetAllParameters = null ) : string | ResetDBParameterGroup action | |
restoreDBClusterFromSnapshot ( Scalr\Service\Aws\Rds\DataType\RestoreDBClusterFromSnapshotRequestData $request ) : |
RestoreDBClusterFromSnapshot action | |
restoreDBInstanceFromDBSnapshot ( Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData $request ) : |
RestoreDBInstanceFromDBSnapshot action | |
revokeDBSecurityGroupIngress ( Scalr\Service\Aws\Rds\DataType\DBSecurityGroupIngressRequestData $request ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData | RevokeDBSecurityGroupIngress action |
Method | Description | |
---|---|---|
_loadAvailabilityZoneData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\AvailabilityZoneData | Loads AvailabilityZoneData from simple xml object | |
_loadAvailabilityZoneList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\AvailabilityZoneList | Loads AvailabilityZoneList from simple xml object | |
_loadAvailabilityZonesList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\AvailabilityZoneList | Loads AvailabilityZoneList from simple xml object | |
_loadDBClusterData ( SimpleXMLElement $sxml ) : |
Loads DBClusterData from simple xml object | |
_loadDBClusterMembers ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\ClusterMembersList | Loads DBClusterMembers from simple xml object | |
_loadDBClusterSnapshotData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotData | Loads DBClusterSnapshotData from simple xml object | |
_loadDBEngineVersionData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBEngineVersionData | Loads DBEngineVersionData from simple xml object | |
_loadDBInstanceData ( SimpleXMLElement $sxml ) : |
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 ) : |
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 ) : |
Loads EventData from simple xml object | |
_loadIPRangeList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\IPRangeList | Loads IPRangeList from simple xml object | |
_loadOptionData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionData | Loads OptionData from simple xml object | |
_loadOptionGroupData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionGroupData | Loads OptionGroupData from simple xml object | |
_loadOptionGroupMembershipData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionGroupMembershipData | Loads OptionGroupMembershipData from simple xml object | |
_loadOptionGroupMembershipList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionGroupMembershipList | Loads OptionGroupMembershipList from simple xml object | |
_loadOptionList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionList | Loads OptionList from simple xml object | |
_loadOptionSettingList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionSettingList | Loads OptionSettingList from simple xml object | |
_loadOrderableDBInstanceOptionData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Rds\DataType\OrderableDBInstanceOptionsData | Loads OrderableDBInstanceOptionsData 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 |
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 |
protected _loadAvailabilityZoneData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\AvailabilityZoneData | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\AvailabilityZoneData |
protected _loadAvailabilityZoneList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\AvailabilityZoneList | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\AvailabilityZoneList |
protected _loadAvailabilityZonesList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\AvailabilityZoneList | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\AvailabilityZoneList |
protected _loadDBClusterData ( SimpleXMLElement $sxml ) : |
||
$sxml | SimpleXMLElement | |
return | Returns DBClusterData |
protected _loadDBClusterMembers ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\ClusterMembersList | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\ClusterMembersList | Returns ClusterMembersList |
protected _loadDBClusterSnapshotData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotData | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotData | Returns DBClusterSnapshotData object |
protected _loadDBEngineVersionData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBEngineVersionData | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\DBEngineVersionData |
protected _loadDBInstanceData ( SimpleXMLElement $sxml ) : |
||
$sxml | SimpleXMLElement | |
return | Returns DBInstanceData |
protected _loadDBParameterGroupData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBParameterGroupData | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\DBParameterGroupData | Returns DBParameterGroupData |
protected _loadDBParameterGroupStatusList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBParameterGroupStatusList | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\DBParameterGroupStatusList | Returns DBParameterGroupStatusList |
protected _loadDBSecurityGroupData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\DBSecurityGroupData | Returns DBSecurityGroupData |
protected _loadDBSecurityGroupMembershipList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\DBSecurityGroupMembershipList | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\DBSecurityGroupMembershipList | Returns DBSecurityGroupMembershipList |
protected _loadDBSnapshotData ( SimpleXMLElement $sxml ) : |
||
$sxml | SimpleXMLElement | |
return | Returns DBSnapshotData |
protected _loadDBSubnetGroupData ( SimpleXMLElement $sxml ) : null | Scalr\Service\Aws\Rds\DataType\DBSubnetGroupData | ||
$sxml | SimpleXMLElement | |
return | null | Scalr\Service\Aws\Rds\DataType\DBSubnetGroupData |
protected _loadEC2SecurityGroupList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\EC2SecurityGroupList | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\EC2SecurityGroupList | Returns EC2SecurityGroupList |
protected _loadEndpointData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\EndpointData | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\EndpointData | Returns EndpointData |
protected _loadEventData ( SimpleXMLElement $sxml ) : |
||
$sxml | SimpleXMLElement | |
return | Returns EventData |
protected _loadIPRangeList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\IPRangeList | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\IPRangeList | Returns IPRangeList |
protected _loadOptionData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionData | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\OptionData |
protected _loadOptionGroupData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionGroupData | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\OptionGroupData |
protected _loadOptionGroupMembershipData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionGroupMembershipData | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\OptionGroupMembershipData | Returns OptionGroupMembershipData |
protected _loadOptionGroupMembershipList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionGroupMembershipList | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\OptionGroupMembershipList |
protected _loadOptionList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionList | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\OptionList |
protected _loadOptionSettingList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\OptionSettingList | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\OptionSettingList |
protected _loadOrderableDBInstanceOptionData ( SimpleXMLElement $v ) : Scalr\Service\Aws\Rds\DataType\OrderableDBInstanceOptionsData | ||
$v | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\OrderableDBInstanceOptionsData |
protected _loadParameterData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\ParameterData | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\ParameterData | Returns ParameterData |
protected _loadPendingModifiedValuesData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\PendingModifiedValuesData | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\PendingModifiedValuesData | Returns PendingModifiedValuesData |
protected _loadSubnetsList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\SubnetList | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\SubnetList | Returns SubnetList |
public _loadTagData ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\TagsData | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\TagsData |
protected _loadVpcSecurityGroupMembershipList ( SimpleXMLElement $sxml ) : Scalr\Service\Aws\Rds\DataType\VpcSecurityGroupMembershipList | ||
$sxml | SimpleXMLElement | |
return | Scalr\Service\Aws\Rds\DataType\VpcSecurityGroupMembershipList | Returns VpcSecurityGroupMembershipList |
public addTagsToResource ( string $resourceName, string $resourceType, Scalr\Service\Aws\Rds\DataType\TagsList $tagsList ) : array | ||
$resourceName | string | Resource identifier for the Amazon RDS resource. |
$resourceType | string | The type of Amazon RDS resource (db|es|og|pg|ri|secgrp|snapshot|subgrp) |
$tagsList | Scalr\Service\Aws\Rds\DataType\TagsList | List of tags to add |
return | array | Returns array of added tags |
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. |
public copyDBClusterSnapshot ( string $sourceDbClusterSnapshotIdentifier, string $targetDbClusterSnapshotIdentifier, Scalr\Service\Aws\Rds\DataType\TagsList $tags = null ) : Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotData | ||
$sourceDbClusterSnapshotIdentifier | string | The identifier of the DB cluster snapshot to copy. This parameter is not case-sensitive. |
$targetDbClusterSnapshotIdentifier | string | The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter is not case-sensitive. |
$tags | Scalr\Service\Aws\Rds\DataType\TagsList | optional A list of tags. |
return | Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotData | Returns created DB cluster snapshot |
public createDBCluster ( |
||
$request | Created DB Instance request object | |
return | Returns created DBInstance |
public createDBClusterSnapshot ( string $dbClusterIdentifier, string $dbClusterSnapshotIdentifier, Scalr\Service\Aws\Rds\DataType\TagsList $tags = null ) : Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotData | ||
$dbClusterIdentifier | string | The identifier of the DB cluster to create a snapshot for. This parameter is not case-sensitive. |
$dbClusterSnapshotIdentifier | string | The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string. |
$tags | Scalr\Service\Aws\Rds\DataType\TagsList | optional The tags to be assigned to the DB cluster snapshot. |
return | Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotData | Returns created DB cluster snapshot |
public createDBInstance ( Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData $request ) : |
||
$request | Scalr\Service\Aws\Rds\DataType\CreateDBInstanceRequestData | Created DB Instance request object |
return | Returns created DBInstance |
public createDBInstanceReadReplica ( Scalr\Service\Aws\Rds\DataType\CreateDBInstanceReadReplicaData $request ) : |
||
$request | Scalr\Service\Aws\Rds\DataType\CreateDBInstanceReadReplicaData | |
return |
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. |
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. |
public createDBSnapshot ( string $dBInstanceIdentifier, string $dBSnapshotIdentifier ) : |
||
$dBInstanceIdentifier | string | The DB Instance Identifier |
$dBSnapshotIdentifier | string | The identifier for the DB Snapshot. |
return | Returns DBSnapshotData on success or throws an exception. |
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 |
public deleteDBCluster ( string $dBClusterIdentifier, boolean $skipFinalSnapshot = true, string $finalDBSnapshotIdentifier = null ) : |
||
$dBClusterIdentifier | string | The DB Cluster identifier for the DB Instance to be deleted. |
$skipFinalSnapshot | boolean | optional Determines whether a final DB Snapshot is created before the DB Cluster is deleted |
$finalDBSnapshotIdentifier | string | optional The DBSnapshotIdentifier of the new DBSnapshot created when SkipFinalSnapshot is set to false |
return | Returns deleted DBCluster |
public deleteDBClusterSnapshot ( string $dbClusterSnapshotIdentifier ) : Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotData | ||
$dbClusterSnapshotIdentifier | string | The identifier of the DB cluster snapshot to delete. |
return | Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotData | Returns deleted DB Cluster Snapshot |
public deleteDBInstance ( string $dBInstanceIdentifier, boolean $skipFinalSnapshot = null, string $finalDBSnapshotIdentifier = null ) : |
||
$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 | Returns created DBInstance |
public deleteDBParameterGroup ( string $dBParameterGroupName ) : boolean | ||
$dBParameterGroupName | string | The name of the DB Parameter Group |
return | boolean | Returns true on success or throws an exception. |
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. |
public deleteDBSnapshot ( string $dBSnapshotIdentifier ) : |
||
$dBSnapshotIdentifier | string | The Identifier for the DB Snapshot to delete. |
return | Returns DBSnapshotData on success or throws an exception. |
public deleteDBSubnetGroup ( string $dBSubnetGroupName ) : boolean | ||
$dBSubnetGroupName | string | Subnet group name |
return | boolean | Returns true on success or throws an exception. |
public describeDBClusterSnapshots ( string $dbClusterIdentifier = null, string $dbClusterSnapshotIdentifier = null, string $snapshotType = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBClusterSnapshotList | ||
$dbClusterIdentifier | string | optional A DB cluster identifier to retrieve the list of DB cluster snapshots for. This parameter cannot be used in conjunction with the DBClusterSnapshotIdentifier parameter. This parameter is not case-sensitive. |
$dbClusterSnapshotIdentifier | string | optional A specific DB cluster snapshot identifier to describe. This parameter cannot be used in conjunction with the DBClusterIdentifier parameter. This value is stored as a lowercase string. |
$snapshotType | string | optional The type of DB cluster snapshots that will be returned. Values can be automated or manual. If this parameter is not specified, the returned results will include all snapshot types. |
$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\DBClusterSnapshotList | Returns the list of DB Cluster Snapshots |
public describeDBClusters ( string $dbClusterIdentifier = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\DBClusterList | ||
$dbClusterIdentifier | string | optional The user-specified cluster 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\DBClusterList | Returns the list of DB Clusters |
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 |
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 |
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. |
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. |
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 |
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. |
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 |
public describeEvents ( |
||
$request | optional Request object. | |
return | Scalr\Service\Aws\Rds\DataType\EventList | Returns EventList on success or throws an exception. |
public describeOptionGroups ( string $engineName = null, string $majorEngineVersion = null, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\OptionGroupsList | ||
$engineName | string | |
$majorEngineVersion | string | |
$marker | string | |
$maxRecords | integer | |
return | Scalr\Service\Aws\Rds\DataType\OptionGroupsList |
public describeOrderableDBInstanceOptions ( Scalr\Service\Aws\Rds\DataType\DescribeOrderableDBInstanceOptionsData $request, string $marker = null, integer $maxRecords = null ) : Scalr\Service\Aws\Rds\DataType\OrderableDBInstanceOptionsList | ||
$request | Scalr\Service\Aws\Rds\DataType\DescribeOrderableDBInstanceOptionsData | Describe DB Instance Types request object. |
$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\OrderableDBInstanceOptionsList | Returns the list of DB Instance types |
public getEntityManager ( ) : Scalr\Service\Aws\EntityManager | ||
return | Scalr\Service\Aws\EntityManager |
public listTagsForResource ( string $resourceName, string $resourceType ) : Scalr\Service\Aws\Rds\DataType\TagsList | ||
$resourceName | string | Resource identifier for the Amazon RDS resource. |
$resourceType | string | The type of Amazon RDS resource (db|es|og|pg|ri|secgrp|snapshot|subgrp) |
return | Scalr\Service\Aws\Rds\DataType\TagsList |
public modifyDBCluster ( Scalr\Service\Aws\Rds\DataType\ModifyDBClusterRequestData $request ) : |
||
$request | Scalr\Service\Aws\Rds\DataType\ModifyDBClusterRequestData | Modify DB Cluster request object |
return | Returns modified DBCluster |
public modifyDBInstance ( Scalr\Service\Aws\Rds\DataType\ModifyDBInstanceRequestData $request ) : |
||
$request | Scalr\Service\Aws\Rds\DataType\ModifyDBInstanceRequestData | Modify DB Instance request object |
return | Returns modified DBInstance |
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. |
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 |
public rebootDBInstance ( string $dBInstanceIdentifier, boolean $forceFailover = null ) : |
||
$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 | Returns DBInstance |
public removeTagsFromResource ( string $resourceName, string $resourceType, |
||
$resourceName | string | Resource identifier for the Amazon RDS resource. |
$resourceType | string | The type of Amazon RDS resource (db|es|og|pg|ri|secgrp|snapshot|subgrp) |
$tagKeyList | Array of tag keys to remove | |
return | boolean |
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. |
public restoreDBClusterFromSnapshot ( Scalr\Service\Aws\Rds\DataType\RestoreDBClusterFromSnapshotRequestData $request ) : |
||
$request | Scalr\Service\Aws\Rds\DataType\RestoreDBClusterFromSnapshotRequestData | The request object. |
return | Returns DBClusterData on success or throws an exception. |
public restoreDBInstanceFromDBSnapshot ( Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData $request ) : |
||
$request | Scalr\Service\Aws\Rds\DataType\RestoreDBInstanceFromDBSnapshotRequestData | The request object. |
return | Returns DBInstanceData on success or throws an exception. |
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. |