@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AmazonDocDBAsyncClient extends AmazonDocDBClient implements AmazonDocDBAsync
AsyncHandler
can be used to receive
notification when an asynchronous operation completes.
Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
addSourceIdentifierToSubscription, addTagsToResource, applyPendingMaintenanceAction, builder, copyDBClusterParameterGroup, copyDBClusterSnapshot, createDBCluster, createDBClusterParameterGroup, createDBClusterSnapshot, createDBInstance, createDBSubnetGroup, createEventSubscription, createGlobalCluster, deleteDBCluster, deleteDBClusterParameterGroup, deleteDBClusterSnapshot, deleteDBInstance, deleteDBSubnetGroup, deleteEventSubscription, deleteGlobalCluster, describeCertificates, describeDBClusterParameterGroups, describeDBClusterParameters, describeDBClusters, describeDBClusterSnapshotAttributes, describeDBClusterSnapshots, describeDBEngineVersions, describeDBInstances, describeDBSubnetGroups, describeEngineDefaultClusterParameters, describeEventCategories, describeEvents, describeEventSubscriptions, describeGlobalClusters, describeOrderableDBInstanceOptions, describePendingMaintenanceActions, failoverDBCluster, getCachedResponseMetadata, listTagsForResource, modifyDBCluster, modifyDBClusterParameterGroup, modifyDBClusterSnapshotAttribute, modifyDBInstance, modifyDBSubnetGroup, modifyEventSubscription, modifyGlobalCluster, rebootDBInstance, removeFromGlobalCluster, removeSourceIdentifierFromSubscription, removeTagsFromResource, resetDBClusterParameterGroup, restoreDBClusterFromSnapshot, restoreDBClusterToPointInTime, startDBCluster, stopDBCluster, switchoverGlobalCluster, waiters
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
addSourceIdentifierToSubscription, addTagsToResource, applyPendingMaintenanceAction, copyDBClusterParameterGroup, copyDBClusterSnapshot, createDBCluster, createDBClusterParameterGroup, createDBClusterSnapshot, createDBInstance, createDBSubnetGroup, createEventSubscription, createGlobalCluster, deleteDBCluster, deleteDBClusterParameterGroup, deleteDBClusterSnapshot, deleteDBInstance, deleteDBSubnetGroup, deleteEventSubscription, deleteGlobalCluster, describeCertificates, describeDBClusterParameterGroups, describeDBClusterParameters, describeDBClusters, describeDBClusterSnapshotAttributes, describeDBClusterSnapshots, describeDBEngineVersions, describeDBInstances, describeDBSubnetGroups, describeEngineDefaultClusterParameters, describeEventCategories, describeEvents, describeEventSubscriptions, describeGlobalClusters, describeOrderableDBInstanceOptions, describePendingMaintenanceActions, failoverDBCluster, getCachedResponseMetadata, listTagsForResource, modifyDBCluster, modifyDBClusterParameterGroup, modifyDBClusterSnapshotAttribute, modifyDBInstance, modifyDBSubnetGroup, modifyEventSubscription, modifyGlobalCluster, rebootDBInstance, removeFromGlobalCluster, removeSourceIdentifierFromSubscription, removeTagsFromResource, resetDBClusterParameterGroup, restoreDBClusterFromSnapshot, restoreDBClusterToPointInTime, startDBCluster, stopDBCluster, switchoverGlobalCluster, waiters
public static AmazonDocDBAsyncClientBuilder asyncBuilder()
public ExecutorService getExecutorService()
public Future<EventSubscription> addSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest request)
AmazonDocDBAsync
Adds a source identifier to an existing event notification subscription.
addSourceIdentifierToSubscriptionAsync
in interface AmazonDocDBAsync
request
- Represents the input to AddSourceIdentifierToSubscription.public Future<EventSubscription> addSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest request, AsyncHandler<AddSourceIdentifierToSubscriptionRequest,EventSubscription> asyncHandler)
AmazonDocDBAsync
Adds a source identifier to an existing event notification subscription.
addSourceIdentifierToSubscriptionAsync
in interface AmazonDocDBAsync
request
- Represents the input to AddSourceIdentifierToSubscription.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<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest request)
AmazonDocDBAsync
Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to
track costs that are associated with Amazon DocumentDB resources or in a Condition
statement in an
Identity and Access Management (IAM) policy for Amazon DocumentDB.
addTagsToResourceAsync
in interface AmazonDocDBAsync
request
- Represents the input to AddTagsToResource.public Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest request, AsyncHandler<AddTagsToResourceRequest,AddTagsToResourceResult> asyncHandler)
AmazonDocDBAsync
Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to
track costs that are associated with Amazon DocumentDB resources or in a Condition
statement in an
Identity and Access Management (IAM) policy for Amazon DocumentDB.
addTagsToResourceAsync
in interface AmazonDocDBAsync
request
- Represents the input to AddTagsToResource.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<ResourcePendingMaintenanceActions> applyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest request)
AmazonDocDBAsync
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
applyPendingMaintenanceActionAsync
in interface AmazonDocDBAsync
request
- Represents the input to ApplyPendingMaintenanceAction.public Future<ResourcePendingMaintenanceActions> applyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest request, AsyncHandler<ApplyPendingMaintenanceActionRequest,ResourcePendingMaintenanceActions> asyncHandler)
AmazonDocDBAsync
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
applyPendingMaintenanceActionAsync
in interface AmazonDocDBAsync
request
- Represents the input to ApplyPendingMaintenanceAction.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<DBClusterParameterGroup> copyDBClusterParameterGroupAsync(CopyDBClusterParameterGroupRequest request)
AmazonDocDBAsync
Copies the specified cluster parameter group.
copyDBClusterParameterGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to CopyDBClusterParameterGroup.public Future<DBClusterParameterGroup> copyDBClusterParameterGroupAsync(CopyDBClusterParameterGroupRequest request, AsyncHandler<CopyDBClusterParameterGroupRequest,DBClusterParameterGroup> asyncHandler)
AmazonDocDBAsync
Copies the specified cluster parameter group.
copyDBClusterParameterGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to CopyDBClusterParameterGroup.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<DBClusterSnapshot> copyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest request)
AmazonDocDBAsync
Copies a snapshot of a cluster.
To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster
snapshot, whether encrypted or not, in the same Amazon Web Services Region.
To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by
TargetDBClusterSnapshotIdentifier
while that cluster snapshot is in the copying status.
copyDBClusterSnapshotAsync
in interface AmazonDocDBAsync
request
- Represents the input to CopyDBClusterSnapshot.public Future<DBClusterSnapshot> copyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest request, AsyncHandler<CopyDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
AmazonDocDBAsync
Copies a snapshot of a cluster.
To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier
must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster
snapshot, whether encrypted or not, in the same Amazon Web Services Region.
To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by
TargetDBClusterSnapshotIdentifier
while that cluster snapshot is in the copying status.
copyDBClusterSnapshotAsync
in interface AmazonDocDBAsync
request
- Represents the input to CopyDBClusterSnapshot.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<DBCluster> createDBClusterAsync(CreateDBClusterRequest request)
AmazonDocDBAsync
Creates a new Amazon DocumentDB cluster.
createDBClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to CreateDBCluster.public Future<DBCluster> createDBClusterAsync(CreateDBClusterRequest request, AsyncHandler<CreateDBClusterRequest,DBCluster> asyncHandler)
AmazonDocDBAsync
Creates a new Amazon DocumentDB cluster.
createDBClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to CreateDBCluster.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<DBClusterParameterGroup> createDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest request)
AmazonDocDBAsync
Creates a new cluster parameter group.
Parameters in a cluster parameter group apply to all of the instances in a cluster.
A cluster parameter group is initially created with the default parameters for the database engine used by
instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the
default.docdb3.6
cluster parameter group. If your Amazon DocumentDB cluster is using the default
cluster parameter group and you want to modify a value in it, you must first create a
new parameter group or copy an
existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new
cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster
without failover. For more information, see
Modifying Amazon DocumentDB Cluster Parameter Groups.
createDBClusterParameterGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input of CreateDBClusterParameterGroup.public Future<DBClusterParameterGroup> createDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest request, AsyncHandler<CreateDBClusterParameterGroupRequest,DBClusterParameterGroup> asyncHandler)
AmazonDocDBAsync
Creates a new cluster parameter group.
Parameters in a cluster parameter group apply to all of the instances in a cluster.
A cluster parameter group is initially created with the default parameters for the database engine used by
instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the
default.docdb3.6
cluster parameter group. If your Amazon DocumentDB cluster is using the default
cluster parameter group and you want to modify a value in it, you must first create a
new parameter group or copy an
existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new
cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster
without failover. For more information, see
Modifying Amazon DocumentDB Cluster Parameter Groups.
createDBClusterParameterGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input of CreateDBClusterParameterGroup.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<DBClusterSnapshot> createDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest request)
AmazonDocDBAsync
Creates a snapshot of a cluster.
createDBClusterSnapshotAsync
in interface AmazonDocDBAsync
request
- Represents the input of CreateDBClusterSnapshot.public Future<DBClusterSnapshot> createDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest request, AsyncHandler<CreateDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
AmazonDocDBAsync
Creates a snapshot of a cluster.
createDBClusterSnapshotAsync
in interface AmazonDocDBAsync
request
- Represents the input of CreateDBClusterSnapshot.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<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest request)
AmazonDocDBAsync
Creates a new instance.
createDBInstanceAsync
in interface AmazonDocDBAsync
request
- Represents the input to CreateDBInstance.public Future<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest request, AsyncHandler<CreateDBInstanceRequest,DBInstance> asyncHandler)
AmazonDocDBAsync
Creates a new instance.
createDBInstanceAsync
in interface AmazonDocDBAsync
request
- Represents the input to CreateDBInstance.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<DBSubnetGroup> createDBSubnetGroupAsync(CreateDBSubnetGroupRequest request)
AmazonDocDBAsync
Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
createDBSubnetGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to CreateDBSubnetGroup.public Future<DBSubnetGroup> createDBSubnetGroupAsync(CreateDBSubnetGroupRequest request, AsyncHandler<CreateDBSubnetGroupRequest,DBSubnetGroup> asyncHandler)
AmazonDocDBAsync
Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
createDBSubnetGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to CreateDBSubnetGroup.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<EventSubscription> createEventSubscriptionAsync(CreateEventSubscriptionRequest request)
AmazonDocDBAsync
Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
You can specify the type of source (SourceType
) that you want to be notified of. You can also
provide a list of Amazon DocumentDB sources (SourceIds
) that trigger the events, and you can 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 SourceIdentifier = myDBInstance1
), you are notified of all
the db-instance
events for the specified source. If you specify a SourceType
but do not
specify a SourceIdentifier
, you receive notice of the events for that source type for all your
Amazon DocumentDB sources. If you do not specify either the SourceType
or the
SourceIdentifier
, you are notified of events generated from all Amazon DocumentDB sources belonging
to your customer account.
createEventSubscriptionAsync
in interface AmazonDocDBAsync
request
- Represents the input to CreateEventSubscription.public Future<EventSubscription> createEventSubscriptionAsync(CreateEventSubscriptionRequest request, AsyncHandler<CreateEventSubscriptionRequest,EventSubscription> asyncHandler)
AmazonDocDBAsync
Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
You can specify the type of source (SourceType
) that you want to be notified of. You can also
provide a list of Amazon DocumentDB sources (SourceIds
) that trigger the events, and you can 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 SourceIdentifier = myDBInstance1
), you are notified of all
the db-instance
events for the specified source. If you specify a SourceType
but do not
specify a SourceIdentifier
, you receive notice of the events for that source type for all your
Amazon DocumentDB sources. If you do not specify either the SourceType
or the
SourceIdentifier
, you are notified of events generated from all Amazon DocumentDB sources belonging
to your customer account.
createEventSubscriptionAsync
in interface AmazonDocDBAsync
request
- Represents the input to CreateEventSubscription.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<GlobalCluster> createGlobalClusterAsync(CreateGlobalClusterRequest request)
AmazonDocDBAsync
Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.
You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.
This action only applies to Amazon DocumentDB clusters.
createGlobalClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to CreateGlobalCluster.public Future<GlobalCluster> createGlobalClusterAsync(CreateGlobalClusterRequest request, AsyncHandler<CreateGlobalClusterRequest,GlobalCluster> asyncHandler)
AmazonDocDBAsync
Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.
You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.
This action only applies to Amazon DocumentDB clusters.
createGlobalClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to CreateGlobalCluster.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<DBCluster> deleteDBClusterAsync(DeleteDBClusterRequest request)
AmazonDocDBAsync
Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
deleteDBClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteDBCluster.public Future<DBCluster> deleteDBClusterAsync(DeleteDBClusterRequest request, AsyncHandler<DeleteDBClusterRequest,DBCluster> asyncHandler)
AmazonDocDBAsync
Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.
deleteDBClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteDBCluster.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<DeleteDBClusterParameterGroupResult> deleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest request)
AmazonDocDBAsync
Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
deleteDBClusterParameterGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteDBClusterParameterGroup.public Future<DeleteDBClusterParameterGroupResult> deleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest request, AsyncHandler<DeleteDBClusterParameterGroupRequest,DeleteDBClusterParameterGroupResult> asyncHandler)
AmazonDocDBAsync
Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
deleteDBClusterParameterGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteDBClusterParameterGroup.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<DBClusterSnapshot> deleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest request)
AmazonDocDBAsync
Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The cluster snapshot must be in the available
state to be deleted.
deleteDBClusterSnapshotAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteDBClusterSnapshot.public Future<DBClusterSnapshot> deleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest request, AsyncHandler<DeleteDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
AmazonDocDBAsync
Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
The cluster snapshot must be in the available
state to be deleted.
deleteDBClusterSnapshotAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteDBClusterSnapshot.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<DBInstance> deleteDBInstanceAsync(DeleteDBInstanceRequest request)
AmazonDocDBAsync
Deletes a previously provisioned instance.
deleteDBInstanceAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteDBInstance.public Future<DBInstance> deleteDBInstanceAsync(DeleteDBInstanceRequest request, AsyncHandler<DeleteDBInstanceRequest,DBInstance> asyncHandler)
AmazonDocDBAsync
Deletes a previously provisioned instance.
deleteDBInstanceAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteDBInstance.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<DeleteDBSubnetGroupResult> deleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest request)
AmazonDocDBAsync
Deletes a subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteDBSubnetGroup.public Future<DeleteDBSubnetGroupResult> deleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest request, AsyncHandler<DeleteDBSubnetGroupRequest,DeleteDBSubnetGroupResult> asyncHandler)
AmazonDocDBAsync
Deletes a subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteDBSubnetGroup.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<EventSubscription> deleteEventSubscriptionAsync(DeleteEventSubscriptionRequest request)
AmazonDocDBAsync
Deletes an Amazon DocumentDB event notification subscription.
deleteEventSubscriptionAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteEventSubscription.public Future<EventSubscription> deleteEventSubscriptionAsync(DeleteEventSubscriptionRequest request, AsyncHandler<DeleteEventSubscriptionRequest,EventSubscription> asyncHandler)
AmazonDocDBAsync
Deletes an Amazon DocumentDB event notification subscription.
deleteEventSubscriptionAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteEventSubscription.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<GlobalCluster> deleteGlobalClusterAsync(DeleteGlobalClusterRequest request)
AmazonDocDBAsync
Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.
This action only applies to Amazon DocumentDB clusters.
deleteGlobalClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteGlobalCluster.public Future<GlobalCluster> deleteGlobalClusterAsync(DeleteGlobalClusterRequest request, AsyncHandler<DeleteGlobalClusterRequest,GlobalCluster> asyncHandler)
AmazonDocDBAsync
Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.
This action only applies to Amazon DocumentDB clusters.
deleteGlobalClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to DeleteGlobalCluster.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<DescribeCertificatesResult> describeCertificatesAsync(DescribeCertificatesRequest request)
AmazonDocDBAsync
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
describeCertificatesAsync
in interface AmazonDocDBAsync
public Future<DescribeCertificatesResult> describeCertificatesAsync(DescribeCertificatesRequest request, AsyncHandler<DescribeCertificatesRequest,DescribeCertificatesResult> asyncHandler)
AmazonDocDBAsync
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
describeCertificatesAsync
in interface AmazonDocDBAsync
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<DescribeDBClusterParameterGroupsResult> describeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest request)
AmazonDocDBAsync
Returns a list of DBClusterParameterGroup
descriptions. If a
DBClusterParameterGroupName
parameter is specified, the list contains only the description of the
specified cluster parameter group.
describeDBClusterParameterGroupsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBClusterParameterGroups.public Future<DescribeDBClusterParameterGroupsResult> describeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest request, AsyncHandler<DescribeDBClusterParameterGroupsRequest,DescribeDBClusterParameterGroupsResult> asyncHandler)
AmazonDocDBAsync
Returns a list of DBClusterParameterGroup
descriptions. If a
DBClusterParameterGroupName
parameter is specified, the list contains only the description of the
specified cluster parameter group.
describeDBClusterParameterGroupsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBClusterParameterGroups.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<DescribeDBClusterParametersResult> describeDBClusterParametersAsync(DescribeDBClusterParametersRequest request)
AmazonDocDBAsync
Returns the detailed parameter list for a particular cluster parameter group.
describeDBClusterParametersAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBClusterParameters.public Future<DescribeDBClusterParametersResult> describeDBClusterParametersAsync(DescribeDBClusterParametersRequest request, AsyncHandler<DescribeDBClusterParametersRequest,DescribeDBClusterParametersResult> asyncHandler)
AmazonDocDBAsync
Returns the detailed parameter list for a particular cluster parameter group.
describeDBClusterParametersAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBClusterParameters.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<DBClusterSnapshotAttributesResult> describeDBClusterSnapshotAttributesAsync(DescribeDBClusterSnapshotAttributesRequest request)
AmazonDocDBAsync
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share 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 cluster snapshot. If
all
is included in the list of values for the restore
attribute, then the manual
cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
describeDBClusterSnapshotAttributesAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBClusterSnapshotAttributes.public Future<DBClusterSnapshotAttributesResult> describeDBClusterSnapshotAttributesAsync(DescribeDBClusterSnapshotAttributesRequest request, AsyncHandler<DescribeDBClusterSnapshotAttributesRequest,DBClusterSnapshotAttributesResult> asyncHandler)
AmazonDocDBAsync
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share 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 cluster snapshot. If
all
is included in the list of values for the restore
attribute, then the manual
cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
describeDBClusterSnapshotAttributesAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBClusterSnapshotAttributes.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<DescribeDBClusterSnapshotsResult> describeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest request)
AmazonDocDBAsync
Returns information about cluster snapshots. This API operation supports pagination.
describeDBClusterSnapshotsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBClusterSnapshots.public Future<DescribeDBClusterSnapshotsResult> describeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest request, AsyncHandler<DescribeDBClusterSnapshotsRequest,DescribeDBClusterSnapshotsResult> asyncHandler)
AmazonDocDBAsync
Returns information about cluster snapshots. This API operation supports pagination.
describeDBClusterSnapshotsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBClusterSnapshots.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<DescribeDBClustersResult> describeDBClustersAsync(DescribeDBClustersRequest request)
AmazonDocDBAsync
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb
filter parameter to return only Amazon DocumentDB clusters.
describeDBClustersAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBClusters.public Future<DescribeDBClustersResult> describeDBClustersAsync(DescribeDBClustersRequest request, AsyncHandler<DescribeDBClustersRequest,DescribeDBClustersResult> asyncHandler)
AmazonDocDBAsync
Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For
certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages
operational technology that is shared with Amazon RDS and Amazon Neptune. Use the
filterName=engine,Values=docdb
filter parameter to return only Amazon DocumentDB clusters.
describeDBClustersAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBClusters.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<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest request)
AmazonDocDBAsync
Returns a list of the available engines.
describeDBEngineVersionsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBEngineVersions.public Future<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest request, AsyncHandler<DescribeDBEngineVersionsRequest,DescribeDBEngineVersionsResult> asyncHandler)
AmazonDocDBAsync
Returns a list of the available engines.
describeDBEngineVersionsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBEngineVersions.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)
AmazonDocDBAsync
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
describeDBInstancesAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBInstances.public Future<DescribeDBInstancesResult> describeDBInstancesAsync(DescribeDBInstancesRequest request, AsyncHandler<DescribeDBInstancesRequest,DescribeDBInstancesResult> asyncHandler)
AmazonDocDBAsync
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
describeDBInstancesAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBInstances.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<DescribeDBSubnetGroupsResult> describeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest request)
AmazonDocDBAsync
Returns a list of DBSubnetGroup
descriptions. If a DBSubnetGroupName
is specified, the
list will contain only the descriptions of the specified DBSubnetGroup
.
describeDBSubnetGroupsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBSubnetGroups.public Future<DescribeDBSubnetGroupsResult> describeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest request, AsyncHandler<DescribeDBSubnetGroupsRequest,DescribeDBSubnetGroupsResult> asyncHandler)
AmazonDocDBAsync
Returns a list of DBSubnetGroup
descriptions. If a DBSubnetGroupName
is specified, the
list will contain only the descriptions of the specified DBSubnetGroup
.
describeDBSubnetGroupsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeDBSubnetGroups.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<EngineDefaults> describeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest request)
AmazonDocDBAsync
Returns the default engine and system parameter information for the cluster database engine.
describeEngineDefaultClusterParametersAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeEngineDefaultClusterParameters.public Future<EngineDefaults> describeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest request, AsyncHandler<DescribeEngineDefaultClusterParametersRequest,EngineDefaults> asyncHandler)
AmazonDocDBAsync
Returns the default engine and system parameter information for the cluster database engine.
describeEngineDefaultClusterParametersAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeEngineDefaultClusterParameters.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<DescribeEventCategoriesResult> describeEventCategoriesAsync(DescribeEventCategoriesRequest request)
AmazonDocDBAsync
Displays a list of categories for all event source types, or, if specified, for a specified source type.
describeEventCategoriesAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeEventCategories.public Future<DescribeEventCategoriesResult> describeEventCategoriesAsync(DescribeEventCategoriesRequest request, AsyncHandler<DescribeEventCategoriesRequest,DescribeEventCategoriesResult> asyncHandler)
AmazonDocDBAsync
Displays a list of categories for all event source types, or, if specified, for a specified source type.
describeEventCategoriesAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeEventCategories.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<DescribeEventSubscriptionsResult> describeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest request)
AmazonDocDBAsync
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 AmazonDocDBAsync
request
- Represents the input to DescribeEventSubscriptions.public Future<DescribeEventSubscriptionsResult> describeEventSubscriptionsAsync(DescribeEventSubscriptionsRequest request, AsyncHandler<DescribeEventSubscriptionsRequest,DescribeEventSubscriptionsResult> asyncHandler)
AmazonDocDBAsync
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 AmazonDocDBAsync
request
- Represents the input to DescribeEventSubscriptions.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<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest request)
AmazonDocDBAsync
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
describeEventsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeEvents.public Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest request, AsyncHandler<DescribeEventsRequest,DescribeEventsResult> asyncHandler)
AmazonDocDBAsync
Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.
describeEventsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeEvents.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<DescribeGlobalClustersResult> describeGlobalClustersAsync(DescribeGlobalClustersRequest request)
AmazonDocDBAsync
Returns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
describeGlobalClustersAsync
in interface AmazonDocDBAsync
public Future<DescribeGlobalClustersResult> describeGlobalClustersAsync(DescribeGlobalClustersRequest request, AsyncHandler<DescribeGlobalClustersRequest,DescribeGlobalClustersResult> asyncHandler)
AmazonDocDBAsync
Returns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
describeGlobalClustersAsync
in interface AmazonDocDBAsync
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<DescribeOrderableDBInstanceOptionsResult> describeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest request)
AmazonDocDBAsync
Returns a list of orderable instance options for the specified engine.
describeOrderableDBInstanceOptionsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeOrderableDBInstanceOptions.public Future<DescribeOrderableDBInstanceOptionsResult> describeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest request, AsyncHandler<DescribeOrderableDBInstanceOptionsRequest,DescribeOrderableDBInstanceOptionsResult> asyncHandler)
AmazonDocDBAsync
Returns a list of orderable instance options for the specified engine.
describeOrderableDBInstanceOptionsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribeOrderableDBInstanceOptions.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<DescribePendingMaintenanceActionsResult> describePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest request)
AmazonDocDBAsync
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribePendingMaintenanceActions.public Future<DescribePendingMaintenanceActionsResult> describePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest request, AsyncHandler<DescribePendingMaintenanceActionsRequest,DescribePendingMaintenanceActionsResult> asyncHandler)
AmazonDocDBAsync
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsAsync
in interface AmazonDocDBAsync
request
- Represents the input to DescribePendingMaintenanceActions.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<DBCluster> failoverDBClusterAsync(FailoverDBClusterRequest request)
AmazonDocDBAsync
Forces a failover for a cluster.
A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).
If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
failoverDBClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to FailoverDBCluster.public Future<DBCluster> failoverDBClusterAsync(FailoverDBClusterRequest request, AsyncHandler<FailoverDBClusterRequest,DBCluster> asyncHandler)
AmazonDocDBAsync
Forces a failover for a cluster.
A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).
If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.
failoverDBClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to FailoverDBCluster.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<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request)
AmazonDocDBAsync
Lists all tags on an Amazon DocumentDB resource.
listTagsForResourceAsync
in interface AmazonDocDBAsync
request
- Represents the input to ListTagsForResource.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonDocDBAsync
Lists all tags on an Amazon DocumentDB resource.
listTagsForResourceAsync
in interface AmazonDocDBAsync
request
- Represents the input to ListTagsForResource.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<DBCluster> modifyDBClusterAsync(ModifyDBClusterRequest request)
AmazonDocDBAsync
Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
modifyDBClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyDBCluster.public Future<DBCluster> modifyDBClusterAsync(ModifyDBClusterRequest request, AsyncHandler<ModifyDBClusterRequest,DBCluster> asyncHandler)
AmazonDocDBAsync
Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
modifyDBClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyDBCluster.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<ModifyDBClusterParameterGroupResult> modifyDBClusterParameterGroupAsync(ModifyDBClusterParameterGroupRequest request)
AmazonDocDBAsync
Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the
following: ParameterName
, ParameterValue
, and ApplyMethod
. A maximum of 20
parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.
After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster
that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully
complete the create action before the parameter group is used as the default for a new cluster. This step is
especially important for parameters that are critical when creating the default database for a cluster, such as
the character set for the default database defined by the character_set_database
parameter.
modifyDBClusterParameterGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyDBClusterParameterGroup.public Future<ModifyDBClusterParameterGroupResult> modifyDBClusterParameterGroupAsync(ModifyDBClusterParameterGroupRequest request, AsyncHandler<ModifyDBClusterParameterGroupRequest,ModifyDBClusterParameterGroupResult> asyncHandler)
AmazonDocDBAsync
Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the
following: ParameterName
, ParameterValue
, and ApplyMethod
. A maximum of 20
parameters can be modified in a single request.
Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.
After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster
that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully
complete the create action before the parameter group is used as the default for a new cluster. This step is
especially important for parameters that are critical when creating the default database for a cluster, such as
the character set for the default database defined by the character_set_database
parameter.
modifyDBClusterParameterGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyDBClusterParameterGroup.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<DBClusterSnapshotAttributesResult> modifyDBClusterSnapshotAttributeAsync(ModifyDBClusterSnapshotAttributeRequest request)
AmazonDocDBAsync
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore
as the
AttributeName
, and use the ValuesToAdd
parameter to add a list of IDs of the Amazon Web
Services accounts that are authorized to restore the manual cluster snapshot. Use the value all
to
make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services
accounts. Do not add the all
value for any manual cluster snapshots that contain private information
that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it
can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the
ValuesToAdd
parameter. You can't use all
as a value for that parameter in this case.
modifyDBClusterSnapshotAttributeAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyDBClusterSnapshotAttribute.public Future<DBClusterSnapshotAttributesResult> modifyDBClusterSnapshotAttributeAsync(ModifyDBClusterSnapshotAttributeRequest request, AsyncHandler<ModifyDBClusterSnapshotAttributeRequest,DBClusterSnapshotAttributesResult> asyncHandler)
AmazonDocDBAsync
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore
as the
AttributeName
, and use the ValuesToAdd
parameter to add a list of IDs of the Amazon Web
Services accounts that are authorized to restore the manual cluster snapshot. Use the value all
to
make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services
accounts. Do not add the all
value for any manual cluster snapshots that contain private information
that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it
can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the
ValuesToAdd
parameter. You can't use all
as a value for that parameter in this case.
modifyDBClusterSnapshotAttributeAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyDBClusterSnapshotAttribute.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<DBInstance> modifyDBInstanceAsync(ModifyDBInstanceRequest request)
AmazonDocDBAsync
Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
modifyDBInstanceAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyDBInstance.public Future<DBInstance> modifyDBInstanceAsync(ModifyDBInstanceRequest request, AsyncHandler<ModifyDBInstanceRequest,DBInstance> asyncHandler)
AmazonDocDBAsync
Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.
modifyDBInstanceAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyDBInstance.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<DBSubnetGroup> modifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest request)
AmazonDocDBAsync
Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
modifyDBSubnetGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyDBSubnetGroup.public Future<DBSubnetGroup> modifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest request, AsyncHandler<ModifyDBSubnetGroupRequest,DBSubnetGroup> asyncHandler)
AmazonDocDBAsync
Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Amazon Web Services Region.
modifyDBSubnetGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyDBSubnetGroup.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<EventSubscription> modifyEventSubscriptionAsync(ModifyEventSubscriptionRequest request)
AmazonDocDBAsync
Modifies an existing Amazon DocumentDB event notification subscription.
modifyEventSubscriptionAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyEventSubscription.public Future<EventSubscription> modifyEventSubscriptionAsync(ModifyEventSubscriptionRequest request, AsyncHandler<ModifyEventSubscriptionRequest,EventSubscription> asyncHandler)
AmazonDocDBAsync
Modifies an existing Amazon DocumentDB event notification subscription.
modifyEventSubscriptionAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyEventSubscription.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<GlobalCluster> modifyGlobalClusterAsync(ModifyGlobalClusterRequest request)
AmazonDocDBAsync
Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
This action only applies to Amazon DocumentDB clusters.
modifyGlobalClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyGlobalCluster.public Future<GlobalCluster> modifyGlobalClusterAsync(ModifyGlobalClusterRequest request, AsyncHandler<ModifyGlobalClusterRequest,GlobalCluster> asyncHandler)
AmazonDocDBAsync
Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
This action only applies to Amazon DocumentDB clusters.
modifyGlobalClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to ModifyGlobalCluster.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<DBInstance> rebootDBInstanceAsync(RebootDBInstanceRequest request)
AmazonDocDBAsync
You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.
Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.
rebootDBInstanceAsync
in interface AmazonDocDBAsync
request
- Represents the input to RebootDBInstance.public Future<DBInstance> rebootDBInstanceAsync(RebootDBInstanceRequest request, AsyncHandler<RebootDBInstanceRequest,DBInstance> asyncHandler)
AmazonDocDBAsync
You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.
Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.
rebootDBInstanceAsync
in interface AmazonDocDBAsync
request
- Represents the input to RebootDBInstance.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<GlobalCluster> removeFromGlobalClusterAsync(RemoveFromGlobalClusterRequest request)
AmazonDocDBAsync
Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.
This action only applies to Amazon DocumentDB clusters.
removeFromGlobalClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to RemoveFromGlobalCluster.public Future<GlobalCluster> removeFromGlobalClusterAsync(RemoveFromGlobalClusterRequest request, AsyncHandler<RemoveFromGlobalClusterRequest,GlobalCluster> asyncHandler)
AmazonDocDBAsync
Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.
This action only applies to Amazon DocumentDB clusters.
removeFromGlobalClusterAsync
in interface AmazonDocDBAsync
request
- Represents the input to RemoveFromGlobalCluster.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<EventSubscription> removeSourceIdentifierFromSubscriptionAsync(RemoveSourceIdentifierFromSubscriptionRequest request)
AmazonDocDBAsync
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
removeSourceIdentifierFromSubscriptionAsync
in interface AmazonDocDBAsync
request
- Represents the input to RemoveSourceIdentifierFromSubscription.public Future<EventSubscription> removeSourceIdentifierFromSubscriptionAsync(RemoveSourceIdentifierFromSubscriptionRequest request, AsyncHandler<RemoveSourceIdentifierFromSubscriptionRequest,EventSubscription> asyncHandler)
AmazonDocDBAsync
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
removeSourceIdentifierFromSubscriptionAsync
in interface AmazonDocDBAsync
request
- Represents the input to RemoveSourceIdentifierFromSubscription.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<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest request)
AmazonDocDBAsync
Removes metadata tags from an Amazon DocumentDB resource.
removeTagsFromResourceAsync
in interface AmazonDocDBAsync
request
- Represents the input to RemoveTagsFromResource.public Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest request, AsyncHandler<RemoveTagsFromResourceRequest,RemoveTagsFromResourceResult> asyncHandler)
AmazonDocDBAsync
Removes metadata tags from an Amazon DocumentDB resource.
removeTagsFromResourceAsync
in interface AmazonDocDBAsync
request
- Represents the input to RemoveTagsFromResource.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<ResetDBClusterParameterGroupResult> resetDBClusterParameterGroupAsync(ResetDBClusterParameterGroupRequest request)
AmazonDocDBAsync
Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a
list of the following: ParameterName
and ApplyMethod
. To reset the entire cluster
parameter group, specify the DBClusterParameterGroupName
and ResetAllParameters
parameters.
When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-reboot
to take effect on the next DB instance reboot.
resetDBClusterParameterGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to ResetDBClusterParameterGroup.public Future<ResetDBClusterParameterGroupResult> resetDBClusterParameterGroupAsync(ResetDBClusterParameterGroupRequest request, AsyncHandler<ResetDBClusterParameterGroupRequest,ResetDBClusterParameterGroupResult> asyncHandler)
AmazonDocDBAsync
Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a
list of the following: ParameterName
and ApplyMethod
. To reset the entire cluster
parameter group, specify the DBClusterParameterGroupName
and ResetAllParameters
parameters.
When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to
pending-reboot
to take effect on the next DB instance reboot.
resetDBClusterParameterGroupAsync
in interface AmazonDocDBAsync
request
- Represents the input to ResetDBClusterParameterGroup.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<DBCluster> restoreDBClusterFromSnapshotAsync(RestoreDBClusterFromSnapshotRequest request)
AmazonDocDBAsync
Creates a new cluster from a snapshot or cluster snapshot.
If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.
If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.
restoreDBClusterFromSnapshotAsync
in interface AmazonDocDBAsync
request
- Represents the input to RestoreDBClusterFromSnapshot.public Future<DBCluster> restoreDBClusterFromSnapshotAsync(RestoreDBClusterFromSnapshotRequest request, AsyncHandler<RestoreDBClusterFromSnapshotRequest,DBCluster> asyncHandler)
AmazonDocDBAsync
Creates a new cluster from a snapshot or cluster snapshot.
If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.
If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.
restoreDBClusterFromSnapshotAsync
in interface AmazonDocDBAsync
request
- Represents the input to RestoreDBClusterFromSnapshot.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<DBCluster> restoreDBClusterToPointInTimeAsync(RestoreDBClusterToPointInTimeRequest request)
AmazonDocDBAsync
Restores a cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up to BackupRetentionPeriod
days. The target cluster is
created from the source cluster with the same configuration as the original cluster, except that the new cluster
is created with the default security group.
restoreDBClusterToPointInTimeAsync
in interface AmazonDocDBAsync
request
- Represents the input to RestoreDBClusterToPointInTime.public Future<DBCluster> restoreDBClusterToPointInTimeAsync(RestoreDBClusterToPointInTimeRequest request, AsyncHandler<RestoreDBClusterToPointInTimeRequest,DBCluster> asyncHandler)
AmazonDocDBAsync
Restores a cluster to an arbitrary point in time. Users can restore to any point in time before
LatestRestorableTime
for up to BackupRetentionPeriod
days. The target cluster is
created from the source cluster with the same configuration as the original cluster, except that the new cluster
is created with the default security group.
restoreDBClusterToPointInTimeAsync
in interface AmazonDocDBAsync
request
- Represents the input to RestoreDBClusterToPointInTime.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<DBCluster> startDBClusterAsync(StartDBClusterRequest request)
AmazonDocDBAsync
Restarts the stopped cluster that is specified by DBClusterIdentifier
. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
startDBClusterAsync
in interface AmazonDocDBAsync
public Future<DBCluster> startDBClusterAsync(StartDBClusterRequest request, AsyncHandler<StartDBClusterRequest,DBCluster> asyncHandler)
AmazonDocDBAsync
Restarts the stopped cluster that is specified by DBClusterIdentifier
. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
startDBClusterAsync
in interface AmazonDocDBAsync
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<DBCluster> stopDBClusterAsync(StopDBClusterRequest request)
AmazonDocDBAsync
Stops the running cluster that is specified by DBClusterIdentifier
. The cluster must be in the
available state. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
stopDBClusterAsync
in interface AmazonDocDBAsync
public Future<DBCluster> stopDBClusterAsync(StopDBClusterRequest request, AsyncHandler<StopDBClusterRequest,DBCluster> asyncHandler)
AmazonDocDBAsync
Stops the running cluster that is specified by DBClusterIdentifier
. The cluster must be in the
available state. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
stopDBClusterAsync
in interface AmazonDocDBAsync
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<GlobalCluster> switchoverGlobalClusterAsync(SwitchoverGlobalClusterRequest request)
AmazonDocDBAsync
Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.
switchoverGlobalClusterAsync
in interface AmazonDocDBAsync
public Future<GlobalCluster> switchoverGlobalClusterAsync(SwitchoverGlobalClusterRequest request, AsyncHandler<SwitchoverGlobalClusterRequest,GlobalCluster> asyncHandler)
AmazonDocDBAsync
Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.
switchoverGlobalClusterAsync
in interface AmazonDocDBAsync
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 void shutdown()
getExecutorService().shutdown()
followed by getExecutorService().awaitTermination()
prior to
calling this method.shutdown
in interface AmazonDocDB
shutdown
in class AmazonDocDBClient