Amazon Relational Database Service (Amazon RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks, freeing up developers to focus on what makes their applications and businesses unique.
Amazon RDS gives you access to the capabilities of a familiar MySQL or Oracle database server. This means the code, applications, and tools you already use today with your existing MySQL or Oracle databases work with Amazon RDS without modification. Amazon RDS automatically backs up your database and maintains the database software that powers your DB Instance. Amazon RDS is flexible: you can scale your database instance's compute resources and storage capacity to meet your application's demand. As with all Amazon Web Services, there are no up-front investments, and you pay only for the resources you use.
This is the Amazon RDS API Reference . It contains a comprehensive description of all Amazon RDS Query APIs and data types. To get started with Amazon RDS, go to the Amazon RDS Getting Started Guide. For more information on Amazon RDS concepts and usage scenarios, go to the Amazon RDS User Guide.
Assembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)
Syntax
| C# | Visual Basic | Visual C++ |
public interface AmazonRDS : IDisposable
Public Interface AmazonRDS _ Inherits IDisposable
public interface class AmazonRDS : IDisposable
Members
| All Members | Methods  |
 Public Protected | Instance Static  | Declared Inherited | XNA Framework Only  .NET Compact Framework Only  |
| Member | Description | |
|---|---|---|
| AuthorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest) | 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. For an overview of CIDR ranges, go to the Wikipedia Tutorial. |
| BeginAuthorizeDBSecurityGroupIngress(AuthorizeDBSecurityGroupIngressRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the AuthorizeDBSecurityGroupIngress operation.
|
| BeginCopyDBSnapshot(CopyDBSnapshotRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CopyDBSnapshot operation.
|
| BeginCreateDBInstance(CreateDBInstanceRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateDBInstance operation.
|
| BeginCreateDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateDBInstanceReadReplica operation.
|
| BeginCreateDBParameterGroup(CreateDBParameterGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateDBParameterGroup operation.
|
| BeginCreateDBSecurityGroup(CreateDBSecurityGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateDBSecurityGroup operation.
|
| BeginCreateDBSnapshot(CreateDBSnapshotRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateDBSnapshot operation.
|
| BeginCreateDBSubnetGroup(CreateDBSubnetGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateDBSubnetGroup operation.
|
| BeginDeleteDBInstance(DeleteDBInstanceRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteDBInstance operation.
|
| BeginDeleteDBParameterGroup(DeleteDBParameterGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteDBParameterGroup operation.
|
| BeginDeleteDBSecurityGroup(DeleteDBSecurityGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteDBSecurityGroup operation.
|
| BeginDeleteDBSnapshot(DeleteDBSnapshotRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteDBSnapshot operation.
|
| BeginDeleteDBSubnetGroup(DeleteDBSubnetGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteDBSubnetGroup operation.
|
| BeginDescribeDBEngineVersions(DescribeDBEngineVersionsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeDBEngineVersions operation.
|
| BeginDescribeDBInstances(DescribeDBInstancesRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeDBInstances operation.
|
| BeginDescribeDBParameterGroups(DescribeDBParameterGroupsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeDBParameterGroups operation.
|
| BeginDescribeDBParameters(DescribeDBParametersRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeDBParameters operation.
|
| BeginDescribeDBSecurityGroups(DescribeDBSecurityGroupsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeDBSecurityGroups operation.
|
| BeginDescribeDBSnapshots(DescribeDBSnapshotsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeDBSnapshots operation.
|
| BeginDescribeDBSubnetGroups(DescribeDBSubnetGroupsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeDBSubnetGroups operation.
|
| BeginDescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeEngineDefaultParameters operation.
|
| BeginDescribeEvents(DescribeEventsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeEvents operation.
|
| BeginDescribeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeOrderableDBInstanceOptions operation.
|
| BeginDescribeReservedDBInstances(DescribeReservedDBInstancesRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeReservedDBInstances operation.
|
| BeginDescribeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeReservedDBInstancesOfferings operation.
|
| BeginModifyDBInstance(ModifyDBInstanceRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the ModifyDBInstance operation.
|
| BeginModifyDBParameterGroup(ModifyDBParameterGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the ModifyDBParameterGroup operation.
|
| BeginModifyDBSubnetGroup(ModifyDBSubnetGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the ModifyDBSubnetGroup operation.
|
| BeginPurchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the PurchaseReservedDBInstancesOffering operation.
|
| BeginRebootDBInstance(RebootDBInstanceRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the RebootDBInstance operation.
|
| BeginResetDBParameterGroup(ResetDBParameterGroupRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the ResetDBParameterGroup operation.
|
| BeginRestoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the RestoreDBInstanceFromDBSnapshot operation.
|
| BeginRestoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the RestoreDBInstanceToPointInTime operation.
|
| BeginRevokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the RevokeDBSecurityGroupIngress operation.
|
| CopyDBSnapshot(CopyDBSnapshotRequest) | Copies the specified DBSnapshot. The source DBSnapshot must be in the "available" state. |
| CreateDBInstance(CreateDBInstanceRequest) | Creates a new DB instance. |
| CreateDBInstanceReadReplica(CreateDBInstanceReadReplicaRequest) | Creates a DB Instance that acts as a Read Replica of a source DB Instance. All Read Replica DB Instances are created as Single-AZ deployments with backups disabled. All other DB Instance attributes (including DB Security Groups and DB Parameter Groups) are inherited from the source DB Instance, except as specified below. IMPORTANT: The source DB Instance must have backup retention enabled. |
| CreateDBParameterGroup(CreateDBParameterGroupRequest) | 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. |
| CreateDBSecurityGroup(CreateDBSecurityGroupRequest) | Creates a new DB Security Group. DB Security Groups control access to a DB Instance. |
| CreateDBSnapshot(CreateDBSnapshotRequest) | Creates a DBSnapshot. The source DBInstance must be in "available" state. |
| CreateDBSubnetGroup(CreateDBSubnetGroupRequest) | Creates a new DB subnet group. DB subnet groups must contain at least one subnet in each AZ in the region. |
| DeleteDBInstance(DeleteDBInstanceRequest) | 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. |
| DeleteDBParameterGroup(DeleteDBParameterGroupRequest) | 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. |
| DeleteDBSecurityGroup(DeleteDBSecurityGroupRequest) | Deletes a DB Security Group. NOTE:The specified DB Security Group must not be associated with any DB Instances. |
| DeleteDBSnapshot(DeleteDBSnapshotRequest) | Deletes a DBSnapshot. NOTE:The DBSnapshot must be in the available state to be deleted. |
| DeleteDBSubnetGroup(DeleteDBSubnetGroupRequest) | Deletes a DB subnet group. NOTE:The specified database subnet group must not be associated with any DB instances. |
| DescribeDBEngineVersions()()()() | Returns a list of the available DB engines. |
| DescribeDBEngineVersions(DescribeDBEngineVersionsRequest) | Returns a list of the available DB engines. |
| DescribeDBInstances()()()() | Returns information about provisioned RDS instances. This API supports pagination. |
| DescribeDBInstances(DescribeDBInstancesRequest) | Returns information about provisioned RDS instances. This API supports pagination. |
| DescribeDBParameterGroups()()()() | Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DBParameterGroup. |
| DescribeDBParameterGroups(DescribeDBParameterGroupsRequest) | Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description of the specified DBParameterGroup. |
| DescribeDBParameters(DescribeDBParametersRequest) | Returns the detailed parameter list for a particular DBParameterGroup. |
| DescribeDBSecurityGroups()()()() | Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DBSecurityGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial. |
| DescribeDBSecurityGroups(DescribeDBSecurityGroupsRequest) | Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DBSecurityGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial. |
| DescribeDBSnapshots()()()() | Returns information about DBSnapshots. This API supports pagination. |
| DescribeDBSnapshots(DescribeDBSnapshotsRequest) | Returns information about DBSnapshots. This API supports pagination. |
| DescribeDBSubnetGroups()()()() | Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial. |
| DescribeDBSubnetGroups(DescribeDBSubnetGroupsRequest) | Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup. For an overview of CIDR ranges, go to the Wikipedia Tutorial. |
| DescribeEngineDefaultParameters(DescribeEngineDefaultParametersRequest) | Returns the default engine and system parameter information for the specified database engine. |
| DescribeEvents()()()() | 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 Instance, DB Security Group, database snapshot or DB Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. |
| DescribeEvents(DescribeEventsRequest) | 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 Instance, DB Security Group, database snapshot or DB Parameter Group can be obtained by providing the name as a parameter. By default, the past hour of events are returned. |
| DescribeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest) | Returns a list of orderable DB Instance options for the specified engine. |
| DescribeReservedDBInstances()()()() | Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance. |
| DescribeReservedDBInstances(DescribeReservedDBInstancesRequest) | Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance. |
| DescribeReservedDBInstancesOfferings()()()() | Lists available reserved DB Instance offerings. |
| DescribeReservedDBInstancesOfferings(DescribeReservedDBInstancesOfferingsRequest) | Lists available reserved DB Instance offerings. |
| Dispose()()()() |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from IDisposable.) |
| EndAuthorizeDBSecurityGroupIngress(IAsyncResult) |
Finishes the asynchronous execution of the AuthorizeDBSecurityGroupIngress operation.
|
| EndCopyDBSnapshot(IAsyncResult) |
Finishes the asynchronous execution of the CopyDBSnapshot operation.
|
| EndCreateDBInstance(IAsyncResult) |
Finishes the asynchronous execution of the CreateDBInstance operation.
|
| EndCreateDBInstanceReadReplica(IAsyncResult) |
Finishes the asynchronous execution of the CreateDBInstanceReadReplica operation.
|
| EndCreateDBParameterGroup(IAsyncResult) |
Finishes the asynchronous execution of the CreateDBParameterGroup operation.
|
| EndCreateDBSecurityGroup(IAsyncResult) |
Finishes the asynchronous execution of the CreateDBSecurityGroup operation.
|
| EndCreateDBSnapshot(IAsyncResult) |
Finishes the asynchronous execution of the CreateDBSnapshot operation.
|
| EndCreateDBSubnetGroup(IAsyncResult) |
Finishes the asynchronous execution of the CreateDBSubnetGroup operation.
|
| EndDeleteDBInstance(IAsyncResult) |
Finishes the asynchronous execution of the DeleteDBInstance operation.
|
| EndDeleteDBParameterGroup(IAsyncResult) |
Finishes the asynchronous execution of the DeleteDBParameterGroup operation.
|
| EndDeleteDBSecurityGroup(IAsyncResult) |
Finishes the asynchronous execution of the DeleteDBSecurityGroup operation.
|
| EndDeleteDBSnapshot(IAsyncResult) |
Finishes the asynchronous execution of the DeleteDBSnapshot operation.
|
| EndDeleteDBSubnetGroup(IAsyncResult) |
Finishes the asynchronous execution of the DeleteDBSubnetGroup operation.
|
| EndDescribeDBEngineVersions(IAsyncResult) |
Finishes the asynchronous execution of the DescribeDBEngineVersions operation.
|
| EndDescribeDBInstances(IAsyncResult) |
Finishes the asynchronous execution of the DescribeDBInstances operation.
|
| EndDescribeDBParameterGroups(IAsyncResult) |
Finishes the asynchronous execution of the DescribeDBParameterGroups operation.
|
| EndDescribeDBParameters(IAsyncResult) |
Finishes the asynchronous execution of the DescribeDBParameters operation.
|
| EndDescribeDBSecurityGroups(IAsyncResult) |
Finishes the asynchronous execution of the DescribeDBSecurityGroups operation.
|
| EndDescribeDBSnapshots(IAsyncResult) |
Finishes the asynchronous execution of the DescribeDBSnapshots operation.
|
| EndDescribeDBSubnetGroups(IAsyncResult) |
Finishes the asynchronous execution of the DescribeDBSubnetGroups operation.
|
| EndDescribeEngineDefaultParameters(IAsyncResult) |
Finishes the asynchronous execution of the DescribeEngineDefaultParameters operation.
|
| EndDescribeEvents(IAsyncResult) |
Finishes the asynchronous execution of the DescribeEvents operation.
|
| EndDescribeOrderableDBInstanceOptions(IAsyncResult) |
Finishes the asynchronous execution of the DescribeOrderableDBInstanceOptions operation.
|
| EndDescribeReservedDBInstances(IAsyncResult) |
Finishes the asynchronous execution of the DescribeReservedDBInstances operation.
|
| EndDescribeReservedDBInstancesOfferings(IAsyncResult) |
Finishes the asynchronous execution of the DescribeReservedDBInstancesOfferings operation.
|
| EndModifyDBInstance(IAsyncResult) |
Finishes the asynchronous execution of the ModifyDBInstance operation.
|
| EndModifyDBParameterGroup(IAsyncResult) |
Finishes the asynchronous execution of the ModifyDBParameterGroup operation.
|
| EndModifyDBSubnetGroup(IAsyncResult) |
Finishes the asynchronous execution of the ModifyDBSubnetGroup operation.
|
| EndPurchaseReservedDBInstancesOffering(IAsyncResult) |
Finishes the asynchronous execution of the PurchaseReservedDBInstancesOffering operation.
|
| EndRebootDBInstance(IAsyncResult) |
Finishes the asynchronous execution of the RebootDBInstance operation.
|
| EndResetDBParameterGroup(IAsyncResult) |
Finishes the asynchronous execution of the ResetDBParameterGroup operation.
|
| EndRestoreDBInstanceFromDBSnapshot(IAsyncResult) |
Finishes the asynchronous execution of the RestoreDBInstanceFromDBSnapshot operation.
|
| EndRestoreDBInstanceToPointInTime(IAsyncResult) |
Finishes the asynchronous execution of the RestoreDBInstanceToPointInTime operation.
|
| EndRevokeDBSecurityGroupIngress(IAsyncResult) |
Finishes the asynchronous execution of the RevokeDBSecurityGroupIngress operation.
|
| ModifyDBInstance(ModifyDBInstanceRequest) | 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. |
| ModifyDBParameterGroup(ModifyDBParameterGroupRequest) | 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 only be used for dynamic parameters; the pending-reboot method can be used for either dynamic or static parameters. |
| ModifyDBSubnetGroup(ModifyDBSubnetGroupRequest) | Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in each AZ in the region. |
| PurchaseReservedDBInstancesOffering(PurchaseReservedDBInstancesOfferingRequest) | Purchases a reserved DB Instance offering. |
| RebootDBInstance(RebootDBInstanceRequest) | 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. A DBInstance event is created when the reboot is completed. |
| ResetDBParameterGroup(ResetDBParameterGroupRequest) | 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. |
| RestoreDBInstanceFromDBSnapshot(RestoreDBInstanceFromDBSnapshotRequest) | 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. |
| RestoreDBInstanceToPointInTime(RestoreDBInstanceToPointInTimeRequest) | Restores a DB Instance to an arbitrary point-in-time. Users can restore to any point in time before the latestRestorableTime for up to backupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group. |
| RevokeDBSecurityGroupIngress(RevokeDBSecurityGroupIngressRequest) | 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). |
See Also
