@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonRDSAsyncClient extends AmazonRDSClient implements AmazonRDSAsync
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
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 DB 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. 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.
LOGGING_AWS_REQUEST_METRICENDPOINT_PREFIX| Constructor and Description |
|---|
AmazonRDSAsyncClient()
Deprecated.
|
AmazonRDSAsyncClient(AWSCredentials awsCredentials)
Deprecated.
|
AmazonRDSAsyncClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonRDSAsyncClient(AWSCredentials awsCredentials,
ExecutorService executorService)
|
AmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
ExecutorService executorService)
|
AmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider,
ExecutorService executorService)
|
AmazonRDSAsyncClient(ClientConfiguration clientConfiguration)
Deprecated.
|
addRoleToDBCluster, addRoleToDBInstance, addSourceIdentifierToSubscription, addTagsToResource, applyPendingMaintenanceAction, authorizeDBSecurityGroupIngress, backtrackDBCluster, builder, cancelExportTask, copyDBClusterParameterGroup, copyDBClusterSnapshot, copyDBParameterGroup, copyDBSnapshot, copyOptionGroup, createCustomDBEngineVersion, createDBCluster, createDBClusterEndpoint, createDBClusterParameterGroup, createDBClusterSnapshot, createDBInstance, createDBInstanceReadReplica, createDBParameterGroup, createDBProxy, createDBProxyEndpoint, createDBSecurityGroup, createDBSnapshot, createDBSubnetGroup, createEventSubscription, createGlobalCluster, createOptionGroup, deleteCustomDBEngineVersion, deleteDBCluster, deleteDBClusterEndpoint, deleteDBClusterParameterGroup, deleteDBClusterSnapshot, deleteDBInstance, deleteDBInstanceAutomatedBackup, deleteDBParameterGroup, deleteDBProxy, deleteDBProxyEndpoint, deleteDBSecurityGroup, deleteDBSnapshot, deleteDBSubnetGroup, deleteEventSubscription, deleteGlobalCluster, deleteOptionGroup, deregisterDBProxyTargets, describeAccountAttributes, describeAccountAttributes, describeCertificates, describeCertificates, describeDBClusterBacktracks, describeDBClusterEndpoints, describeDBClusterParameterGroups, describeDBClusterParameterGroups, describeDBClusterParameters, describeDBClusters, describeDBClusters, describeDBClusterSnapshotAttributes, describeDBClusterSnapshots, describeDBClusterSnapshots, describeDBEngineVersions, describeDBEngineVersions, describeDBInstanceAutomatedBackups, describeDBInstances, describeDBInstances, describeDBLogFiles, describeDBParameterGroups, describeDBParameterGroups, describeDBParameters, describeDBProxies, describeDBProxyEndpoints, describeDBProxyTargetGroups, describeDBProxyTargets, describeDBSecurityGroups, describeDBSecurityGroups, describeDBSnapshotAttributes, describeDBSnapshotAttributes, describeDBSnapshots, describeDBSnapshots, describeDBSubnetGroups, describeDBSubnetGroups, describeEngineDefaultClusterParameters, describeEngineDefaultParameters, describeEventCategories, describeEventCategories, describeEvents, describeEvents, describeEventSubscriptions, describeEventSubscriptions, describeExportTasks, describeGlobalClusters, describeOptionGroupOptions, describeOptionGroups, describeOptionGroups, describeOrderableDBInstanceOptions, describePendingMaintenanceActions, describePendingMaintenanceActions, describeReservedDBInstances, describeReservedDBInstances, describeReservedDBInstancesOfferings, describeReservedDBInstancesOfferings, describeSourceRegions, describeValidDBInstanceModifications, downloadDBLogFilePortion, failoverDBCluster, failoverDBCluster, failoverGlobalCluster, getCachedResponseMetadata, listTagsForResource, modifyCertificates, modifyCurrentDBClusterCapacity, modifyCustomDBEngineVersion, modifyDBCluster, modifyDBClusterEndpoint, modifyDBClusterParameterGroup, modifyDBClusterSnapshotAttribute, modifyDBInstance, modifyDBParameterGroup, modifyDBProxy, modifyDBProxyEndpoint, modifyDBProxyTargetGroup, modifyDBSnapshot, modifyDBSnapshotAttribute, modifyDBSubnetGroup, modifyEventSubscription, modifyGlobalCluster, modifyOptionGroup, promoteReadReplica, promoteReadReplicaDBCluster, purchaseReservedDBInstancesOffering, rebootDBCluster, rebootDBInstance, registerDBProxyTargets, removeFromGlobalCluster, removeRoleFromDBCluster, removeRoleFromDBInstance, removeSourceIdentifierFromSubscription, removeTagsFromResource, resetDBClusterParameterGroup, resetDBParameterGroup, restoreDBClusterFromS3, restoreDBClusterFromSnapshot, restoreDBClusterToPointInTime, restoreDBInstanceFromDBSnapshot, restoreDBInstanceFromS3, restoreDBInstanceToPointInTime, revokeDBSecurityGroupIngress, startActivityStream, startDBCluster, startDBInstance, startDBInstanceAutomatedBackupsReplication, startExportTask, stopActivityStream, stopDBCluster, stopDBInstance, stopDBInstanceAutomatedBackupsReplication, waitersaddRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffsetequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddRoleToDBCluster, addRoleToDBInstance, addSourceIdentifierToSubscription, addTagsToResource, applyPendingMaintenanceAction, authorizeDBSecurityGroupIngress, backtrackDBCluster, cancelExportTask, copyDBClusterParameterGroup, copyDBClusterSnapshot, copyDBParameterGroup, copyDBSnapshot, copyOptionGroup, createCustomDBEngineVersion, createDBCluster, createDBClusterEndpoint, createDBClusterParameterGroup, createDBClusterSnapshot, createDBInstance, createDBInstanceReadReplica, createDBParameterGroup, createDBProxy, createDBProxyEndpoint, createDBSecurityGroup, createDBSnapshot, createDBSubnetGroup, createEventSubscription, createGlobalCluster, createOptionGroup, deleteCustomDBEngineVersion, deleteDBCluster, deleteDBClusterEndpoint, deleteDBClusterParameterGroup, deleteDBClusterSnapshot, deleteDBInstance, deleteDBInstanceAutomatedBackup, deleteDBParameterGroup, deleteDBProxy, deleteDBProxyEndpoint, deleteDBSecurityGroup, deleteDBSnapshot, deleteDBSubnetGroup, deleteEventSubscription, deleteGlobalCluster, deleteOptionGroup, deregisterDBProxyTargets, describeAccountAttributes, describeAccountAttributes, describeCertificates, describeCertificates, describeDBClusterBacktracks, describeDBClusterEndpoints, describeDBClusterParameterGroups, describeDBClusterParameterGroups, describeDBClusterParameters, describeDBClusters, describeDBClusters, describeDBClusterSnapshotAttributes, describeDBClusterSnapshots, describeDBClusterSnapshots, describeDBEngineVersions, describeDBEngineVersions, describeDBInstanceAutomatedBackups, describeDBInstances, describeDBInstances, describeDBLogFiles, describeDBParameterGroups, describeDBParameterGroups, describeDBParameters, describeDBProxies, describeDBProxyEndpoints, describeDBProxyTargetGroups, describeDBProxyTargets, describeDBSecurityGroups, describeDBSecurityGroups, describeDBSnapshotAttributes, describeDBSnapshotAttributes, describeDBSnapshots, describeDBSnapshots, describeDBSubnetGroups, describeDBSubnetGroups, describeEngineDefaultClusterParameters, describeEngineDefaultParameters, describeEventCategories, describeEventCategories, describeEvents, describeEvents, describeEventSubscriptions, describeEventSubscriptions, describeExportTasks, describeGlobalClusters, describeOptionGroupOptions, describeOptionGroups, describeOptionGroups, describeOrderableDBInstanceOptions, describePendingMaintenanceActions, describePendingMaintenanceActions, describeReservedDBInstances, describeReservedDBInstances, describeReservedDBInstancesOfferings, describeReservedDBInstancesOfferings, describeSourceRegions, describeValidDBInstanceModifications, downloadDBLogFilePortion, failoverDBCluster, failoverDBCluster, failoverGlobalCluster, getCachedResponseMetadata, listTagsForResource, modifyCertificates, modifyCurrentDBClusterCapacity, modifyCustomDBEngineVersion, modifyDBCluster, modifyDBClusterEndpoint, modifyDBClusterParameterGroup, modifyDBClusterSnapshotAttribute, modifyDBInstance, modifyDBParameterGroup, modifyDBProxy, modifyDBProxyEndpoint, modifyDBProxyTargetGroup, modifyDBSnapshot, modifyDBSnapshotAttribute, modifyDBSubnetGroup, modifyEventSubscription, modifyGlobalCluster, modifyOptionGroup, promoteReadReplica, promoteReadReplicaDBCluster, purchaseReservedDBInstancesOffering, rebootDBCluster, rebootDBInstance, registerDBProxyTargets, removeFromGlobalCluster, removeRoleFromDBCluster, removeRoleFromDBInstance, removeSourceIdentifierFromSubscription, removeTagsFromResource, resetDBClusterParameterGroup, resetDBParameterGroup, restoreDBClusterFromS3, restoreDBClusterFromSnapshot, restoreDBClusterToPointInTime, restoreDBInstanceFromDBSnapshot, restoreDBInstanceFromS3, restoreDBInstanceToPointInTime, revokeDBSecurityGroupIngress, setEndpoint, setRegion, startActivityStream, startDBCluster, startDBInstance, startDBInstanceAutomatedBackupsReplication, startExportTask, stopActivityStream, stopDBCluster, stopDBInstance, stopDBInstanceAutomatedBackupsReplication, waiters@Deprecated public AmazonRDSAsyncClient()
AmazonRDSAsyncClientBuilder.defaultClient()Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
@Deprecated public AmazonRDSAsyncClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
clientConfiguration - The client configuration options controlling how this client connects to Amazon RDS (ex: proxy settings,
retry counts, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonRDSAsyncClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonRDSAsyncClient(AWSCredentials awsCredentials, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonRDSAsyncClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)Asynchronous methods are delegated to a fixed-size thread pool containing 50 threads (to match the default maximum number of concurrent connections to the service).
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.Executors.newFixedThreadPool(int)@Deprecated public AmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
Asynchronous methods are delegated to a fixed-size thread pool containing a number of threads equal to the
maximum number of concurrent connections configured via ClientConfiguration.getMaxConnections().
awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).DefaultAWSCredentialsProviderChain,
Executors.newFixedThreadPool(int)@Deprecated public AmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.executorService - The executor service by which all asynchronous requests will be executed.@Deprecated public AmazonRDSAsyncClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, ExecutorService executorService)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsAsyncClientBuilder.withExecutorFactory(com.amazonaws.client.builder.ExecutorFactory)awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.clientConfiguration - Client configuration options (ex: max retry limit, proxy settings, etc).executorService - The executor service by which all asynchronous requests will be executed.public static AmazonRDSAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<AddRoleToDBClusterResult> addRoleToDBClusterAsync(AddRoleToDBClusterRequest request)
AmazonRDSAsyncAssociates an Identity and Access Management (IAM) role with a DB cluster.
addRoleToDBClusterAsync in interface AmazonRDSAsyncpublic Future<AddRoleToDBClusterResult> addRoleToDBClusterAsync(AddRoleToDBClusterRequest request, AsyncHandler<AddRoleToDBClusterRequest,AddRoleToDBClusterResult> asyncHandler)
AmazonRDSAsyncAssociates an Identity and Access Management (IAM) role with a DB cluster.
addRoleToDBClusterAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AddRoleToDBInstanceResult> addRoleToDBInstanceAsync(AddRoleToDBInstanceRequest request)
AmazonRDSAsyncAssociates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
To add a role to a DB instance, the status of the DB instance must be available.
This command doesn't apply to RDS Custom.
addRoleToDBInstanceAsync in interface AmazonRDSAsyncpublic Future<AddRoleToDBInstanceResult> addRoleToDBInstanceAsync(AddRoleToDBInstanceRequest request, AsyncHandler<AddRoleToDBInstanceRequest,AddRoleToDBInstanceResult> asyncHandler)
AmazonRDSAsyncAssociates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance.
To add a role to a DB instance, the status of the DB instance must be available.
This command doesn't apply to RDS Custom.
addRoleToDBInstanceAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<EventSubscription> addSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest request)
AmazonRDSAsyncAdds a source identifier to an existing RDS event notification subscription.
addSourceIdentifierToSubscriptionAsync in interface AmazonRDSAsyncpublic Future<EventSubscription> addSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest request, AsyncHandler<AddSourceIdentifierToSubscriptionRequest,EventSubscription> asyncHandler)
AmazonRDSAsyncAdds a source identifier to an existing RDS event notification subscription.
addSourceIdentifierToSubscriptionAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest request)
AmazonRDSAsyncAdds 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.
addTagsToResourceAsync in interface AmazonRDSAsyncpublic Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest request, AsyncHandler<AddTagsToResourceRequest,AddTagsToResourceResult> asyncHandler)
AmazonRDSAsyncAdds 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.
addTagsToResourceAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ResourcePendingMaintenanceActions> applyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest request)
AmazonRDSAsyncApplies a pending maintenance action to a resource (for example, to a DB instance).
applyPendingMaintenanceActionAsync in interface AmazonRDSAsyncpublic Future<ResourcePendingMaintenanceActions> applyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest request, AsyncHandler<ApplyPendingMaintenanceActionRequest,ResourcePendingMaintenanceActions> asyncHandler)
AmazonRDSAsyncApplies a pending maintenance action to a resource (for example, to a DB instance).
applyPendingMaintenanceActionAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBSecurityGroup> authorizeDBSecurityGroupIngressAsync(AuthorizeDBSecurityGroupIngressRequest request)
AmazonRDSAsyncEnables 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).
You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't 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.
authorizeDBSecurityGroupIngressAsync in interface AmazonRDSAsyncpublic Future<DBSecurityGroup> authorizeDBSecurityGroupIngressAsync(AuthorizeDBSecurityGroupIngressRequest request, AsyncHandler<AuthorizeDBSecurityGroupIngressRequest,DBSecurityGroup> asyncHandler)
AmazonRDSAsyncEnables 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).
You can't authorize ingress from an EC2 security group in one Amazon Web Services Region to an Amazon RDS DB instance in another. You can't 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.
authorizeDBSecurityGroupIngressAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<BacktrackDBClusterResult> backtrackDBClusterAsync(BacktrackDBClusterRequest request)
AmazonRDSAsyncBacktracks a DB cluster to a specific time, without creating a new DB cluster.
For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
backtrackDBClusterAsync in interface AmazonRDSAsyncpublic Future<BacktrackDBClusterResult> backtrackDBClusterAsync(BacktrackDBClusterRequest request, AsyncHandler<BacktrackDBClusterRequest,BacktrackDBClusterResult> asyncHandler)
AmazonRDSAsyncBacktracks a DB cluster to a specific time, without creating a new DB cluster.
For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
backtrackDBClusterAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CancelExportTaskResult> cancelExportTaskAsync(CancelExportTaskRequest request)
AmazonRDSAsyncCancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
cancelExportTaskAsync in interface AmazonRDSAsyncpublic Future<CancelExportTaskResult> cancelExportTaskAsync(CancelExportTaskRequest request, AsyncHandler<CancelExportTaskRequest,CancelExportTaskResult> asyncHandler)
AmazonRDSAsyncCancels an export task in progress that is exporting a snapshot to Amazon S3. Any data that has already been written to the S3 bucket isn't removed.
cancelExportTaskAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBClusterParameterGroup> copyDBClusterParameterGroupAsync(CopyDBClusterParameterGroupRequest request)
AmazonRDSAsyncCopies the specified DB cluster parameter group.
copyDBClusterParameterGroupAsync in interface AmazonRDSAsyncpublic Future<DBClusterParameterGroup> copyDBClusterParameterGroupAsync(CopyDBClusterParameterGroupRequest request, AsyncHandler<CopyDBClusterParameterGroupRequest,DBClusterParameterGroup> asyncHandler)
AmazonRDSAsyncCopies the specified DB cluster parameter group.
copyDBClusterParameterGroupAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBClusterSnapshot> copyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest request)
AmazonRDSAsyncCopies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster
snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon
Web Services Region where you call the CopyDBClusterSnapshot action is the destination Amazon Web
Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot
from another Amazon Web Services Region, you must provide the following values:
KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier
for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
PreSignedUrl - A URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB
cluster snapshot is copied from. The pre-signed URL must be a valid request for the
CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that
contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of
the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the
CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the
action contained in the pre-signed URL.
DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be
created in.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web
Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web
Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example:
arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or
--source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying
SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be
executed in the source Amazon Web Services Region.
TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in
the destination Amazon Web Services Region.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is
the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by
TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
copyDBClusterSnapshotAsync in interface AmazonRDSAsyncpublic Future<DBClusterSnapshot> copyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest request, AsyncHandler<CopyDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
AmazonRDSAsyncCopies a snapshot of a DB cluster.
To copy a DB cluster snapshot from a shared manual DB cluster snapshot,
SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster
snapshot.
You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon
Web Services Region where you call the CopyDBClusterSnapshot action is the destination Amazon Web
Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot
from another Amazon Web Services Region, you must provide the following values:
KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier
for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
PreSignedUrl - A URL that contains a Signature Version 4 signed request for the
CopyDBClusterSnapshot action to be called in the source Amazon Web Services Region where the DB
cluster snapshot is copied from. The pre-signed URL must be a valid request for the
CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that
contains the encrypted DB cluster snapshot to be copied.
The pre-signed URL request must contain the following parameter values:
KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of
the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the
CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the
action contained in the pre-signed URL.
DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be
created in.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web
Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web
Services Region, then your SourceDBClusterSnapshotIdentifier looks like the following example:
arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115.
To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process.
If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or
--source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying
SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be
executed in the source Amazon Web Services Region.
TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in
the destination Amazon Web Services Region.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster
snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is
the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL.
To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by
TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status.
For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
copyDBClusterSnapshotAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBParameterGroup> copyDBParameterGroupAsync(CopyDBParameterGroupRequest request)
AmazonRDSAsyncCopies the specified DB parameter group.
copyDBParameterGroupAsync in interface AmazonRDSAsyncpublic Future<DBParameterGroup> copyDBParameterGroupAsync(CopyDBParameterGroupRequest request, AsyncHandler<CopyDBParameterGroupRequest,DBParameterGroup> asyncHandler)
AmazonRDSAsyncCopies the specified DB parameter group.
copyDBParameterGroupAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBSnapshot> copyDBSnapshotAsync(CopyDBSnapshotRequest request)
AmazonRDSAsync
Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services
Region where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for
the DB snapshot copy.
This command doesn't apply to RDS Custom.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
copyDBSnapshotAsync in interface AmazonRDSAsyncpublic Future<DBSnapshot> copyDBSnapshotAsync(CopyDBSnapshotRequest request, AsyncHandler<CopyDBSnapshotRequest,DBSnapshot> asyncHandler)
AmazonRDSAsync
Copies the specified DB snapshot. The source DB snapshot must be in the available state.
You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services
Region where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for
the DB snapshot copy.
This command doesn't apply to RDS Custom.
For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
copyDBSnapshotAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<OptionGroup> copyOptionGroupAsync(CopyOptionGroupRequest request)
AmazonRDSAsyncCopies the specified option group.
copyOptionGroupAsync in interface AmazonRDSAsyncpublic Future<OptionGroup> copyOptionGroupAsync(CopyOptionGroupRequest request, AsyncHandler<CopyOptionGroupRequest,OptionGroup> asyncHandler)
AmazonRDSAsyncCopies the specified option group.
copyOptionGroupAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateCustomDBEngineVersionResult> createCustomDBEngineVersionAsync(CreateCustomDBEngineVersionRequest request)
AmazonRDSAsyncCreates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific AMI. The supported engines are the following:
Oracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR
Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR
Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.
When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This service model is called Bring Your Own Media (BYOM).
Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with the
message Creation failed for custom engine version, and includes details about the failure. For
example, the event prints missing files.
After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or inactive.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web
Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway
that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the
CreateCustomDbEngineVersion event.
For more information, see Creating a CEV in the Amazon RDS User Guide.
createCustomDBEngineVersionAsync in interface AmazonRDSAsyncpublic Future<CreateCustomDBEngineVersionResult> createCustomDBEngineVersionAsync(CreateCustomDBEngineVersionRequest request, AsyncHandler<CreateCustomDBEngineVersionRequest,CreateCustomDBEngineVersionResult> asyncHandler)
AmazonRDSAsyncCreates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific AMI. The supported engines are the following:
Oracle Database 12.1 Enterprise Edition with the January 2021 or later RU/RUR
Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR
Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.
When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This service model is called Bring Your Own Media (BYOM).
Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with the
message Creation failed for custom engine version, and includes details about the failure. For
example, the event prints missing files.
After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or inactive.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web
Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway
that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the
CreateCustomDbEngineVersion event.
For more information, see Creating a CEV in the Amazon RDS User Guide.
createCustomDBEngineVersionAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBCluster> createDBClusterAsync(CreateDBClusterRequest request)
AmazonRDSAsyncCreates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a
read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For cross-Region replication
where the DB cluster identified by ReplicationSourceIdentifier is encrypted, also specify the
PreSignedUrl parameter.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
createDBClusterAsync in interface AmazonRDSAsyncpublic Future<DBCluster> createDBClusterAsync(CreateDBClusterRequest request, AsyncHandler<CreateDBClusterRequest,DBCluster> asyncHandler)
AmazonRDSAsyncCreates a new Amazon Aurora DB cluster or Multi-AZ DB cluster.
You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a
read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For cross-Region replication
where the DB cluster identified by ReplicationSourceIdentifier is encrypted, also specify the
PreSignedUrl parameter.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
createDBClusterAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDBClusterEndpointResult> createDBClusterEndpointAsync(CreateDBClusterEndpointRequest request)
AmazonRDSAsyncCreates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
createDBClusterEndpointAsync in interface AmazonRDSAsyncpublic Future<CreateDBClusterEndpointResult> createDBClusterEndpointAsync(CreateDBClusterEndpointRequest request, AsyncHandler<CreateDBClusterEndpointRequest,CreateDBClusterEndpointResult> asyncHandler)
AmazonRDSAsyncCreates a new custom endpoint and associates it with an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
createDBClusterEndpointAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBClusterParameterGroup> createDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest request)
AmazonRDSAsyncCreates 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 Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
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
action to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
createDBClusterParameterGroupAsync in interface AmazonRDSAsyncpublic Future<DBClusterParameterGroup> createDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest request, AsyncHandler<CreateDBClusterParameterGroupRequest,DBClusterParameterGroup> asyncHandler)
AmazonRDSAsyncCreates 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 Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect.
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
action to verify that your DB cluster parameter group has been created or modified.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
createDBClusterParameterGroupAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBClusterSnapshot> createDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest request)
AmazonRDSAsyncCreates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
createDBClusterSnapshotAsync in interface AmazonRDSAsyncpublic Future<DBClusterSnapshot> createDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest request, AsyncHandler<CreateDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
AmazonRDSAsyncCreates a snapshot of a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
createDBClusterSnapshotAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest request)
AmazonRDSAsyncCreates a new DB instance.
createDBInstanceAsync in interface AmazonRDSAsyncpublic Future<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest request, AsyncHandler<CreateDBInstanceRequest,DBInstance> asyncHandler)
AmazonRDSAsyncCreates a new DB instance.
createDBInstanceAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBInstance> createDBInstanceReadReplicaAsync(CreateDBInstanceReadReplicaRequest request)
AmazonRDSAsyncCreates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide.
Amazon Aurora doesn't support this action. Call the CreateDBInstance action to create a DB instance
for an Aurora DB cluster.
All read replica DB instances are created 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.
Your source DB instance must have backup retention enabled.
createDBInstanceReadReplicaAsync in interface AmazonRDSAsyncpublic Future<DBInstance> createDBInstanceReadReplicaAsync(CreateDBInstanceReadReplicaRequest request, AsyncHandler<CreateDBInstanceReadReplicaRequest,DBInstance> asyncHandler)
AmazonRDSAsyncCreates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide.
Amazon Aurora doesn't support this action. Call the CreateDBInstance action to create a DB instance
for an Aurora DB cluster.
All read replica DB instances are created 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.
Your source DB instance must have backup retention enabled.
createDBInstanceReadReplicaAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBParameterGroup> createDBParameterGroupAsync(CreateDBParameterGroupRequest request)
AmazonRDSAsyncCreates 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.
This command doesn't apply to RDS Custom.
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.
createDBParameterGroupAsync in interface AmazonRDSAsyncpublic Future<DBParameterGroup> createDBParameterGroupAsync(CreateDBParameterGroupRequest request, AsyncHandler<CreateDBParameterGroupRequest,DBParameterGroup> asyncHandler)
AmazonRDSAsyncCreates 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.
This command doesn't apply to RDS Custom.
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.
createDBParameterGroupAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDBProxyResult> createDBProxyAsync(CreateDBProxyRequest request)
AmazonRDSAsyncCreates a new DB proxy.
createDBProxyAsync in interface AmazonRDSAsyncpublic Future<CreateDBProxyResult> createDBProxyAsync(CreateDBProxyRequest request, AsyncHandler<CreateDBProxyRequest,CreateDBProxyResult> asyncHandler)
AmazonRDSAsyncCreates a new DB proxy.
createDBProxyAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<CreateDBProxyEndpointResult> createDBProxyEndpointAsync(CreateDBProxyEndpointRequest request)
AmazonRDSAsync
Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You
can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy
endpoints to access a DB proxy through a different VPC than the proxy's default VPC.
createDBProxyEndpointAsync in interface AmazonRDSAsyncpublic Future<CreateDBProxyEndpointResult> createDBProxyEndpointAsync(CreateDBProxyEndpointRequest request, AsyncHandler<CreateDBProxyEndpointRequest,CreateDBProxyEndpointResult> asyncHandler)
AmazonRDSAsync
Creates a DBProxyEndpoint. Only applies to proxies that are associated with Aurora DB clusters. You
can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy
endpoints to access a DB proxy through a different VPC than the proxy's default VPC.
createDBProxyEndpointAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBSecurityGroup> createDBSecurityGroupAsync(CreateDBSecurityGroupRequest request)
AmazonRDSAsyncCreates a new DB security group. DB security groups control access to a DB instance.
A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
createDBSecurityGroupAsync in interface AmazonRDSAsyncpublic Future<DBSecurityGroup> createDBSecurityGroupAsync(CreateDBSecurityGroupRequest request, AsyncHandler<CreateDBSecurityGroupRequest,DBSecurityGroup> asyncHandler)
AmazonRDSAsyncCreates a new DB security group. DB security groups control access to a DB instance.
A DB security group controls access to EC2-Classic DB instances that are not in a VPC.
createDBSecurityGroupAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBSnapshot> createDBSnapshotAsync(CreateDBSnapshotRequest request)
AmazonRDSAsync
Creates a snapshot of a DB instance. The source DB instance must be in the available or
storage-optimization state.
createDBSnapshotAsync in interface AmazonRDSAsyncpublic Future<DBSnapshot> createDBSnapshotAsync(CreateDBSnapshotRequest request, AsyncHandler<CreateDBSnapshotRequest,DBSnapshot> asyncHandler)
AmazonRDSAsync
Creates a snapshot of a DB instance. The source DB instance must be in the available or
storage-optimization state.
createDBSnapshotAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBSubnetGroup> createDBSubnetGroupAsync(CreateDBSubnetGroupRequest request)
AmazonRDSAsyncCreates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
createDBSubnetGroupAsync in interface AmazonRDSAsyncpublic Future<DBSubnetGroup> createDBSubnetGroupAsync(CreateDBSubnetGroupRequest request, AsyncHandler<CreateDBSubnetGroupRequest,DBSubnetGroup> asyncHandler)
AmazonRDSAsyncCreates a new DB subnet group. DB subnet groups must contain at least one subnet in at least two AZs in the Amazon Web Services Region.
createDBSubnetGroupAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<EventSubscription> createEventSubscriptionAsync(CreateEventSubscriptionRequest request)
AmazonRDSAsyncCreates an RDS event notification subscription. This action requires a topic Amazon Resource Name (ARN) 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) that you want to be notified of and provide a list
of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories
(EventCategories) for events that 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 SourceIds = myDBInstance1, you are notified of all the
db-instance events for the specified source. If you specify a SourceType but do not
specify SourceIds, you receive notice of the events for that source type for all your RDS sources.
If you don't specify either the SourceType or the SourceIds, you are notified of events generated
from all RDS sources belonging to your customer account.
RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.
createEventSubscriptionAsync in interface AmazonRDSAsyncpublic Future<EventSubscription> createEventSubscriptionAsync(CreateEventSubscriptionRequest request, AsyncHandler<CreateEventSubscriptionRequest,EventSubscription> asyncHandler)
AmazonRDSAsyncCreates an RDS event notification subscription. This action requires a topic Amazon Resource Name (ARN) 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) that you want to be notified of and provide a list
of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories
(EventCategories) for events that 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 SourceIds = myDBInstance1, you are notified of all the
db-instance events for the specified source. If you specify a SourceType but do not
specify SourceIds, you receive notice of the events for that source type for all your RDS sources.
If you don't specify either the SourceType or the SourceIds, you are notified of events generated
from all RDS sources belonging to your customer account.
RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.
createEventSubscriptionAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GlobalCluster> createGlobalClusterAsync(CreateGlobalClusterRequest request)
AmazonRDSAsyncCreates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This action only applies to Aurora DB clusters.
createGlobalClusterAsync in interface AmazonRDSAsyncpublic Future<GlobalCluster> createGlobalClusterAsync(CreateGlobalClusterRequest request, AsyncHandler<CreateGlobalClusterRequest,GlobalCluster> asyncHandler)
AmazonRDSAsyncCreates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.
You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database.
This action only applies to Aurora DB clusters.
createGlobalClusterAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<OptionGroup> createOptionGroupAsync(CreateOptionGroupRequest request)
AmazonRDSAsyncCreates a new option group. You can create up to 20 option groups.
This command doesn't apply to RDS Custom.
createOptionGroupAsync in interface AmazonRDSAsyncpublic Future<OptionGroup> createOptionGroupAsync(CreateOptionGroupRequest request, AsyncHandler<CreateOptionGroupRequest,OptionGroup> asyncHandler)
AmazonRDSAsyncCreates a new option group. You can create up to 20 option groups.
This command doesn't apply to RDS Custom.
createOptionGroupAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteCustomDBEngineVersionResult> deleteCustomDBEngineVersionAsync(DeleteCustomDBEngineVersionRequest request)
AmazonRDSAsyncDeletes a custom engine version. To run this command, make sure you meet the following prerequisites:
The CEV must not be the default for RDS Custom. If it is, change the default before running this command.
The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.
Typically, deletion takes a few minutes.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web
Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway
that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the
DeleteCustomDbEngineVersion event.
For more information, see Deleting a CEV in the Amazon RDS User Guide.
deleteCustomDBEngineVersionAsync in interface AmazonRDSAsyncpublic Future<DeleteCustomDBEngineVersionResult> deleteCustomDBEngineVersionAsync(DeleteCustomDBEngineVersionRequest request, AsyncHandler<DeleteCustomDBEngineVersionRequest,DeleteCustomDBEngineVersionResult> asyncHandler)
AmazonRDSAsyncDeletes a custom engine version. To run this command, make sure you meet the following prerequisites:
The CEV must not be the default for RDS Custom. If it is, change the default before running this command.
The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.
Typically, deletion takes a few minutes.
The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web
Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway
that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the
DeleteCustomDbEngineVersion event.
For more information, see Deleting a CEV in the Amazon RDS User Guide.
deleteCustomDBEngineVersionAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBCluster> deleteDBClusterAsync(DeleteDBClusterRequest request)
AmazonRDSAsyncThe DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
deleteDBClusterAsync in interface AmazonRDSAsyncpublic Future<DBCluster> deleteDBClusterAsync(DeleteDBClusterRequest request, AsyncHandler<DeleteDBClusterRequest,DBCluster> asyncHandler)
AmazonRDSAsyncThe DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
deleteDBClusterAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDBClusterEndpointResult> deleteDBClusterEndpointAsync(DeleteDBClusterEndpointRequest request)
AmazonRDSAsyncDeletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
deleteDBClusterEndpointAsync in interface AmazonRDSAsyncpublic Future<DeleteDBClusterEndpointResult> deleteDBClusterEndpointAsync(DeleteDBClusterEndpointRequest request, AsyncHandler<DeleteDBClusterEndpointRequest,DeleteDBClusterEndpointResult> asyncHandler)
AmazonRDSAsyncDeletes a custom endpoint and removes it from an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
deleteDBClusterEndpointAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDBClusterParameterGroupResult> deleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest request)
AmazonRDSAsyncDeletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
deleteDBClusterParameterGroupAsync in interface AmazonRDSAsyncpublic Future<DeleteDBClusterParameterGroupResult> deleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest request, AsyncHandler<DeleteDBClusterParameterGroupRequest,DeleteDBClusterParameterGroupResult> asyncHandler)
AmazonRDSAsyncDeletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
deleteDBClusterParameterGroupAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBClusterSnapshot> deleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest request)
AmazonRDSAsyncDeletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available state to be deleted.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
deleteDBClusterSnapshotAsync in interface AmazonRDSAsyncpublic Future<DBClusterSnapshot> deleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest request, AsyncHandler<DeleteDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
AmazonRDSAsyncDeletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB cluster snapshot must be in the available state to be deleted.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
deleteDBClusterSnapshotAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBInstance> deleteDBInstanceAsync(DeleteDBInstanceRequest request)
AmazonRDSAsync
The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all
automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to
be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB
snapshot is created. The API action DescribeDBInstance is used to monitor the status of this
operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed,
incompatible-restore, or incompatible-network, you can only delete it when you skip
creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
The DB cluster is a read replica of another Amazon Aurora DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to
promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the
DeleteDBInstance API action to delete the final instance in the DB cluster.
deleteDBInstanceAsync in interface AmazonRDSAsyncpublic Future<DBInstance> deleteDBInstanceAsync(DeleteDBInstanceRequest request, AsyncHandler<DeleteDBInstanceRequest,DBInstance> asyncHandler)
AmazonRDSAsync
The DeleteDBInstance action deletes a previously provisioned DB instance. When you delete a DB instance, all
automated backups for that instance are deleted and can't be recovered. Manual DB snapshots of the DB instance to
be deleted by DeleteDBInstance are not deleted.
If you request a final DB snapshot the status of the Amazon RDS DB instance is deleting until the DB
snapshot is created. The API action DescribeDBInstance is used to monitor the status of this
operation. The action can't be canceled or reverted once submitted.
When a DB instance is in a failure state and has a status of failed,
incompatible-restore, or incompatible-network, you can only delete it when you skip
creation of the final snapshot with the SkipFinalSnapshot parameter.
If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:
The DB cluster is a read replica of another Amazon Aurora DB cluster.
The DB instance is the only instance in the DB cluster.
To delete a DB instance in this case, first call the PromoteReadReplicaDBCluster API action to
promote the DB cluster so it's no longer a read replica. After the promotion completes, then call the
DeleteDBInstance API action to delete the final instance in the DB cluster.
deleteDBInstanceAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBInstanceAutomatedBackup> deleteDBInstanceAutomatedBackupAsync(DeleteDBInstanceAutomatedBackupRequest request)
AmazonRDSAsync
Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon
Resource Name (ARN) of the automated backups.
deleteDBInstanceAutomatedBackupAsync in interface AmazonRDSAsyncrequest - Parameter input for the DeleteDBInstanceAutomatedBackup operation.public Future<DBInstanceAutomatedBackup> deleteDBInstanceAutomatedBackupAsync(DeleteDBInstanceAutomatedBackupRequest request, AsyncHandler<DeleteDBInstanceAutomatedBackupRequest,DBInstanceAutomatedBackup> asyncHandler)
AmazonRDSAsync
Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon
Resource Name (ARN) of the automated backups.
deleteDBInstanceAutomatedBackupAsync in interface AmazonRDSAsyncrequest - Parameter input for the DeleteDBInstanceAutomatedBackup operation.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDBParameterGroupResult> deleteDBParameterGroupAsync(DeleteDBParameterGroupRequest request)
AmazonRDSAsyncDeletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
deleteDBParameterGroupAsync in interface AmazonRDSAsyncpublic Future<DeleteDBParameterGroupResult> deleteDBParameterGroupAsync(DeleteDBParameterGroupRequest request, AsyncHandler<DeleteDBParameterGroupRequest,DeleteDBParameterGroupResult> asyncHandler)
AmazonRDSAsyncDeletes a specified DB parameter group. The DB parameter group to be deleted can't be associated with any DB instances.
deleteDBParameterGroupAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDBProxyResult> deleteDBProxyAsync(DeleteDBProxyRequest request)
AmazonRDSAsyncDeletes an existing DB proxy.
deleteDBProxyAsync in interface AmazonRDSAsyncpublic Future<DeleteDBProxyResult> deleteDBProxyAsync(DeleteDBProxyRequest request, AsyncHandler<DeleteDBProxyRequest,DeleteDBProxyResult> asyncHandler)
AmazonRDSAsyncDeletes an existing DB proxy.
deleteDBProxyAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDBProxyEndpointResult> deleteDBProxyEndpointAsync(DeleteDBProxyEndpointRequest request)
AmazonRDSAsync
Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint
that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only
operations, or using a different VPC than the DB proxy's default VPC.
deleteDBProxyEndpointAsync in interface AmazonRDSAsyncpublic Future<DeleteDBProxyEndpointResult> deleteDBProxyEndpointAsync(DeleteDBProxyEndpointRequest request, AsyncHandler<DeleteDBProxyEndpointRequest,DeleteDBProxyEndpointResult> asyncHandler)
AmazonRDSAsync
Deletes a DBProxyEndpoint. Doing so removes the ability to access the DB proxy using the endpoint
that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only
operations, or using a different VPC than the DB proxy's default VPC.
deleteDBProxyEndpointAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDBSecurityGroupResult> deleteDBSecurityGroupAsync(DeleteDBSecurityGroupRequest request)
AmazonRDSAsyncDeletes a DB security group.
The specified DB security group must not be associated with any DB instances.
deleteDBSecurityGroupAsync in interface AmazonRDSAsyncpublic Future<DeleteDBSecurityGroupResult> deleteDBSecurityGroupAsync(DeleteDBSecurityGroupRequest request, AsyncHandler<DeleteDBSecurityGroupRequest,DeleteDBSecurityGroupResult> asyncHandler)
AmazonRDSAsyncDeletes a DB security group.
The specified DB security group must not be associated with any DB instances.
deleteDBSecurityGroupAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBSnapshot> deleteDBSnapshotAsync(DeleteDBSnapshotRequest request)
AmazonRDSAsyncDeletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB snapshot must be in the available state to be deleted.
deleteDBSnapshotAsync in interface AmazonRDSAsyncpublic Future<DBSnapshot> deleteDBSnapshotAsync(DeleteDBSnapshotRequest request, AsyncHandler<DeleteDBSnapshotRequest,DBSnapshot> asyncHandler)
AmazonRDSAsyncDeletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.
The DB snapshot must be in the available state to be deleted.
deleteDBSnapshotAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteDBSubnetGroupResult> deleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest request)
AmazonRDSAsyncDeletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroupAsync in interface AmazonRDSAsyncpublic Future<DeleteDBSubnetGroupResult> deleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest request, AsyncHandler<DeleteDBSubnetGroupRequest,DeleteDBSubnetGroupResult> asyncHandler)
AmazonRDSAsyncDeletes a DB subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroupAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<EventSubscription> deleteEventSubscriptionAsync(DeleteEventSubscriptionRequest request)
AmazonRDSAsyncDeletes an RDS event notification subscription.
deleteEventSubscriptionAsync in interface AmazonRDSAsyncpublic Future<EventSubscription> deleteEventSubscriptionAsync(DeleteEventSubscriptionRequest request, AsyncHandler<DeleteEventSubscriptionRequest,EventSubscription> asyncHandler)
AmazonRDSAsyncDeletes an RDS event notification subscription.
deleteEventSubscriptionAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<GlobalCluster> deleteGlobalClusterAsync(DeleteGlobalClusterRequest request)
AmazonRDSAsyncDeletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.
This action only applies to Aurora DB clusters.
deleteGlobalClusterAsync in interface AmazonRDSAsyncpublic Future<GlobalCluster> deleteGlobalClusterAsync(DeleteGlobalClusterRequest request, AsyncHandler<DeleteGlobalClusterRequest,GlobalCluster> asyncHandler)
AmazonRDSAsyncDeletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.
This action only applies to Aurora DB clusters.
deleteGlobalClusterAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeleteOptionGroupResult> deleteOptionGroupAsync(DeleteOptionGroupRequest request)
AmazonRDSAsyncDeletes an existing option group.
deleteOptionGroupAsync in interface AmazonRDSAsyncpublic Future<DeleteOptionGroupResult> deleteOptionGroupAsync(DeleteOptionGroupRequest request, AsyncHandler<DeleteOptionGroupRequest,DeleteOptionGroupResult> asyncHandler)
AmazonRDSAsyncDeletes an existing option group.
deleteOptionGroupAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DeregisterDBProxyTargetsResult> deregisterDBProxyTargetsAsync(DeregisterDBProxyTargetsRequest request)
AmazonRDSAsync
Remove the association between one or more DBProxyTarget data structures and a
DBProxyTargetGroup.
deregisterDBProxyTargetsAsync in interface AmazonRDSAsyncpublic Future<DeregisterDBProxyTargetsResult> deregisterDBProxyTargetsAsync(DeregisterDBProxyTargetsRequest request, AsyncHandler<DeregisterDBProxyTargetsRequest,DeregisterDBProxyTargetsResult> asyncHandler)
AmazonRDSAsync
Remove the association between one or more DBProxyTarget data structures and a
DBProxyTargetGroup.
deregisterDBProxyTargetsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAccountAttributesResult> describeAccountAttributesAsync(DescribeAccountAttributesRequest request)
AmazonRDSAsyncLists 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 doesn't take any parameters.
describeAccountAttributesAsync in interface AmazonRDSAsyncpublic Future<DescribeAccountAttributesResult> describeAccountAttributesAsync(DescribeAccountAttributesRequest request, AsyncHandler<DescribeAccountAttributesRequest,DescribeAccountAttributesResult> asyncHandler)
AmazonRDSAsyncLists 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 doesn't take any parameters.
describeAccountAttributesAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeAccountAttributesResult> describeAccountAttributesAsync()
describeAccountAttributesAsync in interface AmazonRDSAsyncdescribeAccountAttributesAsync(DescribeAccountAttributesRequest)public Future<DescribeAccountAttributesResult> describeAccountAttributesAsync(AsyncHandler<DescribeAccountAttributesRequest,DescribeAccountAttributesResult> asyncHandler)
describeAccountAttributesAsync in interface AmazonRDSAsyncdescribeAccountAttributesAsync(DescribeAccountAttributesRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeCertificatesResult> describeCertificatesAsync(DescribeCertificatesRequest request)
AmazonRDSAsyncLists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
describeCertificatesAsync in interface AmazonRDSAsyncpublic Future<DescribeCertificatesResult> describeCertificatesAsync(DescribeCertificatesRequest request, AsyncHandler<DescribeCertificatesRequest,DescribeCertificatesResult> asyncHandler)
AmazonRDSAsyncLists the set of CA certificates provided by Amazon RDS for this Amazon Web Services account.
describeCertificatesAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeCertificatesResult> describeCertificatesAsync()
describeCertificatesAsync in interface AmazonRDSAsyncdescribeCertificatesAsync(DescribeCertificatesRequest)public Future<DescribeCertificatesResult> describeCertificatesAsync(AsyncHandler<DescribeCertificatesRequest,DescribeCertificatesResult> asyncHandler)
describeCertificatesAsync in interface AmazonRDSAsyncdescribeCertificatesAsync(DescribeCertificatesRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeDBClusterBacktracksResult> describeDBClusterBacktracksAsync(DescribeDBClusterBacktracksRequest request)
AmazonRDSAsyncReturns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
describeDBClusterBacktracksAsync in interface AmazonRDSAsyncpublic Future<DescribeDBClusterBacktracksResult> describeDBClusterBacktracksAsync(DescribeDBClusterBacktracksRequest request, AsyncHandler<DescribeDBClusterBacktracksRequest,DescribeDBClusterBacktracksResult> asyncHandler)
AmazonRDSAsyncReturns information about backtracks for a DB cluster.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora MySQL DB clusters.
describeDBClusterBacktracksAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBClusterEndpointsResult> describeDBClusterEndpointsAsync(DescribeDBClusterEndpointsRequest request)
AmazonRDSAsyncReturns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
describeDBClusterEndpointsAsync in interface AmazonRDSAsyncpublic Future<DescribeDBClusterEndpointsResult> describeDBClusterEndpointsAsync(DescribeDBClusterEndpointsRequest request, AsyncHandler<DescribeDBClusterEndpointsRequest,DescribeDBClusterEndpointsResult> asyncHandler)
AmazonRDSAsyncReturns information about endpoints for an Amazon Aurora DB cluster.
This action only applies to Aurora DB clusters.
describeDBClusterEndpointsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBClusterParameterGroupsResult> describeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest request)
AmazonRDSAsync
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 What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
describeDBClusterParameterGroupsAsync in interface AmazonRDSAsyncpublic Future<DescribeDBClusterParameterGroupsResult> describeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest request, AsyncHandler<DescribeDBClusterParameterGroupsRequest,DescribeDBClusterParameterGroupsResult> asyncHandler)
AmazonRDSAsync
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 What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
describeDBClusterParameterGroupsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBClusterParameterGroupsResult> describeDBClusterParameterGroupsAsync()
describeDBClusterParameterGroupsAsync in interface AmazonRDSAsyncdescribeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest)public Future<DescribeDBClusterParameterGroupsResult> describeDBClusterParameterGroupsAsync(AsyncHandler<DescribeDBClusterParameterGroupsRequest,DescribeDBClusterParameterGroupsResult> asyncHandler)
public Future<DescribeDBClusterParametersResult> describeDBClusterParametersAsync(DescribeDBClusterParametersRequest request)
AmazonRDSAsyncReturns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
describeDBClusterParametersAsync in interface AmazonRDSAsyncpublic Future<DescribeDBClusterParametersResult> describeDBClusterParametersAsync(DescribeDBClusterParametersRequest request, AsyncHandler<DescribeDBClusterParametersRequest,DescribeDBClusterParametersResult> asyncHandler)
AmazonRDSAsyncReturns the detailed parameter list for a particular DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
describeDBClusterParametersAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBClusterSnapshotAttributesResult> describeDBClusterSnapshotAttributesAsync(DescribeDBClusterSnapshotAttributesRequest request)
AmazonRDSAsyncReturns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes
returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are
authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of
values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or
restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to
make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API
action.
describeDBClusterSnapshotAttributesAsync in interface AmazonRDSAsyncpublic Future<DBClusterSnapshotAttributesResult> describeDBClusterSnapshotAttributesAsync(DescribeDBClusterSnapshotAttributesRequest request, AsyncHandler<DescribeDBClusterSnapshotAttributesRequest,DBClusterSnapshotAttributesResult> asyncHandler)
AmazonRDSAsyncReturns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBClusterSnapshotAttributes
returns the restore attribute and a list of IDs for the Amazon Web Services accounts that are
authorized to copy or restore the manual DB cluster snapshot. If all is included in the list of
values for the restore attribute, then the manual DB cluster snapshot is public and can be copied or
restored by all Amazon Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB cluster snapshot, or to
make the manual DB cluster snapshot public or private, use the ModifyDBClusterSnapshotAttribute API
action.
describeDBClusterSnapshotAttributesAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBClusterSnapshotsResult> describeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest request)
AmazonRDSAsyncReturns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
describeDBClusterSnapshotsAsync in interface AmazonRDSAsyncpublic Future<DescribeDBClusterSnapshotsResult> describeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest request, AsyncHandler<DescribeDBClusterSnapshotsRequest,DescribeDBClusterSnapshotsResult> asyncHandler)
AmazonRDSAsyncReturns information about DB cluster snapshots. This API action supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
describeDBClusterSnapshotsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBClusterSnapshotsResult> describeDBClusterSnapshotsAsync()
describeDBClusterSnapshotsAsync in interface AmazonRDSAsyncdescribeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest)public Future<DescribeDBClusterSnapshotsResult> describeDBClusterSnapshotsAsync(AsyncHandler<DescribeDBClusterSnapshotsRequest,DescribeDBClusterSnapshotsResult> asyncHandler)
describeDBClusterSnapshotsAsync in interface AmazonRDSAsyncdescribeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeDBClustersResult> describeDBClustersAsync(DescribeDBClustersRequest request)
AmazonRDSAsyncReturns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
describeDBClustersAsync in interface AmazonRDSAsyncpublic Future<DescribeDBClustersResult> describeDBClustersAsync(DescribeDBClustersRequest request, AsyncHandler<DescribeDBClustersRequest,DescribeDBClustersResult> asyncHandler)
AmazonRDSAsyncReturns information about Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.
For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
describeDBClustersAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBClustersResult> describeDBClustersAsync()
describeDBClustersAsync in interface AmazonRDSAsyncdescribeDBClustersAsync(DescribeDBClustersRequest)public Future<DescribeDBClustersResult> describeDBClustersAsync(AsyncHandler<DescribeDBClustersRequest,DescribeDBClustersResult> asyncHandler)
describeDBClustersAsync in interface AmazonRDSAsyncdescribeDBClustersAsync(DescribeDBClustersRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest request)
AmazonRDSAsyncReturns a list of the available DB engines.
describeDBEngineVersionsAsync in interface AmazonRDSAsyncpublic Future<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest request, AsyncHandler<DescribeDBEngineVersionsRequest,DescribeDBEngineVersionsResult> asyncHandler)
AmazonRDSAsyncReturns a list of the available DB engines.
describeDBEngineVersionsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync()
describeDBEngineVersionsAsync in interface AmazonRDSAsyncdescribeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest)public Future<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync(AsyncHandler<DescribeDBEngineVersionsRequest,DescribeDBEngineVersionsResult> asyncHandler)
describeDBEngineVersionsAsync in interface AmazonRDSAsyncdescribeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeDBInstanceAutomatedBackupsResult> describeDBInstanceAutomatedBackupsAsync(DescribeDBInstanceAutomatedBackupsRequest request)
AmazonRDSAsync
Displays backups for both current and deleted instances. For example, use this operation to find details about
automated backups for previously deleted instances. Current instances with retention periods greater than zero
(0) are returned for both the DescribeDBInstanceAutomatedBackups and
DescribeDBInstances operations.
All parameters are optional.
describeDBInstanceAutomatedBackupsAsync in interface AmazonRDSAsyncrequest - Parameter input for DescribeDBInstanceAutomatedBackups.public Future<DescribeDBInstanceAutomatedBackupsResult> describeDBInstanceAutomatedBackupsAsync(DescribeDBInstanceAutomatedBackupsRequest request, AsyncHandler<DescribeDBInstanceAutomatedBackupsRequest,DescribeDBInstanceAutomatedBackupsResult> asyncHandler)
AmazonRDSAsync
Displays backups for both current and deleted instances. For example, use this operation to find details about
automated backups for previously deleted instances. Current instances with retention periods greater than zero
(0) are returned for both the DescribeDBInstanceAutomatedBackups and
DescribeDBInstances operations.
All parameters are optional.
describeDBInstanceAutomatedBackupsAsync in interface AmazonRDSAsyncrequest - Parameter input for DescribeDBInstanceAutomatedBackups.asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBInstancesResult> describeDBInstancesAsync(DescribeDBInstancesRequest request)
AmazonRDSAsyncReturns information about provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
describeDBInstancesAsync in interface AmazonRDSAsyncpublic Future<DescribeDBInstancesResult> describeDBInstancesAsync(DescribeDBInstancesRequest request, AsyncHandler<DescribeDBInstancesRequest,DescribeDBInstancesResult> asyncHandler)
AmazonRDSAsyncReturns information about provisioned RDS instances. This API supports pagination.
This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.
describeDBInstancesAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBInstancesResult> describeDBInstancesAsync()
describeDBInstancesAsync in interface AmazonRDSAsyncdescribeDBInstancesAsync(DescribeDBInstancesRequest)public Future<DescribeDBInstancesResult> describeDBInstancesAsync(AsyncHandler<DescribeDBInstancesRequest,DescribeDBInstancesResult> asyncHandler)
describeDBInstancesAsync in interface AmazonRDSAsyncdescribeDBInstancesAsync(DescribeDBInstancesRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeDBLogFilesResult> describeDBLogFilesAsync(DescribeDBLogFilesRequest request)
AmazonRDSAsyncReturns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
describeDBLogFilesAsync in interface AmazonRDSAsyncpublic Future<DescribeDBLogFilesResult> describeDBLogFilesAsync(DescribeDBLogFilesRequest request, AsyncHandler<DescribeDBLogFilesRequest,DescribeDBLogFilesResult> asyncHandler)
AmazonRDSAsyncReturns a list of DB log files for the DB instance.
This command doesn't apply to RDS Custom.
describeDBLogFilesAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBParameterGroupsResult> describeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest request)
AmazonRDSAsync
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is
specified, the list will contain only the description of the specified DB parameter group.
describeDBParameterGroupsAsync in interface AmazonRDSAsyncpublic Future<DescribeDBParameterGroupsResult> describeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest request, AsyncHandler<DescribeDBParameterGroupsRequest,DescribeDBParameterGroupsResult> asyncHandler)
AmazonRDSAsync
Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is
specified, the list will contain only the description of the specified DB parameter group.
describeDBParameterGroupsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBParameterGroupsResult> describeDBParameterGroupsAsync()
describeDBParameterGroupsAsync in interface AmazonRDSAsyncdescribeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest)public Future<DescribeDBParameterGroupsResult> describeDBParameterGroupsAsync(AsyncHandler<DescribeDBParameterGroupsRequest,DescribeDBParameterGroupsResult> asyncHandler)
describeDBParameterGroupsAsync in interface AmazonRDSAsyncdescribeDBParameterGroupsAsync(DescribeDBParameterGroupsRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeDBParametersResult> describeDBParametersAsync(DescribeDBParametersRequest request)
AmazonRDSAsyncReturns the detailed parameter list for a particular DB parameter group.
describeDBParametersAsync in interface AmazonRDSAsyncpublic Future<DescribeDBParametersResult> describeDBParametersAsync(DescribeDBParametersRequest request, AsyncHandler<DescribeDBParametersRequest,DescribeDBParametersResult> asyncHandler)
AmazonRDSAsyncReturns the detailed parameter list for a particular DB parameter group.
describeDBParametersAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBProxiesResult> describeDBProxiesAsync(DescribeDBProxiesRequest request)
AmazonRDSAsyncReturns information about DB proxies.
describeDBProxiesAsync in interface AmazonRDSAsyncpublic Future<DescribeDBProxiesResult> describeDBProxiesAsync(DescribeDBProxiesRequest request, AsyncHandler<DescribeDBProxiesRequest,DescribeDBProxiesResult> asyncHandler)
AmazonRDSAsyncReturns information about DB proxies.
describeDBProxiesAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBProxyEndpointsResult> describeDBProxyEndpointsAsync(DescribeDBProxyEndpointsRequest request)
AmazonRDSAsyncReturns information about DB proxy endpoints.
describeDBProxyEndpointsAsync in interface AmazonRDSAsyncpublic Future<DescribeDBProxyEndpointsResult> describeDBProxyEndpointsAsync(DescribeDBProxyEndpointsRequest request, AsyncHandler<DescribeDBProxyEndpointsRequest,DescribeDBProxyEndpointsResult> asyncHandler)
AmazonRDSAsyncReturns information about DB proxy endpoints.
describeDBProxyEndpointsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBProxyTargetGroupsResult> describeDBProxyTargetGroupsAsync(DescribeDBProxyTargetGroupsRequest request)
AmazonRDSAsync
Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
describeDBProxyTargetGroupsAsync in interface AmazonRDSAsyncpublic Future<DescribeDBProxyTargetGroupsResult> describeDBProxyTargetGroupsAsync(DescribeDBProxyTargetGroupsRequest request, AsyncHandler<DescribeDBProxyTargetGroupsRequest,DescribeDBProxyTargetGroupsResult> asyncHandler)
AmazonRDSAsync
Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.
describeDBProxyTargetGroupsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBProxyTargetsResult> describeDBProxyTargetsAsync(DescribeDBProxyTargetsRequest request)
AmazonRDSAsync
Returns information about DBProxyTarget objects. This API supports pagination.
describeDBProxyTargetsAsync in interface AmazonRDSAsyncpublic Future<DescribeDBProxyTargetsResult> describeDBProxyTargetsAsync(DescribeDBProxyTargetsRequest request, AsyncHandler<DescribeDBProxyTargetsRequest,DescribeDBProxyTargetsResult> asyncHandler)
AmazonRDSAsync
Returns information about DBProxyTarget objects. This API supports pagination.
describeDBProxyTargetsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBSecurityGroupsResult> describeDBSecurityGroupsAsync(DescribeDBSecurityGroupsRequest request)
AmazonRDSAsync
Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,
the list will contain only the descriptions of the specified DB security group.
describeDBSecurityGroupsAsync in interface AmazonRDSAsyncpublic Future<DescribeDBSecurityGroupsResult> describeDBSecurityGroupsAsync(DescribeDBSecurityGroupsRequest request, AsyncHandler<DescribeDBSecurityGroupsRequest,DescribeDBSecurityGroupsResult> asyncHandler)
AmazonRDSAsync
Returns a list of DBSecurityGroup descriptions. If a DBSecurityGroupName is specified,
the list will contain only the descriptions of the specified DB security group.
describeDBSecurityGroupsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBSecurityGroupsResult> describeDBSecurityGroupsAsync()
describeDBSecurityGroupsAsync in interface AmazonRDSAsyncdescribeDBSecurityGroupsAsync(DescribeDBSecurityGroupsRequest)public Future<DescribeDBSecurityGroupsResult> describeDBSecurityGroupsAsync(AsyncHandler<DescribeDBSecurityGroupsRequest,DescribeDBSecurityGroupsResult> asyncHandler)
describeDBSecurityGroupsAsync in interface AmazonRDSAsyncdescribeDBSecurityGroupsAsync(DescribeDBSecurityGroupsRequest, com.amazonaws.handlers.AsyncHandler)public Future<DBSnapshotAttributesResult> describeDBSnapshotAttributesAsync(DescribeDBSnapshotAttributesRequest request)
AmazonRDSAsyncReturns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns
the restore attribute and a list of IDs for the Amazon Web Services accounts 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 Amazon
Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make
the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
describeDBSnapshotAttributesAsync in interface AmazonRDSAsyncpublic Future<DBSnapshotAttributesResult> describeDBSnapshotAttributesAsync(DescribeDBSnapshotAttributesRequest request, AsyncHandler<DescribeDBSnapshotAttributesRequest,DBSnapshotAttributesResult> asyncHandler)
AmazonRDSAsyncReturns a list of DB snapshot attribute names and values for a manual DB snapshot.
When sharing snapshots with other Amazon Web Services accounts, DescribeDBSnapshotAttributes returns
the restore attribute and a list of IDs for the Amazon Web Services accounts 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 Amazon
Web Services accounts.
To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make
the manual DB snapshot public or private, use the ModifyDBSnapshotAttribute API action.
describeDBSnapshotAttributesAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBSnapshotAttributesResult> describeDBSnapshotAttributesAsync()
describeDBSnapshotAttributesAsync in interface AmazonRDSAsyncdescribeDBSnapshotAttributesAsync(DescribeDBSnapshotAttributesRequest)public Future<DBSnapshotAttributesResult> describeDBSnapshotAttributesAsync(AsyncHandler<DescribeDBSnapshotAttributesRequest,DBSnapshotAttributesResult> asyncHandler)
describeDBSnapshotAttributesAsync in interface AmazonRDSAsyncdescribeDBSnapshotAttributesAsync(DescribeDBSnapshotAttributesRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeDBSnapshotsResult> describeDBSnapshotsAsync(DescribeDBSnapshotsRequest request)
AmazonRDSAsyncReturns information about DB snapshots. This API action supports pagination.
describeDBSnapshotsAsync in interface AmazonRDSAsyncpublic Future<DescribeDBSnapshotsResult> describeDBSnapshotsAsync(DescribeDBSnapshotsRequest request, AsyncHandler<DescribeDBSnapshotsRequest,DescribeDBSnapshotsResult> asyncHandler)
AmazonRDSAsyncReturns information about DB snapshots. This API action supports pagination.
describeDBSnapshotsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBSnapshotsResult> describeDBSnapshotsAsync()
describeDBSnapshotsAsync in interface AmazonRDSAsyncdescribeDBSnapshotsAsync(DescribeDBSnapshotsRequest)public Future<DescribeDBSnapshotsResult> describeDBSnapshotsAsync(AsyncHandler<DescribeDBSnapshotsRequest,DescribeDBSnapshotsResult> asyncHandler)
describeDBSnapshotsAsync in interface AmazonRDSAsyncdescribeDBSnapshotsAsync(DescribeDBSnapshotsRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeDBSubnetGroupsResult> describeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest request)
AmazonRDSAsyncReturns 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.
describeDBSubnetGroupsAsync in interface AmazonRDSAsyncpublic Future<DescribeDBSubnetGroupsResult> describeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest request, AsyncHandler<DescribeDBSubnetGroupsRequest,DescribeDBSubnetGroupsResult> asyncHandler)
AmazonRDSAsyncReturns 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.
describeDBSubnetGroupsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeDBSubnetGroupsResult> describeDBSubnetGroupsAsync()
describeDBSubnetGroupsAsync in interface AmazonRDSAsyncdescribeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest)public Future<DescribeDBSubnetGroupsResult> describeDBSubnetGroupsAsync(AsyncHandler<DescribeDBSubnetGroupsRequest,DescribeDBSubnetGroupsResult> asyncHandler)
describeDBSubnetGroupsAsync in interface AmazonRDSAsyncdescribeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest, com.amazonaws.handlers.AsyncHandler)public Future<EngineDefaults> describeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest request)
AmazonRDSAsyncReturns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
describeEngineDefaultClusterParametersAsync in interface AmazonRDSAsyncpublic Future<EngineDefaults> describeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest request, AsyncHandler<DescribeEngineDefaultClusterParametersRequest,EngineDefaults> asyncHandler)
AmazonRDSAsyncReturns the default engine and system parameter information for the cluster database engine.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
describeEngineDefaultClusterParametersAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<EngineDefaults> describeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest request)
AmazonRDSAsyncReturns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParametersAsync in interface AmazonRDSAsyncpublic Future<EngineDefaults> describeEngineDefaultParametersAsync(DescribeEngineDefaultParametersRequest request, AsyncHandler<DescribeEngineDefaultParametersRequest,EngineDefaults> asyncHandler)
AmazonRDSAsyncReturns the default engine and system parameter information for the specified database engine.
describeEngineDefaultParametersAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeEventCategoriesResult> describeEventCategoriesAsync(DescribeEventCategoriesRequest request)
AmazonRDSAsyncDisplays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .
describeEventCategoriesAsync in interface AmazonRDSAsyncpublic Future<DescribeEventCategoriesResult> describeEventCategoriesAsync(DescribeEventCategoriesRequest request, AsyncHandler<DescribeEventCategoriesRequest,DescribeEventCategoriesResult> asyncHandler)
AmazonRDSAsyncDisplays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .
describeEventCategoriesAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeEventCategoriesResult> describeEventCategoriesAsync()
describeEventCategoriesAsync in interface AmazonRDSAsyncdescribeEventCategoriesAsync(DescribeEventCategoriesRequest)public Future<DescribeEventCategoriesResult> describeEventCategoriesAsync(AsyncHandler<DescribeEventCategoriesRequest,DescribeEventCategoriesResult> asyncHandler)
describeEventCategoriesAsync in interface AmazonRDSAsyncdescribeEventCategoriesAsync(DescribeEventCategoriesRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeEventSubscriptionsResult> describeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest request)
AmazonRDSAsync
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.
describeEventSubscriptionsAsync in interface AmazonRDSAsyncpublic Future<DescribeEventSubscriptionsResult> describeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest request, AsyncHandler<DescribeEventSubscriptionsRequest,DescribeEventSubscriptionsResult> asyncHandler)
AmazonRDSAsync
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.
describeEventSubscriptionsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeEventSubscriptionsResult> describeEventSubscriptionsAsync()
describeEventSubscriptionsAsync in interface AmazonRDSAsyncdescribeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest)public Future<DescribeEventSubscriptionsResult> describeEventSubscriptionsAsync(AsyncHandler<DescribeEventSubscriptionsRequest,DescribeEventSubscriptionsResult> asyncHandler)
describeEventSubscriptionsAsync in interface AmazonRDSAsyncdescribeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest request)
AmazonRDSAsyncReturns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
By default, RDS returns events that were generated in the past hour.
describeEventsAsync in interface AmazonRDSAsyncpublic Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest request, AsyncHandler<DescribeEventsRequest,DescribeEventsResult> asyncHandler)
AmazonRDSAsyncReturns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.
By default, RDS returns events that were generated in the past hour.
describeEventsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeEventsResult> describeEventsAsync()
describeEventsAsync in interface AmazonRDSAsyncdescribeEventsAsync(DescribeEventsRequest)public Future<DescribeEventsResult> describeEventsAsync(AsyncHandler<DescribeEventsRequest,DescribeEventsResult> asyncHandler)
describeEventsAsync in interface AmazonRDSAsyncdescribeEventsAsync(DescribeEventsRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeExportTasksResult> describeExportTasksAsync(DescribeExportTasksRequest request)
AmazonRDSAsyncReturns information about a snapshot export to Amazon S3. This API operation supports pagination.
describeExportTasksAsync in interface AmazonRDSAsyncpublic Future<DescribeExportTasksResult> describeExportTasksAsync(DescribeExportTasksRequest request, AsyncHandler<DescribeExportTasksRequest,DescribeExportTasksResult> asyncHandler)
AmazonRDSAsyncReturns information about a snapshot export to Amazon S3. This API operation supports pagination.
describeExportTasksAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeGlobalClustersResult> describeGlobalClustersAsync(DescribeGlobalClustersRequest request)
AmazonRDSAsyncReturns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
describeGlobalClustersAsync in interface AmazonRDSAsyncpublic Future<DescribeGlobalClustersResult> describeGlobalClustersAsync(DescribeGlobalClustersRequest request, AsyncHandler<DescribeGlobalClustersRequest,DescribeGlobalClustersResult> asyncHandler)
AmazonRDSAsyncReturns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
This action only applies to Aurora DB clusters.
describeGlobalClustersAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeOptionGroupOptionsResult> describeOptionGroupOptionsAsync(DescribeOptionGroupOptionsRequest request)
AmazonRDSAsyncDescribes all available options.
describeOptionGroupOptionsAsync in interface AmazonRDSAsyncpublic Future<DescribeOptionGroupOptionsResult> describeOptionGroupOptionsAsync(DescribeOptionGroupOptionsRequest request, AsyncHandler<DescribeOptionGroupOptionsRequest,DescribeOptionGroupOptionsResult> asyncHandler)
AmazonRDSAsyncDescribes all available options.
describeOptionGroupOptionsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeOptionGroupsResult> describeOptionGroupsAsync(DescribeOptionGroupsRequest request)
AmazonRDSAsyncDescribes the available option groups.
describeOptionGroupsAsync in interface AmazonRDSAsyncpublic Future<DescribeOptionGroupsResult> describeOptionGroupsAsync(DescribeOptionGroupsRequest request, AsyncHandler<DescribeOptionGroupsRequest,DescribeOptionGroupsResult> asyncHandler)
AmazonRDSAsyncDescribes the available option groups.
describeOptionGroupsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeOptionGroupsResult> describeOptionGroupsAsync()
describeOptionGroupsAsync in interface AmazonRDSAsyncdescribeOptionGroupsAsync(DescribeOptionGroupsRequest)public Future<DescribeOptionGroupsResult> describeOptionGroupsAsync(AsyncHandler<DescribeOptionGroupsRequest,DescribeOptionGroupsResult> asyncHandler)
describeOptionGroupsAsync in interface AmazonRDSAsyncdescribeOptionGroupsAsync(DescribeOptionGroupsRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeOrderableDBInstanceOptionsResult> describeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest request)
AmazonRDSAsyncReturns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
describeOrderableDBInstanceOptionsAsync in interface AmazonRDSAsyncpublic Future<DescribeOrderableDBInstanceOptionsResult> describeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest request, AsyncHandler<DescribeOrderableDBInstanceOptionsRequest,DescribeOrderableDBInstanceOptionsResult> asyncHandler)
AmazonRDSAsyncReturns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.
describeOrderableDBInstanceOptionsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribePendingMaintenanceActionsResult> describePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest request)
AmazonRDSAsyncReturns a list of resources (for example, DB instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsAsync in interface AmazonRDSAsyncpublic Future<DescribePendingMaintenanceActionsResult> describePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest request, AsyncHandler<DescribePendingMaintenanceActionsRequest,DescribePendingMaintenanceActionsResult> asyncHandler)
AmazonRDSAsyncReturns a list of resources (for example, DB instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribePendingMaintenanceActionsResult> describePendingMaintenanceActionsAsync()
describePendingMaintenanceActionsAsync in interface AmazonRDSAsyncdescribePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest)public Future<DescribePendingMaintenanceActionsResult> describePendingMaintenanceActionsAsync(AsyncHandler<DescribePendingMaintenanceActionsRequest,DescribePendingMaintenanceActionsResult> asyncHandler)
public Future<DescribeReservedDBInstancesResult> describeReservedDBInstancesAsync(DescribeReservedDBInstancesRequest request)
AmazonRDSAsyncReturns information about reserved DB instances for this account, or about a specified reserved DB instance.
describeReservedDBInstancesAsync in interface AmazonRDSAsyncpublic Future<DescribeReservedDBInstancesResult> describeReservedDBInstancesAsync(DescribeReservedDBInstancesRequest request, AsyncHandler<DescribeReservedDBInstancesRequest,DescribeReservedDBInstancesResult> asyncHandler)
AmazonRDSAsyncReturns information about reserved DB instances for this account, or about a specified reserved DB instance.
describeReservedDBInstancesAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeReservedDBInstancesResult> describeReservedDBInstancesAsync()
describeReservedDBInstancesAsync in interface AmazonRDSAsyncdescribeReservedDBInstancesAsync(DescribeReservedDBInstancesRequest)public Future<DescribeReservedDBInstancesResult> describeReservedDBInstancesAsync(AsyncHandler<DescribeReservedDBInstancesRequest,DescribeReservedDBInstancesResult> asyncHandler)
describeReservedDBInstancesAsync in interface AmazonRDSAsyncdescribeReservedDBInstancesAsync(DescribeReservedDBInstancesRequest, com.amazonaws.handlers.AsyncHandler)public Future<DescribeReservedDBInstancesOfferingsResult> describeReservedDBInstancesOfferingsAsync(DescribeReservedDBInstancesOfferingsRequest request)
AmazonRDSAsyncLists available reserved DB instance offerings.
describeReservedDBInstancesOfferingsAsync in interface AmazonRDSAsyncpublic Future<DescribeReservedDBInstancesOfferingsResult> describeReservedDBInstancesOfferingsAsync(DescribeReservedDBInstancesOfferingsRequest request, AsyncHandler<DescribeReservedDBInstancesOfferingsRequest,DescribeReservedDBInstancesOfferingsResult> asyncHandler)
AmazonRDSAsyncLists available reserved DB instance offerings.
describeReservedDBInstancesOfferingsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DescribeReservedDBInstancesOfferingsResult> describeReservedDBInstancesOfferingsAsync()
describeReservedDBInstancesOfferingsAsync in interface AmazonRDSAsyncdescribeReservedDBInstancesOfferingsAsync(DescribeReservedDBInstancesOfferingsRequest)public Future<DescribeReservedDBInstancesOfferingsResult> describeReservedDBInstancesOfferingsAsync(AsyncHandler<DescribeReservedDBInstancesOfferingsRequest,DescribeReservedDBInstancesOfferingsResult> asyncHandler)
public Future<DescribeSourceRegionsResult> describeSourceRegionsAsync(DescribeSourceRegionsRequest request)
AmazonRDSAsyncReturns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.
describeSourceRegionsAsync in interface AmazonRDSAsyncpublic Future<DescribeSourceRegionsResult> describeSourceRegionsAsync(DescribeSourceRegionsRequest request, AsyncHandler<DescribeSourceRegionsRequest,DescribeSourceRegionsResult> asyncHandler)
AmazonRDSAsyncReturns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. This API action supports pagination.
describeSourceRegionsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<ValidDBInstanceModificationsMessage> describeValidDBInstanceModificationsAsync(DescribeValidDBInstanceModificationsRequest request)
AmazonRDSAsync
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your
DB instance. You can use this information when you call ModifyDBInstance.
This command doesn't apply to RDS Custom.
describeValidDBInstanceModificationsAsync in interface AmazonRDSAsyncpublic Future<ValidDBInstanceModificationsMessage> describeValidDBInstanceModificationsAsync(DescribeValidDBInstanceModificationsRequest request, AsyncHandler<DescribeValidDBInstanceModificationsRequest,ValidDBInstanceModificationsMessage> asyncHandler)
AmazonRDSAsync
You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your
DB instance. You can use this information when you call ModifyDBInstance.
This command doesn't apply to RDS Custom.
describeValidDBInstanceModificationsAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DownloadDBLogFilePortionResult> downloadDBLogFilePortionAsync(DownloadDBLogFilePortionRequest request)
AmazonRDSAsyncDownloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
downloadDBLogFilePortionAsync in interface AmazonRDSAsyncpublic Future<DownloadDBLogFilePortionResult> downloadDBLogFilePortionAsync(DownloadDBLogFilePortionRequest request, AsyncHandler<DownloadDBLogFilePortionRequest,DownloadDBLogFilePortionResult> asyncHandler)
AmazonRDSAsyncDownloads all or a portion of the specified log file, up to 1 MB in size.
This command doesn't apply to RDS Custom.
downloadDBLogFilePortionAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.public Future<DBCluster> failoverDBClusterAsync(FailoverDBClusterRequest request)
AmazonRDSAsyncForces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure 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 DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
failoverDBClusterAsync in interface AmazonRDSAsyncpublic Future<DBCluster> failoverDBClusterAsync(FailoverDBClusterRequest request, AsyncHandler<FailoverDBClusterRequest,DBCluster> asyncHandler)
AmazonRDSAsyncForces a failover for a DB cluster.
For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).
An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readbable standby DB instance when the primary DB instance fails.
To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure 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 DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
failoverDBClusterAsync in interface AmazonRDSAsyncasyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an
implementation of the callback methods in this interface to receive notification of successful or
unsuccessful completion of the operation.