public interface AmazonRDSAsync extends AmazonRDS
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, resizeable 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, MariaDB, PostgreSQL, Microsoft SQL Server, Oracle, or Amazon Aurora database server. These capabilities mean that 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 interface reference for Amazon RDS 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 might 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. The reference structure is as follows, and we list following some related topics from the user guide.
Amazon RDS API Reference
For the alphabetical list of API actions, see API Actions .
For the alphabetical list of data types, see Data Types .
For a list of common query parameters, see Common Parameters .
For descriptions of the error codes, see Common Errors .
Amazon RDS User Guide
For a summary of the Amazon RDS interfaces, see Available RDS Interfaces .
For more information about how to use the Query API, see Using the Query API .
addSourceIdentifierToSubscription, addTagsToResource, applyPendingMaintenanceAction, authorizeDBSecurityGroupIngress, copyDBClusterSnapshot, copyDBParameterGroup, copyDBSnapshot, copyOptionGroup, createDBCluster, createDBClusterParameterGroup, createDBClusterSnapshot, createDBInstance, createDBInstanceReadReplica, createDBParameterGroup, createDBSecurityGroup, createDBSnapshot, createDBSubnetGroup, createEventSubscription, createOptionGroup, deleteDBCluster, deleteDBClusterParameterGroup, deleteDBClusterSnapshot, deleteDBInstance, deleteDBParameterGroup, deleteDBSecurityGroup, deleteDBSnapshot, deleteDBSubnetGroup, deleteEventSubscription, deleteOptionGroup, describeAccountAttributes, describeAccountAttributes, describeCertificates, describeCertificates, describeDBClusterParameterGroups, describeDBClusterParameterGroups, describeDBClusterParameters, describeDBClusters, describeDBClusters, describeDBClusterSnapshots, describeDBClusterSnapshots, describeDBEngineVersions, describeDBEngineVersions, describeDBInstances, describeDBInstances, describeDBLogFiles, describeDBParameterGroups, describeDBParameterGroups, describeDBParameters, describeDBSecurityGroups, describeDBSecurityGroups, describeDBSnapshotAttributes, describeDBSnapshotAttributes, describeDBSnapshots, describeDBSnapshots, describeDBSubnetGroups, describeDBSubnetGroups, describeEngineDefaultClusterParameters, describeEngineDefaultParameters, describeEventCategories, describeEventCategories, describeEvents, describeEvents, describeEventSubscriptions, describeEventSubscriptions, describeOptionGroupOptions, describeOptionGroups, describeOptionGroups, describeOrderableDBInstanceOptions, describePendingMaintenanceActions, describePendingMaintenanceActions, describeReservedDBInstances, describeReservedDBInstances, describeReservedDBInstancesOfferings, describeReservedDBInstancesOfferings, downloadDBLogFilePortion, failoverDBCluster, failoverDBCluster, getCachedResponseMetadata, listTagsForResource, modifyDBCluster, modifyDBClusterParameterGroup, modifyDBInstance, modifyDBParameterGroup, modifyDBSnapshotAttribute, modifyDBSubnetGroup, modifyEventSubscription, modifyOptionGroup, promoteReadReplica, purchaseReservedDBInstancesOffering, rebootDBInstance, removeSourceIdentifierFromSubscription, removeTagsFromResource, resetDBClusterParameterGroup, resetDBParameterGroup, restoreDBClusterFromSnapshot, restoreDBClusterToPointInTime, restoreDBInstanceFromDBSnapshot, restoreDBInstanceToPointInTime, revokeDBSecurityGroupIngress, setEndpoint, setRegion, shutdown
Future<OptionGroup> copyOptionGroupAsync(CopyOptionGroupRequest copyOptionGroupRequest) throws AmazonServiceException, AmazonClientException
Copies the specified option group.
copyOptionGroupRequest
- Container for the necessary parameters
to execute the CopyOptionGroup operation on AmazonRDS.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.Future<OptionGroup> copyOptionGroupAsync(CopyOptionGroupRequest copyOptionGroupRequest, AsyncHandler<CopyOptionGroupRequest,OptionGroup> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.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.
deleteDBSubnetGroupRequest
- Container for the necessary
parameters to execute the DeleteDBSubnetGroup operation on AmazonRDS.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.Future<Void> deleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest, AsyncHandler<DeleteDBSubnetGroupRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<DBInstance> restoreDBInstanceToPointInTimeAsync(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest) throws AmazonServiceException, AmazonClientException
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
restoreDBInstanceToPointInTimeRequest
- Container for the
necessary parameters to execute the RestoreDBInstanceToPointInTime
operation on AmazonRDS.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.Future<DBInstance> restoreDBInstanceToPointInTimeAsync(RestoreDBInstanceToPointInTimeRequest restoreDBInstanceToPointInTimeRequest, AsyncHandler<RestoreDBInstanceToPointInTimeRequest,DBInstance> asyncHandler) throws AmazonServiceException, AmazonClientException
Restores a DB instance to an arbitrary point in time. You can restore to any point in time before the time identified by the LatestRestorableTime property. You can restore to a point up to the number of days specified by the BackupRetentionPeriod property.
The target database is created with most of the original configuration, but in a system-selected availability zone, with the default security group, the default subnet group, and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored deployment and not a single-AZ deployment.
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.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.Future<DescribePendingMaintenanceActionsResult> describePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) throws AmazonServiceException, AmazonClientException
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.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.Future<DescribePendingMaintenanceActionsResult> describePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest, AsyncHandler<DescribePendingMaintenanceActionsRequest,DescribePendingMaintenanceActionsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<DBSnapshot> copyDBSnapshotAsync(CopyDBSnapshotRequest copyDBSnapshotRequest) throws AmazonServiceException, AmazonClientException
Copies the specified DB snapshot. The source DB snapshot must be in the "available" state.
If you are copying from a shared manual DB snapshot, the
SourceDBSnapshotIdentifier
must be the ARN of the shared
DB snapshot.
copyDBSnapshotRequest
- Container for the necessary parameters to
execute the CopyDBSnapshot operation on AmazonRDS.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.Future<DBSnapshot> copyDBSnapshotAsync(CopyDBSnapshotRequest copyDBSnapshotRequest, AsyncHandler<CopyDBSnapshotRequest,DBSnapshot> asyncHandler) throws AmazonServiceException, AmazonClientException
Copies the specified DB snapshot. The source DB snapshot must be in the "available" state.
If you are copying from a shared manual DB snapshot, the
SourceDBSnapshotIdentifier
must be the ARN of the shared
DB snapshot.
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.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.Future<DescribeOptionGroupsResult> describeOptionGroupsAsync(DescribeOptionGroupsRequest describeOptionGroupsRequest) throws AmazonServiceException, AmazonClientException
Describes the available option groups.
describeOptionGroupsRequest
- Container for the necessary
parameters to execute the DescribeOptionGroups operation on AmazonRDS.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.Future<DescribeOptionGroupsResult> describeOptionGroupsAsync(DescribeOptionGroupsRequest describeOptionGroupsRequest, AsyncHandler<DescribeOptionGroupsRequest,DescribeOptionGroupsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<DBSecurityGroup> createDBSecurityGroupAsync(CreateDBSecurityGroupRequest createDBSecurityGroupRequest) throws AmazonServiceException, AmazonClientException
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.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.Future<DBSecurityGroup> createDBSecurityGroupAsync(CreateDBSecurityGroupRequest createDBSecurityGroupRequest, AsyncHandler<CreateDBSecurityGroupRequest,DBSecurityGroup> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest createDBInstanceRequest) throws AmazonServiceException, AmazonClientException
Creates a new DB instance.
createDBInstanceRequest
- Container for the necessary parameters
to execute the CreateDBInstance operation on AmazonRDS.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.Future<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest createDBInstanceRequest, AsyncHandler<CreateDBInstanceRequest,DBInstance> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<DescribeDBInstancesResult> describeDBInstancesAsync(DescribeDBInstancesRequest describeDBInstancesRequest) throws AmazonServiceException, AmazonClientException
Returns information about provisioned RDS instances. This API supports pagination.
describeDBInstancesRequest
- Container for the necessary
parameters to execute the DescribeDBInstances operation on AmazonRDS.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.Future<DescribeDBInstancesResult> describeDBInstancesAsync(DescribeDBInstancesRequest describeDBInstancesRequest, AsyncHandler<DescribeDBInstancesRequest,DescribeDBInstancesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<EventSubscription> removeSourceIdentifierFromSubscriptionAsync(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Removes a source identifier from an existing RDS event notification subscription.
removeSourceIdentifierFromSubscriptionRequest
- Container for the
necessary parameters to execute the
RemoveSourceIdentifierFromSubscription operation on AmazonRDS.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.Future<EventSubscription> removeSourceIdentifierFromSubscriptionAsync(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest, AsyncHandler<RemoveSourceIdentifierFromSubscriptionRequest,EventSubscription> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.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.
deleteDBSecurityGroupRequest
- Container for the necessary
parameters to execute the DeleteDBSecurityGroup operation on
AmazonRDS.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.Future<Void> deleteDBSecurityGroupAsync(DeleteDBSecurityGroupRequest deleteDBSecurityGroupRequest, AsyncHandler<DeleteDBSecurityGroupRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<DescribeDBClusterParameterGroupsResult> describeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of DBClusterParameterGroup
descriptions.
If a DBClusterParameterGroupName
parameter is specified,
the list will contain only the description of the specified DB cluster
parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClusterParameterGroupsRequest
- Container for the
necessary parameters to execute the DescribeDBClusterParameterGroups
operation on AmazonRDS.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.Future<DescribeDBClusterParameterGroupsResult> describeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest, AsyncHandler<DescribeDBClusterParameterGroupsRequest,DescribeDBClusterParameterGroupsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of DBClusterParameterGroup
descriptions.
If a DBClusterParameterGroupName
parameter is specified,
the list will contain only the description of the specified DB cluster
parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClusterParameterGroupsRequest
- Container for the
necessary parameters to execute the DescribeDBClusterParameterGroups
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.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.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 .
authorizeDBSecurityGroupIngressRequest
- Container for the
necessary parameters to execute the AuthorizeDBSecurityGroupIngress
operation on AmazonRDS.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.Future<DBSecurityGroup> authorizeDBSecurityGroupIngressAsync(AuthorizeDBSecurityGroupIngressRequest authorizeDBSecurityGroupIngressRequest, AsyncHandler<AuthorizeDBSecurityGroupIngressRequest,DBSecurityGroup> asyncHandler) 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 .
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.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.Future<DBSnapshotAttributesResult> describeDBSnapshotAttributesAsync(DescribeDBSnapshotAttributesRequest describeDBSnapshotAttributesRequest) throws AmazonServiceException, AmazonClientException
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other AWS accounts,
DescribeDBSnapshotAttributes
returns the
restore
attribute and a list of the AWS account ids that
are authorized to copy or restore the manual DB snapshot. If
all
is included in the list of values for the
restore
attribute, then the manual DB snapshot is public
and can be copied or restored by all AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API.
describeDBSnapshotAttributesRequest
- Container for the necessary
parameters to execute the DescribeDBSnapshotAttributes operation on
AmazonRDS.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.Future<DBSnapshotAttributesResult> describeDBSnapshotAttributesAsync(DescribeDBSnapshotAttributesRequest describeDBSnapshotAttributesRequest, AsyncHandler<DescribeDBSnapshotAttributesRequest,DBSnapshotAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other AWS accounts,
DescribeDBSnapshotAttributes
returns the
restore
attribute and a list of the AWS account ids that
are authorized to copy or restore the manual DB snapshot. If
all
is included in the list of values for the
restore
attribute, then the manual DB snapshot is public
and can be copied or restored by all AWS accounts.
To add or remove access for an AWS account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API.
describeDBSnapshotAttributesRequest
- Container for the necessary
parameters to execute the DescribeDBSnapshotAttributes 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.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.Future<DBClusterParameterGroup> createDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
IMPORTANT: After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
createDBClusterParameterGroupRequest
- Container for the
necessary parameters to execute the CreateDBClusterParameterGroup
operation on AmazonRDS.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.Future<DBClusterParameterGroup> createDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest, AsyncHandler<CreateDBClusterParameterGroupRequest,DBClusterParameterGroup> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a new DB cluster parameter group.
Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster.
A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running DB cluster, you need to reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
IMPORTANT: After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
createDBClusterParameterGroupRequest
- Container for the
necessary parameters to execute the CreateDBClusterParameterGroup
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.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.Future<ResourcePendingMaintenanceActions> applyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) throws AmazonServiceException, AmazonClientException
Applies a pending maintenance action to a resource (for example, to a DB instance).
applyPendingMaintenanceActionRequest
- Container for the
necessary parameters to execute the ApplyPendingMaintenanceAction
operation on AmazonRDS.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.Future<ResourcePendingMaintenanceActions> applyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest, AsyncHandler<ApplyPendingMaintenanceActionRequest,ResourcePendingMaintenanceActions> asyncHandler) throws AmazonServiceException, AmazonClientException
Applies a pending maintenance action to a resource (for example, to 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.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.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.
modifyDBInstanceRequest
- Container for the necessary parameters
to execute the ModifyDBInstance operation on AmazonRDS.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.Future<DBInstance> modifyDBInstanceAsync(ModifyDBInstanceRequest modifyDBInstanceRequest, AsyncHandler<ModifyDBInstanceRequest,DBInstance> asyncHandler) 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.
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.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.Future<EventSubscription> deleteEventSubscriptionAsync(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Deletes an RDS event notification subscription.
deleteEventSubscriptionRequest
- Container for the necessary
parameters to execute the DeleteEventSubscription operation on
AmazonRDS.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.Future<EventSubscription> deleteEventSubscriptionAsync(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest, AsyncHandler<DeleteEventSubscriptionRequest,EventSubscription> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<DescribeDBClusterSnapshotsResult> describeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest) throws AmazonServiceException, AmazonClientException
Returns information about DB cluster snapshots. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClusterSnapshotsRequest
- Container for the necessary
parameters to execute the DescribeDBClusterSnapshots operation on
AmazonRDS.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.Future<DescribeDBClusterSnapshotsResult> describeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest, AsyncHandler<DescribeDBClusterSnapshotsRequest,DescribeDBClusterSnapshotsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns information about DB cluster snapshots. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClusterSnapshotsRequest
- Container for the necessary
parameters to execute the DescribeDBClusterSnapshots 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.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.Future<DescribeDBClusterParametersResult> describeDBClusterParametersAsync(DescribeDBClusterParametersRequest describeDBClusterParametersRequest) throws AmazonServiceException, AmazonClientException
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClusterParametersRequest
- Container for the necessary
parameters to execute the DescribeDBClusterParameters operation on
AmazonRDS.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.Future<DescribeDBClusterParametersResult> describeDBClusterParametersAsync(DescribeDBClusterParametersRequest describeDBClusterParametersRequest, AsyncHandler<DescribeDBClusterParametersRequest,DescribeDBClusterParametersResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClusterParametersRequest
- Container for the necessary
parameters to execute the DescribeDBClusterParameters 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.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.Future<Void> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) throws AmazonServiceException, AmazonClientException
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.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.Future<Void> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest removeTagsFromResourceRequest, AsyncHandler<RemoveTagsFromResourceRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<DBSnapshotAttributesResult> modifyDBSnapshotAttributeAsync(ModifyDBSnapshotAttributeRequest modifyDBSnapshotAttributeRequest) throws AmazonServiceException, AmazonClientException
Adds an attribute and values to, or removes an attribute and values from a manual DB snapshot.
To share a manual DB snapshot with other AWS accounts, specify
restore
as the AttributeName
and use the
ValuesToAdd
parameter to add a list of the AWS account
ids that are authorized to restore the manual DB snapshot. Uses the
value all
to make the manual DB snapshot public and can
by copied or restored by all AWS accounts. Do not add the
all
value for any manual DB snapshots that contain
private information that you do not want to be available to all AWS
accounts.
To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API.
If the manual DB snapshot is encrypted, it cannot be shared.
modifyDBSnapshotAttributeRequest
- Container for the necessary
parameters to execute the ModifyDBSnapshotAttribute operation on
AmazonRDS.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.Future<DBSnapshotAttributesResult> modifyDBSnapshotAttributeAsync(ModifyDBSnapshotAttributeRequest modifyDBSnapshotAttributeRequest, AsyncHandler<ModifyDBSnapshotAttributeRequest,DBSnapshotAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Adds an attribute and values to, or removes an attribute and values from a manual DB snapshot.
To share a manual DB snapshot with other AWS accounts, specify
restore
as the AttributeName
and use the
ValuesToAdd
parameter to add a list of the AWS account
ids that are authorized to restore the manual DB snapshot. Uses the
value all
to make the manual DB snapshot public and can
by copied or restored by all AWS accounts. Do not add the
all
value for any manual DB snapshots that contain
private information that you do not want to be available to all AWS
accounts.
To view which AWS accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API.
If the manual DB snapshot is encrypted, it cannot be shared.
modifyDBSnapshotAttributeRequest
- Container for the necessary
parameters to execute the ModifyDBSnapshotAttribute 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.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.Future<DescribeEventCategoriesResult> describeEventCategoriesAsync(DescribeEventCategoriesRequest describeEventCategoriesRequest) throws AmazonServiceException, AmazonClientException
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.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.Future<DescribeEventCategoriesResult> describeEventCategoriesAsync(DescribeEventCategoriesRequest describeEventCategoriesRequest, AsyncHandler<DescribeEventCategoriesRequest,DescribeEventCategoriesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<DBParameterGroup> copyDBParameterGroupAsync(CopyDBParameterGroupRequest copyDBParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Copies the specified DB parameter group.
copyDBParameterGroupRequest
- Container for the necessary
parameters to execute the CopyDBParameterGroup operation on AmazonRDS.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.Future<DBParameterGroup> copyDBParameterGroupAsync(CopyDBParameterGroupRequest copyDBParameterGroupRequest, AsyncHandler<CopyDBParameterGroupRequest,DBParameterGroup> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<DBCluster> restoreDBClusterFromSnapshotAsync(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest) throws AmazonServiceException, AmazonClientException
Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
restoreDBClusterFromSnapshotRequest
- Container for the necessary
parameters to execute the RestoreDBClusterFromSnapshot operation on
AmazonRDS.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.Future<DBCluster> restoreDBClusterFromSnapshotAsync(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest, AsyncHandler<RestoreDBClusterFromSnapshotRequest,DBCluster> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a new DB cluster from a DB cluster snapshot. The target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
restoreDBClusterFromSnapshotRequest
- Container for the necessary
parameters to execute the RestoreDBClusterFromSnapshot 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.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.Future<DescribeDBClustersResult> describeDBClustersAsync(DescribeDBClustersRequest describeDBClustersRequest) throws AmazonServiceException, AmazonClientException
Returns information about provisioned Aurora DB clusters. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClustersRequest
- Container for the necessary
parameters to execute the DescribeDBClusters operation on AmazonRDS.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.Future<DescribeDBClustersResult> describeDBClustersAsync(DescribeDBClustersRequest describeDBClustersRequest, AsyncHandler<DescribeDBClustersRequest,DescribeDBClustersResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns information about provisioned Aurora DB clusters. This API supports pagination.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
describeDBClustersRequest
- Container for the necessary
parameters to execute the DescribeDBClusters 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.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.Future<DBInstance> rebootDBInstanceAsync(RebootDBInstanceRequest rebootDBInstanceRequest) throws AmazonServiceException, AmazonClientException
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.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.Future<DBInstance> rebootDBInstanceAsync(RebootDBInstanceRequest rebootDBInstanceRequest, AsyncHandler<RebootDBInstanceRequest,DBInstance> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<DBInstance> createDBInstanceReadReplicaAsync(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest) throws AmazonServiceException, AmazonClientException
Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL 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.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.Future<DBInstance> createDBInstanceReadReplicaAsync(CreateDBInstanceReadReplicaRequest createDBInstanceReadReplicaRequest, AsyncHandler<CreateDBInstanceReadReplicaRequest,DBInstance> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a DB instance for a DB instance running MySQL, MariaDB, or PostgreSQL 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.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.Future<DBSnapshot> deleteDBSnapshotAsync(DeleteDBSnapshotRequest deleteDBSnapshotRequest) throws AmazonServiceException, AmazonClientException
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.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.Future<DBSnapshot> deleteDBSnapshotAsync(DeleteDBSnapshotRequest deleteDBSnapshotRequest, AsyncHandler<DeleteDBSnapshotRequest,DBSnapshot> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.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.
describeEventsRequest
- Container for the necessary parameters to
execute the DescribeEvents operation on AmazonRDS.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.Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest describeEventsRequest, AsyncHandler<DescribeEventsRequest,DescribeEventsResult> asyncHandler) 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.
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.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.Future<DBCluster> deleteDBClusterAsync(DeleteDBClusterRequest deleteDBClusterRequest) throws AmazonServiceException, AmazonClientException
The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful response from the web service indicates the request was received correctly. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
deleteDBClusterRequest
- Container for the necessary parameters
to execute the DeleteDBCluster operation on AmazonRDS.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.Future<DBCluster> deleteDBClusterAsync(DeleteDBClusterRequest deleteDBClusterRequest, AsyncHandler<DeleteDBClusterRequest,DBCluster> asyncHandler) throws AmazonServiceException, AmazonClientException
The DeleteDBCluster action deletes a previously provisioned DB cluster. A successful response from the web service indicates the request was received correctly. When you delete a DB cluster, all automated backups for that DB cluster are deleted and cannot be recovered. Manual DB cluster snapshots of the DB cluster to be deleted are not deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
deleteDBClusterRequest
- Container for the necessary parameters
to execute the DeleteDBCluster 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.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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest) throws AmazonServiceException, AmazonClientException
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.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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<DescribeOptionGroupOptionsResult> describeOptionGroupOptionsAsync(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest) throws AmazonServiceException, AmazonClientException
Describes all available options.
describeOptionGroupOptionsRequest
- Container for the necessary
parameters to execute the DescribeOptionGroupOptions operation on
AmazonRDS.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.Future<DescribeOptionGroupOptionsResult> describeOptionGroupOptionsAsync(DescribeOptionGroupOptionsRequest describeOptionGroupOptionsRequest, AsyncHandler<DescribeOptionGroupOptionsRequest,DescribeOptionGroupOptionsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<DescribeDBParametersResult> describeDBParametersAsync(DescribeDBParametersRequest describeDBParametersRequest) throws AmazonServiceException, AmazonClientException
Returns the detailed parameter list for a particular DB parameter group.
describeDBParametersRequest
- Container for the necessary
parameters to execute the DescribeDBParameters operation on AmazonRDS.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.Future<DescribeDBParametersResult> describeDBParametersAsync(DescribeDBParametersRequest describeDBParametersRequest, AsyncHandler<DescribeDBParametersRequest,DescribeDBParametersResult> asyncHandler) throws AmazonServiceException, AmazonClientException
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.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.Future<ModifyDBClusterParameterGroupResult> modifyDBClusterParameterGroupAsync(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies the parameters of a DB cluster parameter group. 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.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
NOTE: Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
IMPORTANT: After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
modifyDBClusterParameterGroupRequest
- Container for the
necessary parameters to execute the ModifyDBClusterParameterGroup
operation on AmazonRDS.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.Future<ModifyDBClusterParameterGroupResult> modifyDBClusterParameterGroupAsync(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest, AsyncHandler<ModifyDBClusterParameterGroupRequest,ModifyDBClusterParameterGroupResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Modifies the parameters of a DB cluster parameter group. 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.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
NOTE: Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB cluster associated with the parameter group before the change can take effect.
IMPORTANT: After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBClusterParameters command to verify that your DB cluster parameter group has been created or modified.
modifyDBClusterParameterGroupRequest
- Container for the
necessary parameters to execute the ModifyDBClusterParameterGroup
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.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.Future<DBCluster> restoreDBClusterToPointInTimeAsync(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest) throws AmazonServiceException, AmazonClientException
Restores a DB cluster to an arbitrary point in time. Users can
restore to any point in time before LatestRestorableTime
for up to BackupRetentionPeriod
days. The target DB
cluster is created from the source DB cluster with the same
configuration as the original DB cluster, except that the new DB
cluster is created with the default DB security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
restoreDBClusterToPointInTimeRequest
- Container for the
necessary parameters to execute the RestoreDBClusterToPointInTime
operation on AmazonRDS.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.Future<DBCluster> restoreDBClusterToPointInTimeAsync(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest, AsyncHandler<RestoreDBClusterToPointInTimeRequest,DBCluster> asyncHandler) throws AmazonServiceException, AmazonClientException
Restores a DB cluster to an arbitrary point in time. Users can
restore to any point in time before LatestRestorableTime
for up to BackupRetentionPeriod
days. The target DB
cluster is created from the source DB cluster with the same
configuration as the original DB cluster, except that the new DB
cluster is created with the default DB security group.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
restoreDBClusterToPointInTimeRequest
- Container for the
necessary parameters to execute the RestoreDBClusterToPointInTime
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.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.Future<ReservedDBInstance> purchaseReservedDBInstancesOfferingAsync(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest) throws AmazonServiceException, AmazonClientException
Purchases a reserved DB instance offering.
purchaseReservedDBInstancesOfferingRequest
- Container for the
necessary parameters to execute the
PurchaseReservedDBInstancesOffering operation on AmazonRDS.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.Future<ReservedDBInstance> purchaseReservedDBInstancesOfferingAsync(PurchaseReservedDBInstancesOfferingRequest purchaseReservedDBInstancesOfferingRequest, AsyncHandler<PurchaseReservedDBInstancesOfferingRequest,ReservedDBInstance> asyncHandler) throws AmazonServiceException, AmazonClientException
Purchases a reserved DB instance offering.
purchaseReservedDBInstancesOfferingRequest
- Container for the
necessary parameters to execute the
PurchaseReservedDBInstancesOffering 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.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.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 DB security group.
describeDBSecurityGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBSecurityGroups operation on
AmazonRDS.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.Future<DescribeDBSecurityGroupsResult> describeDBSecurityGroupsAsync(DescribeDBSecurityGroupsRequest describeDBSecurityGroupsRequest, AsyncHandler<DescribeDBSecurityGroupsRequest,DescribeDBSecurityGroupsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of DBSecurityGroup
descriptions. If a
DBSecurityGroupName
is specified, the list will contain
only the descriptions of the specified DB security group.
describeDBSecurityGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBSecurityGroups 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.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.Future<EventSubscription> modifyEventSubscriptionAsync(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
modifyEventSubscriptionRequest
- Container for the necessary
parameters to execute the ModifyEventSubscription operation on
AmazonRDS.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.Future<EventSubscription> modifyEventSubscriptionAsync(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest, AsyncHandler<ModifyEventSubscriptionRequest,EventSubscription> asyncHandler) throws AmazonServiceException, AmazonClientException
Modifies an existing RDS event notification subscription. Note that you cannot modify the source identifiers using this call; to change source identifiers for a subscription, use the AddSourceIdentifierToSubscription and RemoveSourceIdentifierFromSubscription calls.
You can see a list of the event categories for a given SourceType in the Events topic in the Amazon RDS User Guide or by using the DescribeEventCategories action.
modifyEventSubscriptionRequest
- Container for the necessary
parameters to execute the ModifyEventSubscription 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.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.Future<DBInstance> deleteDBInstanceAsync(DeleteDBInstanceRequest deleteDBInstanceRequest) throws AmazonServiceException, AmazonClientException
The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.
If a final DB snapshot is requested the status of the RDS instance
will be "deleting" until the DB snapshot is created. The API action
DescribeDBInstance
is used to monitor the status of this
operation. The action cannot be canceled or reverted once submitted.
Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".
deleteDBInstanceRequest
- Container for the necessary parameters
to execute the DeleteDBInstance operation on AmazonRDS.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.Future<DBInstance> deleteDBInstanceAsync(DeleteDBInstanceRequest deleteDBInstanceRequest, AsyncHandler<DeleteDBInstanceRequest,DBInstance> asyncHandler) throws AmazonServiceException, AmazonClientException
The DeleteDBInstance action deletes a previously provisioned DB instance. A successful response from the web service indicates the request was received correctly. When you delete a DB instance, all automated backups for that instance are deleted and cannot be recovered. Manual DB snapshots of the DB instance to be deleted are not deleted.
If a final DB snapshot is requested the status of the RDS instance
will be "deleting" until the DB snapshot is created. The API action
DescribeDBInstance
is used to monitor the status of this
operation. The action cannot be canceled or reverted once submitted.
Note that when a DB instance is in a failure state and has a status of 'failed', 'incompatible-restore', or 'incompatible-network', it can only be deleted when the SkipFinalSnapshot parameter is set to "true".
deleteDBInstanceRequest
- Container for the necessary parameters
to execute the DeleteDBInstance 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.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.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 most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB
snapshot.
restoreDBInstanceFromDBSnapshotRequest
- Container for the
necessary parameters to execute the RestoreDBInstanceFromDBSnapshot
operation on AmazonRDS.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.Future<DBInstance> restoreDBInstanceFromDBSnapshotAsync(RestoreDBInstanceFromDBSnapshotRequest restoreDBInstanceFromDBSnapshotRequest, AsyncHandler<RestoreDBInstanceFromDBSnapshotRequest,DBInstance> asyncHandler) 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 most of original configuration with the default security group and the default DB parameter group. By default, the new DB instance is created as a single-AZ deployment except when the instance is a SQL Server instance that has an option group that is associated with mirroring; in this case, the instance becomes a mirrored AZ deployment and not a single-AZ deployment.
If your intent is to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS does not allow two DB instances with the same name. Once you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you will replace the original DB instance with the DB instance created from the snapshot.
If you are restoring from a shared manual DB snapshot, the
DBSnapshotIdentifier
must be the ARN of the shared DB
snapshot.
restoreDBInstanceFromDBSnapshotRequest
- Container for the
necessary parameters to execute the RestoreDBInstanceFromDBSnapshot
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.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.Future<OptionGroup> createOptionGroupAsync(CreateOptionGroupRequest createOptionGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new option group. You can create up to 20 option groups.
createOptionGroupRequest
- Container for the necessary parameters
to execute the CreateOptionGroup operation on AmazonRDS.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.Future<OptionGroup> createOptionGroupAsync(CreateOptionGroupRequest createOptionGroupRequest, AsyncHandler<CreateOptionGroupRequest,OptionGroup> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a new option group. You can create up to 20 option groups.
createOptionGroupRequest
- Container for the necessary parameters
to execute the CreateOptionGroup 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.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.Future<OptionGroup> modifyOptionGroupAsync(ModifyOptionGroupRequest modifyOptionGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies an existing option group.
modifyOptionGroupRequest
- Container for the necessary parameters
to execute the ModifyOptionGroup operation on AmazonRDS.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.Future<OptionGroup> modifyOptionGroupAsync(ModifyOptionGroupRequest modifyOptionGroupRequest, AsyncHandler<ModifyOptionGroupRequest,OptionGroup> asyncHandler) throws AmazonServiceException, AmazonClientException
Modifies an existing option group.
modifyOptionGroupRequest
- Container for the necessary parameters
to execute the ModifyOptionGroup 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.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.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 .
describeDBSubnetGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBSubnetGroups operation on
AmazonRDS.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.Future<DescribeDBSubnetGroupsResult> describeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest, AsyncHandler<DescribeDBSubnetGroupsRequest,DescribeDBSubnetGroupsResult> asyncHandler) 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 .
describeDBSubnetGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBSubnetGroups 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.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.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 DB parameter group.
describeDBParameterGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBParameterGroups operation on
AmazonRDS.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.Future<DescribeDBParameterGroupsResult> describeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest describeDBParameterGroupsRequest, AsyncHandler<DescribeDBParameterGroupsRequest,DescribeDBParameterGroupsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of DBParameterGroup
descriptions. If a
DBParameterGroupName
is specified, the list will contain
only the description of the specified DB parameter group.
describeDBParameterGroupsRequest
- Container for the necessary
parameters to execute the DescribeDBParameterGroups 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.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.Future<DescribeEventSubscriptionsResult> describeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest) throws AmazonServiceException, AmazonClientException
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
describeEventSubscriptionsRequest
- Container for the necessary
parameters to execute the DescribeEventSubscriptions operation on
AmazonRDS.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.Future<DescribeEventSubscriptionsResult> describeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest, AsyncHandler<DescribeEventSubscriptionsRequest,DescribeEventSubscriptionsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists all the subscription descriptions for a customer account. The description for a subscription includes SubscriptionName, SNSTopicARN, CustomerID, SourceType, SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
describeEventSubscriptionsRequest
- Container for the necessary
parameters to execute the DescribeEventSubscriptions 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.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.Future<DBSubnetGroup> modifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
modifyDBSubnetGroupRequest
- Container for the necessary
parameters to execute the ModifyDBSubnetGroup operation on AmazonRDS.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.Future<DBSubnetGroup> modifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest, AsyncHandler<ModifyDBSubnetGroupRequest,DBSubnetGroup> asyncHandler) throws AmazonServiceException, AmazonClientException
Modifies an existing DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
modifyDBSubnetGroupRequest
- Container for the necessary
parameters to execute the ModifyDBSubnetGroup 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.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.Future<EngineDefaults> describeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) throws AmazonServiceException, AmazonClientException
Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
describeEngineDefaultClusterParametersRequest
- Container for the
necessary parameters to execute the
DescribeEngineDefaultClusterParameters operation on AmazonRDS.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.Future<EngineDefaults> describeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest, AsyncHandler<DescribeEngineDefaultClusterParametersRequest,EngineDefaults> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
describeEngineDefaultClusterParametersRequest
- Container for the
necessary parameters to execute the
DescribeEngineDefaultClusterParameters 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.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.Future<DBCluster> createDBClusterAsync(CreateDBClusterRequest createDBClusterRequest) throws AmazonServiceException, AmazonClientException
Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
createDBClusterRequest
- Container for the necessary parameters
to execute the CreateDBCluster operation on AmazonRDS.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.Future<DBCluster> createDBClusterAsync(CreateDBClusterRequest createDBClusterRequest, AsyncHandler<CreateDBClusterRequest,DBCluster> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a new Amazon Aurora DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
createDBClusterRequest
- Container for the necessary parameters
to execute the CreateDBCluster 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.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.Future<ResetDBClusterParameterGroupResult> resetDBClusterParameterGroupAsync(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies the parameters of a DB cluster parameter group to the
default value. To reset specific parameters submit a list of the
following: ParameterName
and ApplyMethod
.
To reset the entire DB cluster parameter group, specify the
DBClusterParameterGroupName
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. You must call RebootDBInstance
for every DB instance in your DB cluster that you want the updated
static parameter to apply to.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
resetDBClusterParameterGroupRequest
- Container for the necessary
parameters to execute the ResetDBClusterParameterGroup operation on
AmazonRDS.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.Future<ResetDBClusterParameterGroupResult> resetDBClusterParameterGroupAsync(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest, AsyncHandler<ResetDBClusterParameterGroupRequest,ResetDBClusterParameterGroupResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Modifies the parameters of a DB cluster parameter group to the
default value. To reset specific parameters submit a list of the
following: ParameterName
and ApplyMethod
.
To reset the entire DB cluster parameter group, specify the
DBClusterParameterGroupName
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. You must call RebootDBInstance
for every DB instance in your DB cluster that you want the updated
static parameter to apply to.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
resetDBClusterParameterGroupRequest
- Container for the necessary
parameters to execute the ResetDBClusterParameterGroup 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.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.Future<DescribeDBSnapshotsResult> describeDBSnapshotsAsync(DescribeDBSnapshotsRequest describeDBSnapshotsRequest) throws AmazonServiceException, AmazonClientException
Returns information about DB snapshots. This API supports pagination.
describeDBSnapshotsRequest
- Container for the necessary
parameters to execute the DescribeDBSnapshots operation on AmazonRDS.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.Future<DescribeDBSnapshotsResult> describeDBSnapshotsAsync(DescribeDBSnapshotsRequest describeDBSnapshotsRequest, AsyncHandler<DescribeDBSnapshotsRequest,DescribeDBSnapshotsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns information about DB snapshots. This API supports pagination.
describeDBSnapshotsRequest
- Container for the necessary
parameters to execute the DescribeDBSnapshots 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.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.Future<DBClusterSnapshot> deleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest) throws AmazonServiceException, AmazonClientException
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
NOTE:The DB cluster snapshot must be in the available state to be deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
deleteDBClusterSnapshotRequest
- Container for the necessary
parameters to execute the DeleteDBClusterSnapshot operation on
AmazonRDS.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.Future<DBClusterSnapshot> deleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest, AsyncHandler<DeleteDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
NOTE:The DB cluster snapshot must be in the available state to be deleted.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
deleteDBClusterSnapshotRequest
- Container for the necessary
parameters to execute the DeleteDBClusterSnapshot 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.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.Future<Void> deleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
deleteDBClusterParameterGroupRequest
- Container for the
necessary parameters to execute the DeleteDBClusterParameterGroup
operation on AmazonRDS.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.Future<Void> deleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest, AsyncHandler<DeleteDBClusterParameterGroupRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted cannot be associated with any DB clusters.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
deleteDBClusterParameterGroupRequest
- Container for the
necessary parameters to execute the DeleteDBClusterParameterGroup
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.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.Future<DBSubnetGroup> createDBSubnetGroupAsync(CreateDBSubnetGroupRequest createDBSubnetGroupRequest) throws AmazonServiceException, AmazonClientException
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
createDBSubnetGroupRequest
- Container for the necessary
parameters to execute the CreateDBSubnetGroup operation on AmazonRDS.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.Future<DBSubnetGroup> createDBSubnetGroupAsync(CreateDBSubnetGroupRequest createDBSubnetGroupRequest, AsyncHandler<CreateDBSubnetGroupRequest,DBSubnetGroup> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the region.
createDBSubnetGroupRequest
- Container for the necessary
parameters to execute the CreateDBSubnetGroup 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.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.Future<DescribeAccountAttributesResult> describeAccountAttributesAsync(DescribeAccountAttributesRequest describeAccountAttributesRequest) throws AmazonServiceException, AmazonClientException
Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
This command does not take any parameters.
describeAccountAttributesRequest
- Container for the necessary
parameters to execute the DescribeAccountAttributes operation on
AmazonRDS.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.Future<DescribeAccountAttributesResult> describeAccountAttributesAsync(DescribeAccountAttributesRequest describeAccountAttributesRequest, AsyncHandler<DescribeAccountAttributesRequest,DescribeAccountAttributesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists all of the attributes for a customer account. The attributes include Amazon RDS quotas for the account, such as the number of DB instances allowed. The description for a quota includes the quota name, current usage toward that quota, and the quota's maximum value.
This command does not take any parameters.
describeAccountAttributesRequest
- Container for the necessary
parameters to execute the DescribeAccountAttributes 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.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.Future<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of the available DB engines.
describeDBEngineVersionsRequest
- Container for the necessary
parameters to execute the DescribeDBEngineVersions operation on
AmazonRDS.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.Future<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest, AsyncHandler<DescribeDBEngineVersionsRequest,DescribeDBEngineVersionsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of the available DB engines.
describeDBEngineVersionsRequest
- Container for the necessary
parameters to execute the DescribeDBEngineVersions 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.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.Future<ModifyDBParameterGroupResult> modifyDBParameterGroupAsync(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies the parameters of a DB parameter group. 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: Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
IMPORTANT: After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
modifyDBParameterGroupRequest
- Container for the necessary
parameters to execute the ModifyDBParameterGroup operation on
AmazonRDS.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.Future<ModifyDBParameterGroupResult> modifyDBParameterGroupAsync(ModifyDBParameterGroupRequest modifyDBParameterGroupRequest, AsyncHandler<ModifyDBParameterGroupRequest,ModifyDBParameterGroupResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Modifies the parameters of a DB parameter group. 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: Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot without failover to the DB instance associated with the parameter group before the change can take effect.
IMPORTANT: After you modify a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the modify action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
modifyDBParameterGroupRequest
- Container for the necessary
parameters to execute the ModifyDBParameterGroup 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.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.Future<EngineDefaults> describeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest) throws AmazonServiceException, AmazonClientException
Returns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParametersRequest
- Container for the
necessary parameters to execute the DescribeEngineDefaultParameters
operation on AmazonRDS.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.Future<EngineDefaults> describeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest describeEngineDefaultParametersRequest, AsyncHandler<DescribeEngineDefaultParametersRequest,EngineDefaults> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParametersRequest
- Container for the
necessary parameters to execute the DescribeEngineDefaultParameters
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.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.Future<DBClusterSnapshot> createDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest) throws AmazonServiceException, AmazonClientException
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
createDBClusterSnapshotRequest
- Container for the necessary
parameters to execute the CreateDBClusterSnapshot operation on
AmazonRDS.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.Future<DBClusterSnapshot> createDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest, AsyncHandler<CreateDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
createDBClusterSnapshotRequest
- Container for the necessary
parameters to execute the CreateDBClusterSnapshot 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.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.Future<DBSnapshot> createDBSnapshotAsync(CreateDBSnapshotRequest createDBSnapshotRequest) throws AmazonServiceException, AmazonClientException
Creates a DBSnapshot. The source DBInstance must be in "available" state.
createDBSnapshotRequest
- Container for the necessary parameters
to execute the CreateDBSnapshot operation on AmazonRDS.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.Future<DBSnapshot> createDBSnapshotAsync(CreateDBSnapshotRequest createDBSnapshotRequest, AsyncHandler<CreateDBSnapshotRequest,DBSnapshot> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a DBSnapshot. The source DBInstance must be in "available" state.
createDBSnapshotRequest
- Container for the necessary parameters
to execute the CreateDBSnapshot 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.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.Future<EventSubscription> addSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Adds a source identifier to an existing RDS event notification subscription.
addSourceIdentifierToSubscriptionRequest
- Container for the
necessary parameters to execute the AddSourceIdentifierToSubscription
operation on AmazonRDS.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.Future<EventSubscription> addSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest, AsyncHandler<AddSourceIdentifierToSubscriptionRequest,EventSubscription> asyncHandler) throws AmazonServiceException, AmazonClientException
Adds a source identifier to an existing RDS event notification subscription.
addSourceIdentifierToSubscriptionRequest
- Container for the
necessary parameters to execute the AddSourceIdentifierToSubscription
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.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.Future<ResetDBParameterGroupResult> resetDBParameterGroupAsync(ResetDBParameterGroupRequest resetDBParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Modifies the parameters of a DB parameter group to the engine/system
default value. To reset specific parameters submit a list of the
following: ParameterName
and ApplyMethod
.
To reset the entire DB parameter group, 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.
resetDBParameterGroupRequest
- Container for the necessary
parameters to execute the ResetDBParameterGroup operation on
AmazonRDS.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.Future<ResetDBParameterGroupResult> resetDBParameterGroupAsync(ResetDBParameterGroupRequest resetDBParameterGroupRequest, AsyncHandler<ResetDBParameterGroupRequest,ResetDBParameterGroupResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Modifies the parameters of a DB parameter group to the engine/system
default value. To reset specific parameters submit a list of the
following: ParameterName
and ApplyMethod
.
To reset the entire DB parameter group, 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.
resetDBParameterGroupRequest
- Container for the necessary
parameters to execute the ResetDBParameterGroup 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.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.Future<Void> deleteDBParameterGroupAsync(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
deleteDBParameterGroupRequest
- Container for the necessary
parameters to execute the DeleteDBParameterGroup operation on
AmazonRDS.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.Future<Void> deleteDBParameterGroupAsync(DeleteDBParameterGroupRequest deleteDBParameterGroupRequest, AsyncHandler<DeleteDBParameterGroupRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes a specified DBParameterGroup. The DBParameterGroup to be deleted cannot be associated with any DB instances.
deleteDBParameterGroupRequest
- Container for the necessary
parameters to execute the DeleteDBParameterGroup 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.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.Future<DescribeDBLogFilesResult> describeDBLogFilesAsync(DescribeDBLogFilesRequest describeDBLogFilesRequest) throws AmazonServiceException, AmazonClientException
Returns a list of DB log files for the DB instance.
describeDBLogFilesRequest
- Container for the necessary
parameters to execute the DescribeDBLogFiles operation on AmazonRDS.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.Future<DescribeDBLogFilesResult> describeDBLogFilesAsync(DescribeDBLogFilesRequest describeDBLogFilesRequest, AsyncHandler<DescribeDBLogFilesRequest,DescribeDBLogFilesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of DB log files for the DB instance.
describeDBLogFilesRequest
- Container for the necessary
parameters to execute the DescribeDBLogFiles 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.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.Future<DescribeReservedDBInstancesResult> describeReservedDBInstancesAsync(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest) throws AmazonServiceException, AmazonClientException
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
describeReservedDBInstancesRequest
- Container for the necessary
parameters to execute the DescribeReservedDBInstances operation on
AmazonRDS.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.Future<DescribeReservedDBInstancesResult> describeReservedDBInstancesAsync(DescribeReservedDBInstancesRequest describeReservedDBInstancesRequest, AsyncHandler<DescribeReservedDBInstancesRequest,DescribeReservedDBInstancesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns information about reserved DB instances for this account, or about a specified reserved DB instance.
describeReservedDBInstancesRequest
- Container for the necessary
parameters to execute the DescribeReservedDBInstances 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.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.Future<DBCluster> failoverDBClusterAsync(FailoverDBClusterRequest failoverDBClusterRequest) throws AmazonServiceException, AmazonClientException
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.
Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
failoverDBClusterRequest
- Container for the necessary parameters
to execute the FailoverDBCluster operation on AmazonRDS.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.Future<DBCluster> failoverDBClusterAsync(FailoverDBClusterRequest failoverDBClusterRequest, AsyncHandler<FailoverDBClusterRequest,DBCluster> asyncHandler) throws AmazonServiceException, AmazonClientException
Forces a failover for a DB cluster.
A failover for a DB cluster promotes one of the read-only instances in the DB cluster to the master DB instance (the cluster writer) and deletes the current primary instance.
Amazon Aurora will automatically fail over to a read-only instance, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a DB instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.
For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
failoverDBClusterRequest
- Container for the necessary parameters
to execute the FailoverDBCluster 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.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.Future<DBInstance> promoteReadReplicaAsync(PromoteReadReplicaRequest promoteReadReplicaRequest) throws AmazonServiceException, AmazonClientException
Promotes a Read Replica DB instance to a standalone DB instance.
NOTE: We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.
promoteReadReplicaRequest
- Container for the necessary
parameters to execute the PromoteReadReplica operation on AmazonRDS.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.Future<DBInstance> promoteReadReplicaAsync(PromoteReadReplicaRequest promoteReadReplicaRequest, AsyncHandler<PromoteReadReplicaRequest,DBInstance> asyncHandler) throws AmazonServiceException, AmazonClientException
Promotes a Read Replica DB instance to a standalone DB instance.
NOTE: We recommend that you enable automated backups on your Read Replica before promoting the Read Replica. This ensures that no backup is taken during the promotion process. Once the instance is promoted to a primary instance, backups are taken based on your backup settings.
promoteReadReplicaRequest
- Container for the necessary
parameters to execute the PromoteReadReplica 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.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.Future<Void> addTagsToResourceAsync(AddTagsToResourceRequest addTagsToResourceRequest) throws AmazonServiceException, AmazonClientException
Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources .
addTagsToResourceRequest
- Container for the necessary parameters
to execute the AddTagsToResource operation on AmazonRDS.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.Future<Void> addTagsToResourceAsync(AddTagsToResourceRequest addTagsToResourceRequest, AsyncHandler<AddTagsToResourceRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Adds metadata tags to an Amazon RDS resource. These tags can also be used with cost allocation reporting to track cost associated with Amazon RDS resources, or used in a Condition statement in an IAM policy for Amazon RDS.
For an overview on tagging Amazon RDS resources, see Tagging Amazon RDS Resources .
addTagsToResourceRequest
- Container for the necessary parameters
to execute the AddTagsToResource 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.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.Future<DBCluster> modifyDBClusterAsync(ModifyDBClusterRequest modifyDBClusterRequest) throws AmazonServiceException, AmazonClientException
Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
modifyDBClusterRequest
- Container for the necessary parameters
to execute the ModifyDBCluster operation on AmazonRDS.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.Future<DBCluster> modifyDBClusterAsync(ModifyDBClusterRequest modifyDBClusterRequest, AsyncHandler<ModifyDBClusterRequest,DBCluster> asyncHandler) throws AmazonServiceException, AmazonClientException
Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
modifyDBClusterRequest
- Container for the necessary parameters
to execute the ModifyDBCluster 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.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.Future<DBClusterSnapshot> copyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest) throws AmazonServiceException, AmazonClientException
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
copyDBClusterSnapshotRequest
- Container for the necessary
parameters to execute the CopyDBClusterSnapshot operation on
AmazonRDS.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.Future<DBClusterSnapshot> copyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest, AsyncHandler<CopyDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates a snapshot of a DB cluster. For more information on Amazon Aurora, see Aurora on Amazon RDS in the Amazon RDS User Guide.
copyDBClusterSnapshotRequest
- Container for the necessary
parameters to execute the CopyDBClusterSnapshot 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.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.Future<DownloadDBLogFilePortionResult> downloadDBLogFilePortionAsync(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest) throws AmazonServiceException, AmazonClientException
Downloads all or a portion of the specified log file, up to 1 MB in size.
downloadDBLogFilePortionRequest
- Container for the necessary
parameters to execute the DownloadDBLogFilePortion operation on
AmazonRDS.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.Future<DownloadDBLogFilePortionResult> downloadDBLogFilePortionAsync(DownloadDBLogFilePortionRequest downloadDBLogFilePortionRequest, AsyncHandler<DownloadDBLogFilePortionRequest,DownloadDBLogFilePortionResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Downloads all or a portion of the specified log file, up to 1 MB in size.
downloadDBLogFilePortionRequest
- Container for the necessary
parameters to execute the DownloadDBLogFilePortion 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.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.Future<EventSubscription> createEventSubscriptionAsync(CreateEventSubscriptionRequest createEventSubscriptionRequest) throws AmazonServiceException, AmazonClientException
Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
createEventSubscriptionRequest
- Container for the necessary
parameters to execute the CreateEventSubscription operation on
AmazonRDS.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.Future<EventSubscription> createEventSubscriptionAsync(CreateEventSubscriptionRequest createEventSubscriptionRequest, AsyncHandler<CreateEventSubscriptionRequest,EventSubscription> asyncHandler) throws AmazonServiceException, AmazonClientException
Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.
You can specify the type of source (SourceType) you want to be notified of, provide a list of RDS sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
createEventSubscriptionRequest
- Container for the necessary
parameters to execute the CreateEventSubscription 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.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.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).
revokeDBSecurityGroupIngressRequest
- Container for the necessary
parameters to execute the RevokeDBSecurityGroupIngress operation on
AmazonRDS.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.Future<DBSecurityGroup> revokeDBSecurityGroupIngressAsync(RevokeDBSecurityGroupIngressRequest revokeDBSecurityGroupIngressRequest, AsyncHandler<RevokeDBSecurityGroupIngressRequest,DBSecurityGroup> asyncHandler) 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).
revokeDBSecurityGroupIngressRequest
- Container for the necessary
parameters to execute the RevokeDBSecurityGroupIngress 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.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.Future<DescribeCertificatesResult> describeCertificatesAsync(DescribeCertificatesRequest describeCertificatesRequest) throws AmazonServiceException, AmazonClientException
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
describeCertificatesRequest
- Container for the necessary
parameters to execute the DescribeCertificates operation on AmazonRDS.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.Future<DescribeCertificatesResult> describeCertificatesAsync(DescribeCertificatesRequest describeCertificatesRequest, AsyncHandler<DescribeCertificatesRequest,DescribeCertificatesResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists the set of CA certificates provided by Amazon RDS for this AWS account.
describeCertificatesRequest
- Container for the necessary
parameters to execute the DescribeCertificates 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.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.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 without failover for the new DB parameter group and associated settings to take effect.
IMPORTANT: After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
createDBParameterGroupRequest
- Container for the necessary
parameters to execute the CreateDBParameterGroup operation on
AmazonRDS.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.Future<DBParameterGroup> createDBParameterGroupAsync(CreateDBParameterGroupRequest createDBParameterGroupRequest, AsyncHandler<CreateDBParameterGroupRequest,DBParameterGroup> asyncHandler) 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 without failover for the new DB parameter group and associated settings to take effect.
IMPORTANT: After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
createDBParameterGroupRequest
- Container for the necessary
parameters to execute the CreateDBParameterGroup 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.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.Future<DescribeOrderableDBInstanceOptionsResult> describeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest) throws AmazonServiceException, AmazonClientException
Returns a list of orderable DB instance options for the specified engine.
describeOrderableDBInstanceOptionsRequest
- Container for the
necessary parameters to execute the DescribeOrderableDBInstanceOptions
operation on AmazonRDS.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.Future<DescribeOrderableDBInstanceOptionsResult> describeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest, AsyncHandler<DescribeOrderableDBInstanceOptionsRequest,DescribeOrderableDBInstanceOptionsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Returns a list of orderable DB instance options for the specified engine.
describeOrderableDBInstanceOptionsRequest
- Container for the
necessary parameters to execute the DescribeOrderableDBInstanceOptions
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.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.Future<Void> deleteOptionGroupAsync(DeleteOptionGroupRequest deleteOptionGroupRequest) throws AmazonServiceException, AmazonClientException
Deletes an existing option group.
deleteOptionGroupRequest
- Container for the necessary parameters
to execute the DeleteOptionGroup operation on AmazonRDS.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.Future<Void> deleteOptionGroupAsync(DeleteOptionGroupRequest deleteOptionGroupRequest, AsyncHandler<DeleteOptionGroupRequest,Void> asyncHandler) throws AmazonServiceException, AmazonClientException
Deletes an existing option group.
deleteOptionGroupRequest
- Container for the necessary parameters
to execute the DeleteOptionGroup 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.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.Future<DescribeReservedDBInstancesOfferingsResult> describeReservedDBInstancesOfferingsAsync(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest) throws AmazonServiceException, AmazonClientException
Lists available reserved DB instance offerings.
describeReservedDBInstancesOfferingsRequest
- Container for the
necessary parameters to execute the
DescribeReservedDBInstancesOfferings operation on AmazonRDS.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.Future<DescribeReservedDBInstancesOfferingsResult> describeReservedDBInstancesOfferingsAsync(DescribeReservedDBInstancesOfferingsRequest describeReservedDBInstancesOfferingsRequest, AsyncHandler<DescribeReservedDBInstancesOfferingsRequest,DescribeReservedDBInstancesOfferingsResult> asyncHandler) throws AmazonServiceException, AmazonClientException
Lists available reserved DB instance offerings.
describeReservedDBInstancesOfferingsRequest
- Container for the
necessary parameters to execute the
DescribeReservedDBInstancesOfferings 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.AmazonClientException
- If any internal errors are encountered inside the client while
attempting to make the request or handle the response. For example
if a network connection is not available.AmazonServiceException
- If an error response is returned by AmazonRDS indicating
either a problem with the data in the request, or a server side issue.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.