com.amazonaws.services.rds
Class AmazonRDSAsyncClient

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceClient
      extended by com.amazonaws.services.rds.AmazonRDSClient
          extended by com.amazonaws.services.rds.AmazonRDSAsyncClient
All Implemented Interfaces:
AmazonRDS, AmazonRDSAsync

public class AmazonRDSAsyncClient
extends AmazonRDSClient
implements AmazonRDSAsync

Client for accessing AmazonRDS. All calls made using this client are non-blocking and will immediately return a Java Future. Callers must use the Future object to determine when the service call has actually completed.

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 database server. This means the code, applications, and tools you already use today with your existing MySQL 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.


Constructor Summary
AmazonRDSAsyncClient(AWSCredentials awsCredentials)
          Constructs a new asynchronous client to invoke service methods on AmazonRDS using the specified AWS account credentials.
AmazonRDSAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
          Constructs a new asynchronous client to invoke service methods on AmazonRDS using the specified AWS account credentials, executor service, and client configuration options.
AmazonRDSAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
          Constructs a new asynchronous client to invoke service methods on AmazonRDS using the specified AWS account credentials and executor service.
 
Method Summary
 Future<DBSecurityGroup> authorizeDBSecurityGroupIngressAsync(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest)
           This API allows for ingress to a DBSecurityGroup using one of two forms of authorization.
 Future<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest createDBInstanceRequest)
           This API creates a new DB instance.
 Future<DBParameterGroup> createDBParameterGroupAsync(CreateDBParameterGroupRequest createDBParameterGroupRequest)
           This API creates a new database parameter group.
 Future<DBSecurityGroup> createDBSecurityGroupAsync(CreateDBSecurityGroupRequest createDBSecurityGroupRequest)
           This API creates a new database security group.
 Future<DBSnapshot> createDBSnapshotAsync(CreateDBSnapshotRequest createDBSnapshotRequest)
           This API is used to create a DBSnapshot.
 Future<DBInstance> deleteDBInstanceAsync(DeleteDBInstanceRequest deleteDBInstanceRequest)
           The DeleteDBInstance API deletes a previously provisioned RDS instance.
 Future<Void> deleteDBParameterGroupAsync(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)
           This API deletes a particular DBParameterGroup.
 Future<Void> deleteDBSecurityGroupAsync(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest)
           This API deletes a database security group.
 Future<DBSnapshot> deleteDBSnapshotAsync(DeleteDBSnapshotRequest deleteDBSnapshotRequest)
           This API is used to delete a DBSnapshot.
 Future<DescribeDBInstancesResult> describeDBInstancesAsync(DescribeDBInstancesRequest describeDBInstancesRequest)
           This API is used to retrieve information about provisioned RDS instances.
 Future<DescribeDBParameterGroupsResult> describeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest)
           This API returns a list of DBParameterGroup descriptions.
 Future<DescribeDBParametersResult> describeDBParametersAsync(DescribeDBParametersRequest describeDBParametersRequest)
           This API returns the detailed parameter list for a particular DBParameterGroup.
 Future<DescribeDBSecurityGroupsResult> describeDBSecurityGroupsAsync(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest)
           This API returns a list of DBSecurityGroup descriptions.
 Future<DescribeDBSnapshotsResult> describeDBSnapshotsAsync(DescribeDBSnapshotsRequest describeDBSnapshotsRequest)
           This API is used to retrieve information about DBSnapshots.
 Future<EngineDefaults> describeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
           This API returns the default engine and system parameter information for the specified database engine.
 Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest describeEventsRequest)
           This API returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 das.
 ExecutorService getExecutorService()
          Returns the executor service used by this async client to execute requests.
 Future<DBInstance> modifyDBInstanceAsync(ModifyDBInstanceRequest modifyDBInstanceRequest)
           This API is used to change RDS Instance settings.
 Future<ModifyDBParameterGroupResult> modifyDBParameterGroupAsync(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest)
           This API modifies the parameters of a DBParameterGroup.
 Future<DBInstance> rebootDBInstanceAsync(RebootDBInstanceRequest rebootDBInstanceRequest)
           The RebootDBInstance API reboots a previously provisioned RDS instance.
 Future<ResetDBParameterGroupResult> resetDBParameterGroupAsync(ResetDBParameterGroupRequest resetDBParameterGroupRequest)
           This API modifies the parameters of a DBParameterGroup to the engine/system default value.
 Future<DBInstance> restoreDBInstanceFromDBSnapshotAsync(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest)
           This API creates a new DB Instance to an arbitrary point-in-time.
 Future<DBInstance> restoreDBInstanceToPointInTimeAsync(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest)
           This API creates a new RDS instance from a point-in-time system snapshot.
 Future<DBSecurityGroup> revokeDBSecurityGroupIngressAsync(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest)
           This API revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 Security Groups.
 
Methods inherited from class com.amazonaws.services.rds.AmazonRDSClient
authorizeDBSecurityGroupIngress, createDBInstance, createDBParameterGroup, createDBSecurityGroup, createDBSnapshot, deleteDBInstance, deleteDBParameterGroup, deleteDBSecurityGroup, deleteDBSnapshot, describeDBInstances, describeDBInstances, describeDBParameterGroups, describeDBParameterGroups, describeDBParameters, describeDBSecurityGroups, describeDBSecurityGroups, describeDBSnapshots, describeDBSnapshots, describeEngineDefaultParameters, describeEvents, describeEvents, modifyDBInstance, modifyDBParameterGroup, rebootDBInstance, resetDBParameterGroup, restoreDBInstanceFromDBSnapshot, restoreDBInstanceToPointInTime, revokeDBSecurityGroupIngress
 
Methods inherited from class com.amazonaws.AmazonWebServiceClient
setEndpoint
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.amazonaws.services.rds.AmazonRDS
authorizeDBSecurityGroupIngress, createDBInstance, createDBParameterGroup, createDBSecurityGroup, createDBSnapshot, deleteDBInstance, deleteDBParameterGroup, deleteDBSecurityGroup, deleteDBSnapshot, describeDBInstances, describeDBInstances, describeDBParameterGroups, describeDBParameterGroups, describeDBParameters, describeDBSecurityGroups, describeDBSecurityGroups, describeDBSnapshots, describeDBSnapshots, describeEngineDefaultParameters, describeEvents, describeEvents, modifyDBInstance, modifyDBParameterGroup, rebootDBInstance, resetDBParameterGroup, restoreDBInstanceFromDBSnapshot, restoreDBInstanceToPointInTime, revokeDBSecurityGroupIngress, setEndpoint
 

Constructor Detail

AmazonRDSAsyncClient

public AmazonRDSAsyncClient(AWSCredentials awsCredentials)
Constructs a new asynchronous client to invoke service methods on AmazonRDS using the specified AWS account credentials. Default client settings will be used, and a default cached thread pool will be created for executing the asynchronous tasks.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonRDSAsyncClient

public AmazonRDSAsyncClient(AWSCredentials awsCredentials,
                            ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonRDS using the specified AWS account credentials and executor service. Default client settings will be used.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
executorService - The executor service by which all asynchronous requests will be executed.

AmazonRDSAsyncClient

public AmazonRDSAsyncClient(AWSCredentials awsCredentials,
                            ClientConfiguration clientConfiguration,
                            ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonRDS using the specified AWS account credentials, executor service, and client configuration options.

All calls made using this new client object are non-blocking, and will immediately return a Java Future object that the caller can later check to see if the service call has actually completed.

Parameters:
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.
clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).
executorService - The executor service by which all asynchronous requests will be executed.
Method Detail

getExecutorService

public ExecutorService getExecutorService()
Returns the executor service used by this async client to execute requests.

Returns:
The executor service used by this async client to execute requests.

modifyDBInstanceAsync

public Future<DBInstance> modifyDBInstanceAsync(ModifyDBInstanceRequest modifyDBInstanceRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException

This API is used to change RDS Instance settings. Users call the ModifyDBInstance API to change one or more database configuration parameters by specifying these parameters and the new values in the request.

Specified by:
modifyDBInstanceAsync in interface AmazonRDSAsync
Parameters:
modifyDBInstanceRequest - Container for the necessary parameters to execute the ModifyDBInstance operation on AmazonRDS.
Returns:
A Java Future object containing the response from the ModifyDBInstance service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

resetDBParameterGroupAsync

public Future<ResetDBParameterGroupResult> resetDBParameterGroupAsync(ResetDBParameterGroupRequest resetDBParameterGroupRequest)
                                                               throws AmazonServiceException,
                                                                      AmazonClientException

This API 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 MySQL reboot or RebootDBInstance request.

Specified by:
resetDBParameterGroupAsync in interface AmazonRDSAsync
Parameters:
resetDBParameterGroupRequest - Container for the necessary parameters to execute the ResetDBParameterGroup operation on AmazonRDS.
Returns:
A Java Future object containing the response from the ResetDBParameterGroup service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

modifyDBParameterGroupAsync

public Future<ModifyDBParameterGroupResult> modifyDBParameterGroupAsync(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest)
                                                                 throws AmazonServiceException,
                                                                        AmazonClientException

This API 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.

Specified by:
modifyDBParameterGroupAsync in interface AmazonRDSAsync
Parameters:
modifyDBParameterGroupRequest - Container for the necessary parameters to execute the ModifyDBParameterGroup operation on AmazonRDS.
Returns:
A Java Future object containing the response from the ModifyDBParameterGroup service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeEventsAsync

public Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest describeEventsRequest)
                                                 throws AmazonServiceException,
                                                        AmazonClientException

This API returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 das. Events specific to a particular DB Instance, database security group, database snapshot or database parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.

Specified by:
describeEventsAsync in interface AmazonRDSAsync
Parameters:
describeEventsRequest - Container for the necessary parameters to execute the DescribeEvents operation on AmazonRDS.
Returns:
A Java Future object containing the response from the DescribeEvents service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeEngineDefaultParametersAsync

public Future<EngineDefaults> describeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

This API returns the default engine and system parameter information for the specified database engine.

Specified by:
describeEngineDefaultParametersAsync in interface AmazonRDSAsync
Parameters:
describeEngineDefaultParametersRequest - Container for the necessary parameters to execute the DescribeEngineDefaultParameters operation on AmazonRDS.
Returns:
A Java Future object containing the response from the DescribeEngineDefaultParameters service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

restoreDBInstanceToPointInTimeAsync

public Future<DBInstance> restoreDBInstanceToPointInTimeAsync(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest)
                                                       throws AmazonServiceException,
                                                              AmazonClientException

This API creates a new RDS instance from a point-in-time system 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.

Specified by:
restoreDBInstanceToPointInTimeAsync in interface AmazonRDSAsync
Parameters:
restoreDBInstanceToPointInTimeRequest - Container for the necessary parameters to execute the RestoreDBInstanceToPointInTime operation on AmazonRDS.
Returns:
A Java Future object containing the response from the RestoreDBInstanceToPointInTime service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBSnapshotsAsync

public Future<DescribeDBSnapshotsResult> describeDBSnapshotsAsync(DescribeDBSnapshotsRequest describeDBSnapshotsRequest)
                                                           throws AmazonServiceException,
                                                                  AmazonClientException

This API is used to retrieve information about DBSnapshots. This API supports pagination.

Specified by:
describeDBSnapshotsAsync in interface AmazonRDSAsync
Parameters:
describeDBSnapshotsRequest - Container for the necessary parameters to execute the DescribeDBSnapshots operation on AmazonRDS.
Returns:
A Java Future object containing the response from the DescribeDBSnapshots service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

deleteDBSecurityGroupAsync

public Future<Void> deleteDBSecurityGroupAsync(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

This API deletes a database security group. Database security group must not be associated with any RDS Instances.

Specified by:
deleteDBSecurityGroupAsync in interface AmazonRDSAsync
Parameters:
deleteDBSecurityGroupRequest - Container for the necessary parameters to execute the DeleteDBSecurityGroup operation on AmazonRDS.
Returns:
A Java Future object containing the response from the DeleteDBSecurityGroup service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

deleteDBParameterGroupAsync

public Future<Void> deleteDBParameterGroupAsync(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException

This API deletes a particular DBParameterGroup. The DBParameterGroup cannot be associated with any RDS instances to be deleted.

Specified by:
deleteDBParameterGroupAsync in interface AmazonRDSAsync
Parameters:
deleteDBParameterGroupRequest - Container for the necessary parameters to execute the DeleteDBParameterGroup operation on AmazonRDS.
Returns:
A Java Future object containing the response from the DeleteDBParameterGroup service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBParameterGroupsAsync

public Future<DescribeDBParameterGroupsResult> describeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest)
                                                                       throws AmazonServiceException,
                                                                              AmazonClientException

This API returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the descriptions of the specified DBParameterGroup.

Specified by:
describeDBParameterGroupsAsync in interface AmazonRDSAsync
Parameters:
describeDBParameterGroupsRequest - Container for the necessary parameters to execute the DescribeDBParameterGroups operation on AmazonRDS.
Returns:
A Java Future object containing the response from the DescribeDBParameterGroups service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

deleteDBInstanceAsync

public Future<DBInstance> deleteDBInstanceAsync(DeleteDBInstanceRequest deleteDBInstanceRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException

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.

Specified by:
deleteDBInstanceAsync in interface AmazonRDSAsync
Parameters:
deleteDBInstanceRequest - Container for the necessary parameters to execute the DeleteDBInstance operation on AmazonRDS.
Returns:
A Java Future object containing the response from the DeleteDBInstance service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

deleteDBSnapshotAsync

public Future<DBSnapshot> deleteDBSnapshotAsync(DeleteDBSnapshotRequest deleteDBSnapshotRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException

This API is used to delete a DBSnapshot. The DBSnapshot must be in the "available" state to be deleted.

Specified by:
deleteDBSnapshotAsync in interface AmazonRDSAsync
Parameters:
deleteDBSnapshotRequest - Container for the necessary parameters to execute the DeleteDBSnapshot operation on AmazonRDS.
Returns:
A Java Future object containing the response from the DeleteDBSnapshot service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBSecurityGroupsAsync

public Future<DescribeDBSecurityGroupsResult> describeDBSecurityGroupsAsync(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest)
                                                                     throws AmazonServiceException,
                                                                            AmazonClientException

This API returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified, the list will contain only the descriptions of the specified DBSecurityGroup.

Specified by:
describeDBSecurityGroupsAsync in interface AmazonRDSAsync
Parameters:
describeDBSecurityGroupsRequest - Container for the necessary parameters to execute the DescribeDBSecurityGroups operation on AmazonRDS.
Returns:
A Java Future object containing the response from the DescribeDBSecurityGroups service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

revokeDBSecurityGroupIngressAsync

public Future<DBSecurityGroup> revokeDBSecurityGroupIngressAsync(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

This API revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 Security Groups. Required parameters for this API are one of CIDRIP or (EC2SecurityGroupName AND EC2SecurityGroupOwnerId).

Specified by:
revokeDBSecurityGroupIngressAsync in interface AmazonRDSAsync
Parameters:
revokeDBSecurityGroupIngressRequest - Container for the necessary parameters to execute the RevokeDBSecurityGroupIngress operation on AmazonRDS.
Returns:
A Java Future object containing the response from the RevokeDBSecurityGroupIngress service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBInstancesAsync

public Future<DescribeDBInstancesResult> describeDBInstancesAsync(DescribeDBInstancesRequest describeDBInstancesRequest)
                                                           throws AmazonServiceException,
                                                                  AmazonClientException

This API is used to retrieve information about provisioned RDS instances. DescribeDBInstances supports pagination.

Specified by:
describeDBInstancesAsync in interface AmazonRDSAsync
Parameters:
describeDBInstancesRequest - Container for the necessary parameters to execute the DescribeDBInstances operation on AmazonRDS.
Returns:
A Java Future object containing the response from the DescribeDBInstances service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

createDBSnapshotAsync

public Future<DBSnapshot> createDBSnapshotAsync(CreateDBSnapshotRequest createDBSnapshotRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException

This API is used to create a DBSnapshot. The source DBInstance must be in "available" state.

Specified by:
createDBSnapshotAsync in interface AmazonRDSAsync
Parameters:
createDBSnapshotRequest - Container for the necessary parameters to execute the CreateDBSnapshot operation on AmazonRDS.
Returns:
A Java Future object containing the response from the CreateDBSnapshot service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

describeDBParametersAsync

public Future<DescribeDBParametersResult> describeDBParametersAsync(DescribeDBParametersRequest describeDBParametersRequest)
                                                             throws AmazonServiceException,
                                                                    AmazonClientException

This API returns the detailed parameter list for a particular DBParameterGroup.

Specified by:
describeDBParametersAsync in interface AmazonRDSAsync
Parameters:
describeDBParametersRequest - Container for the necessary parameters to execute the DescribeDBParameters operation on AmazonRDS.
Returns:
A Java Future object containing the response from the DescribeDBParameters service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

createDBInstanceAsync

public Future<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest createDBInstanceRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException

This API creates a new DB instance.

Specified by:
createDBInstanceAsync in interface AmazonRDSAsync
Parameters:
createDBInstanceRequest - Container for the necessary parameters to execute the CreateDBInstance operation on AmazonRDS.
Returns:
A Java Future object containing the response from the CreateDBInstance service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

restoreDBInstanceFromDBSnapshotAsync

public Future<DBInstance> restoreDBInstanceFromDBSnapshotAsync(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

This API creates a new 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.

Specified by:
restoreDBInstanceFromDBSnapshotAsync in interface AmazonRDSAsync
Parameters:
restoreDBInstanceFromDBSnapshotRequest - Container for the necessary parameters to execute the RestoreDBInstanceFromDBSnapshot operation on AmazonRDS.
Returns:
A Java Future object containing the response from the RestoreDBInstanceFromDBSnapshot service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

createDBSecurityGroupAsync

public Future<DBSecurityGroup> createDBSecurityGroupAsync(CreateDBSecurityGroupRequest createDBSecurityGroupRequest)
                                                   throws AmazonServiceException,
                                                          AmazonClientException

This API creates a new database security group. Database Security groups control access to a database instance.

Specified by:
createDBSecurityGroupAsync in interface AmazonRDSAsync
Parameters:
createDBSecurityGroupRequest - Container for the necessary parameters to execute the CreateDBSecurityGroup operation on AmazonRDS.
Returns:
A Java Future object containing the response from the CreateDBSecurityGroup service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

createDBParameterGroupAsync

public Future<DBParameterGroup> createDBParameterGroupAsync(CreateDBParameterGroupRequest createDBParameterGroupRequest)
                                                     throws AmazonServiceException,
                                                            AmazonClientException

This API creates a new database parameter group.

Specified by:
createDBParameterGroupAsync in interface AmazonRDSAsync
Parameters:
createDBParameterGroupRequest - Container for the necessary parameters to execute the CreateDBParameterGroup operation on AmazonRDS.
Returns:
A Java Future object containing the response from the CreateDBParameterGroup service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

rebootDBInstanceAsync

public Future<DBInstance> rebootDBInstanceAsync(RebootDBInstanceRequest rebootDBInstanceRequest)
                                         throws AmazonServiceException,
                                                AmazonClientException

The RebootDBInstance API 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.

Specified by:
rebootDBInstanceAsync in interface AmazonRDSAsync
Parameters:
rebootDBInstanceRequest - Container for the necessary parameters to execute the RebootDBInstance operation on AmazonRDS.
Returns:
A Java Future object containing the response from the RebootDBInstance service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.

authorizeDBSecurityGroupIngressAsync

public Future<DBSecurityGroup> authorizeDBSecurityGroupIngressAsync(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest)
                                                             throws AmazonServiceException,
                                                                    AmazonClientException

This API allows for ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 Security Groups can be added to the DBSecurityGroup if the application using the database is running on EC2 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 or (EC2SecurityGroupName AND EC2SecurityGroupOwnerId).

Specified by:
authorizeDBSecurityGroupIngressAsync in interface AmazonRDSAsync
Parameters:
authorizeDBSecurityGroupIngressRequest - Container for the necessary parameters to execute the AuthorizeDBSecurityGroupIngress operation on AmazonRDS.
Returns:
A Java Future object containing the response from the AuthorizeDBSecurityGroupIngress service method, as returned by AmazonRDS.
Throws:
AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.
AmazonServiceException - If an error response is returned by AmazonRDS indicating either a problem with the data in the request, or a server side issue.


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.