com.amazonaws.services.rds
Class AmazonRDSAsyncClient

java.lang.Object
  com.amazonaws.AmazonWebServiceClient
      com.amazonaws.services.rds.AmazonRDSClient
          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 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 .

Constructor Summary

AmazonRDSAsyncClient()
Constructs a new asynchronous client to invoke service methods on AmazonRDS.

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.

AmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new asynchronous client to invoke service methods on AmazonRDS using the specified AWS account credentials provider.

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

AmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
Constructs a new asynchronous client to invoke service methods on AmazonRDS using the specified AWS account credentials provider and executor service.

AmazonRDSAsyncClient(ClientConfiguration clientConfiguration)
Constructs a new asynchronous client to invoke service methods on AmazonRDS.

Method Summary

Future<DBSecurityGroup>	authorizeDBSecurityGroupIngressAsync(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest) Enables ingress to a DBSecurityGroup using one of two forms of authorization.
Future<DBSnapshot>	copyDBSnapshotAsync(CopyDBSnapshotRequest copyDBSnapshotRequest) Copies the specified DBSnapshot.
Future<DBInstance>	createDBInstanceAsync(CreateDBInstanceRequest createDBInstanceRequest) Creates a new DB instance.
Future<DBInstance>	createDBInstanceReadReplicaAsync(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest) Creates a DB Instance that acts as a Read Replica of a source DB Instance.
Future<DBParameterGroup>	createDBParameterGroupAsync(CreateDBParameterGroupRequest createDBParameterGroupRequest) Creates a new DB Parameter Group.
Future<DBSecurityGroup>	createDBSecurityGroupAsync(CreateDBSecurityGroupRequest createDBSecurityGroupRequest) Creates a new DB Security Group.
Future<DBSnapshot>	createDBSnapshotAsync(CreateDBSnapshotRequest createDBSnapshotRequest) Creates a DBSnapshot.
Future<DBSubnetGroup>	createDBSubnetGroupAsync(CreateDBSubnetGroupRequest createDBSubnetGroupRequest) Creates a new DB subnet group.
Future<OptionGroup>	createOptionGroupAsync(CreateOptionGroupRequest createOptionGroupRequest) Creates a new Option Group.
Future<DBInstance>	deleteDBInstanceAsync(DeleteDBInstanceRequest deleteDBInstanceRequest) The DeleteDBInstance API deletes a previously provisioned RDS instance.
Future<Void>	deleteDBParameterGroupAsync(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest) Deletes a specified DBParameterGroup.
Future<Void>	deleteDBSecurityGroupAsync(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest) Deletes a DB Security Group.
Future<DBSnapshot>	deleteDBSnapshotAsync(DeleteDBSnapshotRequest deleteDBSnapshotRequest) Deletes a DBSnapshot.
Future<Void>	deleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest) Deletes a DB subnet group.
Future<Void>	deleteOptionGroupAsync(DeleteOptionGroupRequest deleteOptionGroupRequest) Deletes an existing Option Group.
Future<DescribeDBEngineVersionsResult>	describeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest) Returns a list of the available DB engines.
Future<DescribeDBInstancesResult>	describeDBInstancesAsync(DescribeDBInstancesRequest describeDBInstancesRequest) Returns information about provisioned RDS instances.
Future<DescribeDBParameterGroupsResult>	describeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest) Returns a list of DBParameterGroup descriptions.
Future<DescribeDBParametersResult>	describeDBParametersAsync(DescribeDBParametersRequest describeDBParametersRequest) Returns the detailed parameter list for a particular DBParameterGroup.
Future<DescribeDBSecurityGroupsResult>	describeDBSecurityGroupsAsync(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest) Returns a list of DBSecurityGroup descriptions.
Future<DescribeDBSnapshotsResult>	describeDBSnapshotsAsync(DescribeDBSnapshotsRequest describeDBSnapshotsRequest) Returns information about DBSnapshots.
Future<DescribeDBSubnetGroupsResult>	describeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.
Future<EngineDefaults>	describeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) Returns the default engine and system parameter information for the specified database engine.
Future<DescribeEventsResult>	describeEventsAsync(DescribeEventsRequest describeEventsRequest) Returns events related to DB Instances, DB Security Groups, DB Snapshots and DB Parameter Groups for the past 14 days.
Future<DescribeOptionGroupOptionsResult>	describeOptionGroupOptionsAsync(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) Describes all available options.
Future<DescribeOptionGroupsResult>	describeOptionGroupsAsync(DescribeOptionGroupsRequest describeOptionGroupsRequest) Describes the available option groups.
Future<DescribeOrderableDBInstanceOptionsResult>	describeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest) Returns a list of orderable DB Instance options for the specified engine.
Future<DescribeReservedDBInstancesResult>	describeReservedDBInstancesAsync(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest) Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.
Future<DescribeReservedDBInstancesOfferingsResult>	describeReservedDBInstancesOfferingsAsync(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest) Lists available reserved DB Instance offerings.
ExecutorService	getExecutorService() Returns the executor service used by this async client to execute requests.
Future<DBInstance>	modifyDBInstanceAsync(ModifyDBInstanceRequest modifyDBInstanceRequest) Modify settings for a DB Instance.
Future<ModifyDBParameterGroupResult>	modifyDBParameterGroupAsync(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest) Modifies the parameters of a DBParameterGroup.
Future<DBSubnetGroup>	modifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest) Modifies an existing DB subnet group.
Future<OptionGroup>	modifyOptionGroupAsync(ModifyOptionGroupRequest modifyOptionGroupRequest) Modifies an existing Option Group.
Future<ReservedDBInstance>	purchaseReservedDBInstancesOfferingAsync(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest) Purchases a reserved DB Instance offering.
Future<DBInstance>	rebootDBInstanceAsync(RebootDBInstanceRequest rebootDBInstanceRequest) Reboots a previously provisioned RDS instance.
Future<ResetDBParameterGroupResult>	resetDBParameterGroupAsync(ResetDBParameterGroupRequest resetDBParameterGroupRequest) Modifies the parameters of a DBParameterGroup to the engine/system default value.
Future<DBInstance>	restoreDBInstanceFromDBSnapshotAsync(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest) Creates a new DB Instance from a DB snapshot.
Future<DBInstance>	restoreDBInstanceToPointInTimeAsync(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest) Restores a DB Instance to an arbitrary point-in-time.
Future<DBSecurityGroup>	revokeDBSecurityGroupIngressAsync(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest) Revokes ingress from a DBSecurityGroup for previously authorized IP ranges or EC2 or VPC Security Groups.
void	shutdown() Shuts down the client, releasing all managed resources.

Methods inherited from class com.amazonaws.services.rds.AmazonRDSClient

authorizeDBSecurityGroupIngress, copyDBSnapshot, createDBInstance, createDBInstanceReadReplica, createDBParameterGroup, createDBSecurityGroup, createDBSnapshot, createDBSubnetGroup, createOptionGroup, deleteDBInstance, deleteDBParameterGroup, deleteDBSecurityGroup, deleteDBSnapshot, deleteDBSubnetGroup, deleteOptionGroup, describeDBEngineVersions, describeDBEngineVersions, describeDBInstances, describeDBInstances, describeDBParameterGroups, describeDBParameterGroups, describeDBParameters, describeDBSecurityGroups, describeDBSecurityGroups, describeDBSnapshots, describeDBSnapshots, describeDBSubnetGroups, describeDBSubnetGroups, describeEngineDefaultParameters, describeEvents, describeEvents, describeOptionGroupOptions, describeOptionGroups, describeOptionGroups, describeOrderableDBInstanceOptions, describeReservedDBInstances, describeReservedDBInstances, describeReservedDBInstancesOfferings, describeReservedDBInstancesOfferings, getCachedResponseMetadata, modifyDBInstance, modifyDBParameterGroup, modifyDBSubnetGroup, modifyOptionGroup, purchaseReservedDBInstancesOffering, rebootDBInstance, resetDBParameterGroup, restoreDBInstanceFromDBSnapshot, restoreDBInstanceToPointInTime, revokeDBSecurityGroupIngress, setEndpoint

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, removeRequestHandler, setConfiguration, 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, copyDBSnapshot, createDBInstance, createDBInstanceReadReplica, createDBParameterGroup, createDBSecurityGroup, createDBSnapshot, createDBSubnetGroup, createOptionGroup, deleteDBInstance, deleteDBParameterGroup, deleteDBSecurityGroup, deleteDBSnapshot, deleteDBSubnetGroup, deleteOptionGroup, describeDBEngineVersions, describeDBEngineVersions, describeDBInstances, describeDBInstances, describeDBParameterGroups, describeDBParameterGroups, describeDBParameters, describeDBSecurityGroups, describeDBSecurityGroups, describeDBSnapshots, describeDBSnapshots, describeDBSubnetGroups, describeDBSubnetGroups, describeEngineDefaultParameters, describeEvents, describeEvents, describeOptionGroupOptions, describeOptionGroups, describeOptionGroups, describeOrderableDBInstanceOptions, describeReservedDBInstances, describeReservedDBInstances, describeReservedDBInstancesOfferings, describeReservedDBInstancesOfferings, getCachedResponseMetadata, modifyDBInstance, modifyDBParameterGroup, modifyDBSubnetGroup, modifyOptionGroup, purchaseReservedDBInstancesOffering, rebootDBInstance, resetDBParameterGroup, restoreDBInstanceFromDBSnapshot, restoreDBInstanceToPointInTime, revokeDBSecurityGroupIngress, setEndpoint

Constructor Detail

AmazonRDSAsyncClient

public AmazonRDSAsyncClient()

Constructs a new asynchronous client to invoke service methods on AmazonRDS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProvider

AmazonRDSAsyncClient

public AmazonRDSAsyncClient(ClientConfiguration clientConfiguration)

Constructs a new asynchronous client to invoke service methods on AmazonRDS. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonRDS (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProvider

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.

AmazonRDSAsyncClient

public AmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new asynchronous client to invoke service methods on AmazonRDS using the specified AWS account credentials provider. 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:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonRDSAsyncClient

public AmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonRDS using the specified AWS account credentials provider 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:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

executorService - The executor service by which all asynchronous requests will be executed.

AmazonRDSAsyncClient

public AmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
                            ClientConfiguration clientConfiguration,
                            ExecutorService executorService)

Constructs a new asynchronous client to invoke service methods on AmazonRDS using the specified AWS account credentials provider, 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:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests 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.

shutdown

public void shutdown()

Shuts down the client, releasing all managed resources. This includes forcibly terminating all pending asynchronous service calls. Clients who wish to give pending asynchronous service calls time to complete should call getExecutorService().shutdown() prior to calling this method.

Specified by:

shutdown in interface AmazonRDS

Overrides:

shutdown in class AmazonWebServiceClient

createDBInstanceAsync

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

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.

describeEventsAsync

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

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.

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.

restoreDBInstanceToPointInTimeAsync

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

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.

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.

deleteDBSubnetGroupAsync

public Future<Void> deleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Deletes a DB subnet group.

NOTE:The specified database subnet group must not be associated with any DB instances.

Specified by:

deleteDBSubnetGroupAsync in interface AmazonRDSAsync

Parameters:

deleteDBSubnetGroupRequest - Container for the necessary parameters to execute the DeleteDBSubnetGroup operation on AmazonRDS.

Returns:

A Java Future object containing the response from the DeleteDBSubnetGroup 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

Creates a new DB Security Group. DB Security Groups control access to a DB 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.

describeDBSubnetGroupsAsync

public Future<DescribeDBSubnetGroupsResult> describeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest)
                                                                 throws AmazonServiceException,
                                                                        AmazonClientException

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 .

Specified by:

describeDBSubnetGroupsAsync in interface AmazonRDSAsync

Parameters:

describeDBSubnetGroupsRequest - Container for the necessary parameters to execute the DescribeDBSubnetGroups operation on AmazonRDS.

Returns:

A Java Future object containing the response from the DescribeDBSubnetGroups 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

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.

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.

modifyDBParameterGroupAsync

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

Modifies the parameters of a DBParameterGroup. To modify more than one parameter submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

NOTE: The apply-immediate method can be used only for dynamic parameters; the pending-reboot method can be used with MySQL and Oracle DB Instances for either dynamic or static parameters. For Microsoft SQL Server DB Instances, the pending-reboot method can be used only for static parameters.

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.

describeDBParameterGroupsAsync

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

Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the list will contain only the description 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.

describeDBEngineVersionsAsync

public Future<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)
                                                                     throws AmazonServiceException,
                                                                            AmazonClientException

Returns a list of the available DB engines.

Specified by:

describeDBEngineVersionsAsync in interface AmazonRDSAsync

Parameters:

describeDBEngineVersionsRequest - Container for the necessary parameters to execute the DescribeDBEngineVersions operation on AmazonRDS.

Returns:

A Java Future object containing the response from the DescribeDBEngineVersions 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

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.

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.

purchaseReservedDBInstancesOfferingAsync

public Future<ReservedDBInstance> purchaseReservedDBInstancesOfferingAsync(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest)
                                                                    throws AmazonServiceException,
                                                                           AmazonClientException

Purchases a reserved DB Instance offering.

Specified by:

purchaseReservedDBInstancesOfferingAsync in interface AmazonRDSAsync

Parameters:

purchaseReservedDBInstancesOfferingRequest - Container for the necessary parameters to execute the PurchaseReservedDBInstancesOffering operation on AmazonRDS.

Returns:

A Java Future object containing the response from the PurchaseReservedDBInstancesOffering 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.

modifyDBSubnetGroupAsync

public Future<DBSubnetGroup> modifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in each AZ in the region.

Specified by:

modifyDBSubnetGroupAsync in interface AmazonRDSAsync

Parameters:

modifyDBSubnetGroupRequest - Container for the necessary parameters to execute the ModifyDBSubnetGroup operation on AmazonRDS.

Returns:

A Java Future object containing the response from the ModifyDBSubnetGroup 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

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).

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.

deleteOptionGroupAsync

public Future<Void> deleteOptionGroupAsync(DeleteOptionGroupRequest deleteOptionGroupRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Deletes an existing Option Group.

Specified by:

deleteOptionGroupAsync in interface AmazonRDSAsync

Parameters:

deleteOptionGroupRequest - Container for the necessary parameters to execute the DeleteOptionGroup operation on AmazonRDS.

Returns:

A Java Future object containing the response from the DeleteOptionGroup 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

Reboots a previously provisioned RDS instance. This API results in the application of modified DBParameterGroup parameters with ApplyStatus of pending-reboot to the RDS instance. This action is taken as soon as possible, and results in a momentary outage to the RDS instance during which the RDS instance status is set to rebooting. If the RDS instance is configured for MultiAZ, it is possible that the reboot will be conducted through a failover. A DBInstance event is created when the reboot is completed.

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

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 .

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.

describeEngineDefaultParametersAsync

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

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.

restoreDBInstanceFromDBSnapshotAsync

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

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.

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.

deleteDBSecurityGroupAsync

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

Deletes a DB Security Group.

NOTE:The specified DB Security Group must not be associated with any DB 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.

describeOrderableDBInstanceOptionsAsync

public Future<DescribeOrderableDBInstanceOptionsResult> describeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest)
                                                                                         throws AmazonServiceException,
                                                                                                AmazonClientException

Returns a list of orderable DB Instance options for the specified engine.

Specified by:

describeOrderableDBInstanceOptionsAsync in interface AmazonRDSAsync

Parameters:

describeOrderableDBInstanceOptionsRequest - Container for the necessary parameters to execute the DescribeOrderableDBInstanceOptions operation on AmazonRDS.

Returns:

A Java Future object containing the response from the DescribeOrderableDBInstanceOptions 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.

describeReservedDBInstancesOfferingsAsync

public Future<DescribeReservedDBInstancesOfferingsResult> describeReservedDBInstancesOfferingsAsync(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest)
                                                                                             throws AmazonServiceException,
                                                                                                    AmazonClientException

Lists available reserved DB Instance offerings.

Specified by:

describeReservedDBInstancesOfferingsAsync in interface AmazonRDSAsync

Parameters:

describeReservedDBInstancesOfferingsRequest - Container for the necessary parameters to execute the DescribeReservedDBInstancesOfferings operation on AmazonRDS.

Returns:

A Java Future object containing the response from the DescribeReservedDBInstancesOfferings 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.

describeReservedDBInstancesAsync

public Future<DescribeReservedDBInstancesResult> describeReservedDBInstancesAsync(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest)
                                                                           throws AmazonServiceException,
                                                                                  AmazonClientException

Returns information about reserved DB Instances for this account, or about a specified reserved DB Instance.

Specified by:

describeReservedDBInstancesAsync in interface AmazonRDSAsync

Parameters:

describeReservedDBInstancesRequest - Container for the necessary parameters to execute the DescribeReservedDBInstances operation on AmazonRDS.

Returns:

A Java Future object containing the response from the DescribeReservedDBInstances 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.

describeDBSecurityGroupsAsync

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

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 .

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.

createDBSnapshotAsync

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

Creates 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.

describeOptionGroupOptionsAsync

public Future<DescribeOptionGroupOptionsResult> describeOptionGroupOptionsAsync(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest)
                                                                         throws AmazonServiceException,
                                                                                AmazonClientException

Describes all available options.

Specified by:

describeOptionGroupOptionsAsync in interface AmazonRDSAsync

Parameters:

describeOptionGroupOptionsRequest - Container for the necessary parameters to execute the DescribeOptionGroupOptions operation on AmazonRDS.

Returns:

A Java Future object containing the response from the DescribeOptionGroupOptions 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

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.

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.

describeOptionGroupsAsync

public Future<DescribeOptionGroupsResult> describeOptionGroupsAsync(DescribeOptionGroupsRequest describeOptionGroupsRequest)
                                                             throws AmazonServiceException,
                                                                    AmazonClientException

Describes the available option groups.

Specified by:

describeOptionGroupsAsync in interface AmazonRDSAsync

Parameters:

describeOptionGroupsRequest - Container for the necessary parameters to execute the DescribeOptionGroups operation on AmazonRDS.

Returns:

A Java Future object containing the response from the DescribeOptionGroups 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

Returns information about provisioned RDS instances. This API 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.

describeDBSnapshotsAsync

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

Returns 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.

describeDBParametersAsync

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

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.

copyDBSnapshotAsync

public Future<DBSnapshot> copyDBSnapshotAsync(CopyDBSnapshotRequest copyDBSnapshotRequest)
                                       throws AmazonServiceException,
                                              AmazonClientException

Copies the specified DBSnapshot. The source DBSnapshot must be in the "available" state.

Specified by:

copyDBSnapshotAsync in interface AmazonRDSAsync

Parameters:

copyDBSnapshotRequest - Container for the necessary parameters to execute the CopyDBSnapshot operation on AmazonRDS.

Returns:

A Java Future object containing the response from the CopyDBSnapshot 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.

createDBInstanceReadReplicaAsync

public Future<DBInstance> createDBInstanceReadReplicaAsync(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

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.

Specified by:

createDBInstanceReadReplicaAsync in interface AmazonRDSAsync

Parameters:

createDBInstanceReadReplicaRequest - Container for the necessary parameters to execute the CreateDBInstanceReadReplica operation on AmazonRDS.

Returns:

A Java Future object containing the response from the CreateDBInstanceReadReplica 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

Deletes a DBSnapshot.

NOTE: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.

createOptionGroupAsync

public Future<OptionGroup> createOptionGroupAsync(CreateOptionGroupRequest createOptionGroupRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

Creates a new Option Group.

Specified by:

createOptionGroupAsync in interface AmazonRDSAsync

Parameters:

createOptionGroupRequest - Container for the necessary parameters to execute the CreateOptionGroup operation on AmazonRDS.

Returns:

A Java Future object containing the response from the CreateOptionGroup 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.

modifyDBInstanceAsync

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

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.

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.

createDBSubnetGroupAsync

public Future<DBSubnetGroup> createDBSubnetGroupAsync(CreateDBSubnetGroupRequest createDBSubnetGroupRequest)
                                               throws AmazonServiceException,
                                                      AmazonClientException

Creates a new DB subnet group. DB subnet groups must contain at least one subnet in each AZ in the region.

Specified by:

createDBSubnetGroupAsync in interface AmazonRDSAsync

Parameters:

createDBSubnetGroupRequest - Container for the necessary parameters to execute the CreateDBSubnetGroup operation on AmazonRDS.

Returns:

A Java Future object containing the response from the CreateDBSubnetGroup 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.

modifyOptionGroupAsync

public Future<OptionGroup> modifyOptionGroupAsync(ModifyOptionGroupRequest modifyOptionGroupRequest)
                                           throws AmazonServiceException,
                                                  AmazonClientException

Modifies an existing Option Group.

Specified by:

modifyOptionGroupAsync in interface AmazonRDSAsync

Parameters:

modifyOptionGroupRequest - Container for the necessary parameters to execute the ModifyOptionGroup operation on AmazonRDS.

Returns:

A Java Future object containing the response from the ModifyOptionGroup 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.