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 MySQL, PostgreSQL, Microsoft SQL Server, Oracle, or Aurora database server. This means the code, applications, and tools you already use today with your existing 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 an interface reference for Amazon RDS. It contains documentation for a programming or command line interface you can use to manage Amazon RDS. Note that Amazon RDS is asynchronous, which means that some interfaces may require techniques such as polling or callback functions to determine when a command has been applied. In this reference, the parameter descriptions indicate whether a command is applied immediately, on the next instance reboot, or during the maintenance window. For a summary of the Amazon RDS interfaces, go to Available RDS Interfaces .
All service calls made using this new client object are blocking, and will not return until the service call completes.
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
The client configuration options controlling how this
client connects to AmazonRDS
(ex: proxy settings, retry counts, etc.).com.amazonaws.auth.DefaultAWSCredentialsProviderChain
this(new DefaultAWSCredentialsProviderChain(), clientConfiguration, Executors.newFixedThreadPool(clientConfiguration.getMaxConnections()));
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.
awsCredentials
The AWS credentials (access key ID and secret key) to use
when authenticating with AWS services.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.
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.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.
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.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.
awsCredentialsProvider
The AWS credentials provider which will provide credentials
to authenticate requests with AWS services.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.
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.publicAmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService) {
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.
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).this(awsCredentialsProvider, clientConfiguration, Executors.newFixedThreadPool(clientConfiguration.getMaxConnections()));
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.
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.Deletes a DB subnet group.
NOTE:The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroupRequest
Container for the necessary
parameters to execute the DeleteDBSubnetGroup operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<Void>deleteDBSubnetGroupAsync(final DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)
Deletes a DB subnet group.
NOTE:The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroupRequest
Container for the necessary
parameters to execute the DeleteDBSubnetGroup operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Copies the specified option group.
copyOptionGroupRequest
Container for the necessary parameters
to execute the CopyOptionGroup operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<OptionGroup>copyOptionGroupAsync(final CopyOptionGroupRequest copyOptionGroupRequest)
Copies the specified option group.
copyOptionGroupRequest
Container for the necessary parameters
to execute the CopyOptionGroup operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
restoreDBInstanceToPointInTimeRequest
Container for the
necessary parameters to execute the RestoreDBInstanceToPointInTime
operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DBInstance>restoreDBInstanceToPointInTimeAsync(final RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest)
Restores a DB instance to an arbitrary point-in-time. Users can restore to any point in time before the LatestRestorableTime for up to BackupRetentionPeriod days. The target database is created from the source database with the same configuration as the original database except that the DB instance is created with the default DB security group.
restoreDBInstanceToPointInTimeRequest
Container for the
necessary parameters to execute the RestoreDBInstanceToPointInTime
operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Copies the specified DBSnapshot. The source DBSnapshot must be in the "available" state.
copyDBSnapshotRequest
Container for the necessary parameters to
execute the CopyDBSnapshot operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DBSnapshot>copyDBSnapshotAsync(final CopyDBSnapshotRequest copyDBSnapshotRequest)
Copies the specified DBSnapshot. The source DBSnapshot must be in the "available" state.
copyDBSnapshotRequest
Container for the necessary parameters to
execute the CopyDBSnapshot operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsRequest
Container for the
necessary parameters to execute the DescribePendingMaintenanceActions
operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DescribePendingMaintenanceActionsResult>describePendingMaintenanceActionsAsync(final DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsRequest
Container for the
necessary parameters to execute the DescribePendingMaintenanceActions
operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.final AsyncHandler<DescribePendingMaintenanceActionsRequest, DescribePendingMaintenanceActionsResult> asyncHandler)
Creates a new DB instance.
createDBInstanceRequest
Container for the necessary parameters
to execute the CreateDBInstance operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DBInstance>createDBInstanceAsync(final CreateDBInstanceRequest createDBInstanceRequest)
Creates a new DB instance.
createDBInstanceRequest
Container for the necessary parameters
to execute the CreateDBInstance operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Creates a new DB security group. DB security groups control access to a DB instance.
createDBSecurityGroupRequest
Container for the necessary
parameters to execute the CreateDBSecurityGroup operation on
AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DBSecurityGroup>createDBSecurityGroupAsync(final CreateDBSecurityGroupRequest createDBSecurityGroupRequest)
Creates a new DB security group. DB security groups control access to a DB instance.
createDBSecurityGroupRequest
Container for the necessary
parameters to execute the CreateDBSecurityGroup operation on
AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Describes the available option groups.
describeOptionGroupsRequest
Container for the necessary
parameters to execute the DescribeOptionGroups operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DescribeOptionGroupsResult>describeOptionGroupsAsync(final DescribeOptionGroupsRequest describeOptionGroupsRequest)
Describes the available option groups.
describeOptionGroupsRequest
Container for the necessary
parameters to execute the DescribeOptionGroups operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Returns information about provisioned RDS instances. This API supports pagination.
describeDBInstancesRequest
Container for the necessary
parameters to execute the DescribeDBInstances operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DescribeDBInstancesResult>describeDBInstancesAsync(final DescribeDBInstancesRequest describeDBInstancesRequest)
Returns information about provisioned RDS instances. This API supports pagination.
describeDBInstancesRequest
Container for the necessary
parameters to execute the DescribeDBInstances operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Removes a source identifier from an existing RDS event notification subscription.
removeSourceIdentifierFromSubscriptionRequest
Container for the
necessary parameters to execute the
RemoveSourceIdentifierFromSubscription operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<EventSubscription>removeSourceIdentifierFromSubscriptionAsync(final RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing RDS event notification subscription.
removeSourceIdentifierFromSubscriptionRequest
Container for the
necessary parameters to execute the
RemoveSourceIdentifierFromSubscription operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.final RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest,
final AsyncHandler<RemoveSourceIdentifierFromSubscriptionRequest, EventSubscription> asyncHandler)
result = removeSourceIdentifierFromSubscription(removeSourceIdentifierFromSubscriptionRequest);
Deletes a DB security group.
NOTE:The specified DB security group must not be associated with any DB instances.
deleteDBSecurityGroupRequest
Container for the necessary
parameters to execute the DeleteDBSecurityGroup operation on
AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<Void>deleteDBSecurityGroupAsync(final DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest)
Deletes a DB security group.
NOTE:The specified DB security group must not be associated with any DB instances.
deleteDBSecurityGroupRequest
Container for the necessary
parameters to execute the DeleteDBSecurityGroup operation on
AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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 .
authorizeDBSecurityGroupIngressRequest
Container for the
necessary parameters to execute the AuthorizeDBSecurityGroupIngress
operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DBSecurityGroup>authorizeDBSecurityGroupIngressAsync(final AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest)
Enables ingress to a DBSecurityGroup using one of two forms of authorization. First, EC2 or VPC security groups can be added to the DBSecurityGroup if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet. Required parameters for this API are one of CIDR range, EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either EC2SecurityGroupName or EC2SecurityGroupId for non-VPC).
NOTE: You cannot authorize ingress from an EC2 security group in one Region to an Amazon RDS DB instance in another. You cannot authorize ingress from a VPC security group in one VPC to an Amazon RDS DB instance in another.
For an overview of CIDR ranges, go to the Wikipedia Tutorial .
authorizeDBSecurityGroupIngressRequest
Container for the
necessary parameters to execute the AuthorizeDBSecurityGroupIngress
operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Applies a pending maintenance action to a resource (for example, a DB instance).
applyPendingMaintenanceActionRequest
Container for the
necessary parameters to execute the ApplyPendingMaintenanceAction
operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<ResourcePendingMaintenanceActions>applyPendingMaintenanceActionAsync(final ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, a DB instance).
applyPendingMaintenanceActionRequest
Container for the
necessary parameters to execute the ApplyPendingMaintenanceAction
operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.final AsyncHandler<ApplyPendingMaintenanceActionRequest, ResourcePendingMaintenanceActions> asyncHandler)
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.
modifyDBInstanceRequest
Container for the necessary parameters
to execute the ModifyDBInstance operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DBInstance>modifyDBInstanceAsync(final ModifyDBInstanceRequest modifyDBInstanceRequest)
Modify settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
modifyDBInstanceRequest
Container for the necessary parameters
to execute the ModifyDBInstance operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Deletes an RDS event notification subscription.
deleteEventSubscriptionRequest
Container for the necessary
parameters to execute the DeleteEventSubscription operation on
AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<EventSubscription>deleteEventSubscriptionAsync(final DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an RDS event notification subscription.
deleteEventSubscriptionRequest
Container for the necessary
parameters to execute the DeleteEventSubscription operation on
AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources .
removeTagsFromResourceRequest
Container for the necessary
parameters to execute the RemoveTagsFromResource operation on
AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<Void>removeTagsFromResourceAsync(final RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources .
removeTagsFromResourceRequest
Container for the necessary
parameters to execute the RemoveTagsFromResource operation on
AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
describeEventCategoriesRequest
Container for the necessary
parameters to execute the DescribeEventCategories operation on
AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DescribeEventCategoriesResult>describeEventCategoriesAsync(final DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in the Events topic in the Amazon RDS User Guide.
describeEventCategoriesRequest
Container for the necessary
parameters to execute the DescribeEventCategories operation on
AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.final AsyncHandler<DescribeEventCategoriesRequest, DescribeEventCategoriesResult> asyncHandler)
Copies the specified DB parameter group.
copyDBParameterGroupRequest
Container for the necessary
parameters to execute the CopyDBParameterGroup operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DBParameterGroup>copyDBParameterGroupAsync(final CopyDBParameterGroupRequest copyDBParameterGroupRequest)
Copies the specified DB parameter group.
copyDBParameterGroupRequest
Container for the necessary
parameters to execute the CopyDBParameterGroup operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
createDBInstanceReadReplicaRequest
Container for the necessary
parameters to execute the CreateDBInstanceReadReplica operation on
AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DBInstance>createDBInstanceReadReplicaAsync(final CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest)
Creates a DB instance that acts as a Read Replica of a source DB instance.
All Read Replica DB instances are created as Single-AZ deployments with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified below.
IMPORTANT: The source DB instance must have backup retention enabled.
createDBInstanceReadReplicaRequest
Container for the necessary
parameters to execute the CreateDBInstanceReadReplica operation on
AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
NOTE:The DBSnapshot must be in the available state to be deleted.
deleteDBSnapshotRequest
Container for the necessary parameters
to execute the DeleteDBSnapshot operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DBSnapshot>deleteDBSnapshotAsync(final DeleteDBSnapshotRequest deleteDBSnapshotRequest)
Deletes a DBSnapshot. If the snapshot is being copied, the copy operation is terminated.
NOTE:The DBSnapshot must be in the available state to be deleted.
deleteDBSnapshotRequest
Container for the necessary parameters
to execute the DeleteDBSnapshot operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB 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. An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.
The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
rebootDBInstanceRequest
Container for the necessary parameters
to execute the RebootDBInstance operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DBInstance>rebootDBInstanceAsync(final RebootDBInstanceRequest rebootDBInstanceRequest)
Rebooting a DB instance restarts the database engine service. A reboot also applies to the DB instance any modifications to the associated DB parameter group that were pending. Rebooting a DB instance results in a momentary outage of the instance, during which the DB 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. An Amazon RDS event is created when the reboot is completed.
If your DB instance is deployed in multiple Availability Zones, you can force a failover from one AZ to the other during the reboot. You might force a failover to test the availability of your DB instance deployment or to restore operations to the original AZ after a failover occurs.
The time required to reboot is a function of the specific database engine's crash recovery process. To improve the reboot time, we recommend that you reduce database activities as much as possible during the reboot process to reduce rollback activity for in-transit transactions.
rebootDBInstanceRequest
Container for the necessary parameters
to execute the RebootDBInstance operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.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.
describeEventsRequest
Container for the necessary parameters to
execute the DescribeEvents operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DescribeEventsResult>describeEventsAsync(final DescribeEventsRequest describeEventsRequest)
Returns events related to DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. Events specific to a particular DB instance, DB security group, database snapshot, or DB parameter group can be obtained by providing the name as a parameter. By default, the past hour of events are returned.
describeEventsRequest
Container for the necessary parameters to
execute the DescribeEvents operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources .
listTagsForResourceRequest
Container for the necessary
parameters to execute the ListTagsForResource operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<ListTagsForResourceResult>listTagsForResourceAsync(final ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an Amazon RDS resource.
For an overview on tagging an Amazon RDS resource, see Tagging Amazon RDS Resources .
listTagsForResourceRequest
Container for the necessary
parameters to execute the ListTagsForResource operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Describes all available options.
describeOptionGroupOptionsRequest
Container for the necessary
parameters to execute the DescribeOptionGroupOptions operation on
AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DescribeOptionGroupOptionsResult>describeOptionGroupOptionsAsync(final DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest)
Describes all available options.
describeOptionGroupOptionsRequest
Container for the necessary
parameters to execute the DescribeOptionGroupOptions operation on
AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.final AsyncHandler<DescribeOptionGroupOptionsRequest, DescribeOptionGroupOptionsResult> asyncHandler)
Returns the detailed parameter list for a particular DB parameter group.
describeDBParametersRequest
Container for the necessary
parameters to execute the DescribeDBParameters operation on AmazonRDS.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.public Future<DescribeDBParametersResult>describeDBParametersAsync(final DescribeDBParametersRequest describeDBParametersRequest)
Returns the detailed parameter list for a particular DB parameter group.
describeDBParametersRequest
Container for the necessary
parameters to execute the DescribeDBParameters operation on AmazonRDS.asyncHandler
Asynchronous callback handler for events in the
life-cycle of the request. Users could provide the implementation of
the four callback methods in this interface to process the operation
result or handle the exception.com.amazonaws.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.com.amazonaws.AmazonServiceException
If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.