@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonDocDBAsync extends AbstractAmazonDocDB implements AmazonDocDBAsync
AmazonDocDBAsync. Convenient method forms pass through to the corresponding
overload that takes a request object and an AsyncHandler, which throws an
UnsupportedOperationException.ENDPOINT_PREFIXaddSourceIdentifierToSubscription, 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, shutdown, startDBCluster, stopDBCluster, waitersequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitaddSourceIdentifierToSubscription, 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, shutdown, startDBCluster, stopDBCluster, waiterspublic Future<EventSubscription> addSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest request)
AmazonDocDBAsyncAdds a source identifier to an existing event notification subscription.
addSourceIdentifierToSubscriptionAsync in interface AmazonDocDBAsyncrequest - Represents the input to AddSourceIdentifierToSubscription.public Future<EventSubscription> addSourceIdentifierToSubscriptionAsync(AddSourceIdentifierToSubscriptionRequest request, AsyncHandler<AddSourceIdentifierToSubscriptionRequest,EventSubscription> asyncHandler)
AmazonDocDBAsyncAdds a source identifier to an existing event notification subscription.
addSourceIdentifierToSubscriptionAsync in interface AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncApplies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
applyPendingMaintenanceActionAsync in interface AmazonDocDBAsyncrequest - Represents the input to ApplyPendingMaintenanceAction.public Future<ResourcePendingMaintenanceActions> applyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest request, AsyncHandler<ApplyPendingMaintenanceActionRequest,ResourcePendingMaintenanceActions> asyncHandler)
AmazonDocDBAsyncApplies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
applyPendingMaintenanceActionAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncCopies the specified cluster parameter group.
copyDBClusterParameterGroupAsync in interface AmazonDocDBAsyncrequest - Represents the input to CopyDBClusterParameterGroup.public Future<DBClusterParameterGroup> copyDBClusterParameterGroupAsync(CopyDBClusterParameterGroupRequest request, AsyncHandler<CopyDBClusterParameterGroupRequest,DBClusterParameterGroup> asyncHandler)
AmazonDocDBAsyncCopies the specified cluster parameter group.
copyDBClusterParameterGroupAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncCopies 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 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 AmazonDocDBAsyncrequest - Represents the input to CopyDBClusterSnapshot.public Future<DBClusterSnapshot> copyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest request, AsyncHandler<CopyDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
AmazonDocDBAsyncCopies 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 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncCreates a new Amazon DocumentDB cluster.
createDBClusterAsync in interface AmazonDocDBAsyncrequest - Represents the input to CreateDBCluster.public Future<DBCluster> createDBClusterAsync(CreateDBClusterRequest request, AsyncHandler<CreateDBClusterRequest,DBCluster> asyncHandler)
AmazonDocDBAsyncCreates a new Amazon DocumentDB cluster.
createDBClusterAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncCreates 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 AmazonDocDBAsyncrequest - Represents the input of CreateDBClusterParameterGroup.public Future<DBClusterParameterGroup> createDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest request, AsyncHandler<CreateDBClusterParameterGroupRequest,DBClusterParameterGroup> asyncHandler)
AmazonDocDBAsyncCreates 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncCreates a snapshot of a cluster.
createDBClusterSnapshotAsync in interface AmazonDocDBAsyncrequest - Represents the input of CreateDBClusterSnapshot.public Future<DBClusterSnapshot> createDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest request, AsyncHandler<CreateDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
AmazonDocDBAsyncCreates a snapshot of a cluster.
createDBClusterSnapshotAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncCreates a new instance.
createDBInstanceAsync in interface AmazonDocDBAsyncrequest - Represents the input to CreateDBInstance.public Future<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest request, AsyncHandler<CreateDBInstanceRequest,DBInstance> asyncHandler)
AmazonDocDBAsyncCreates a new instance.
createDBInstanceAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncCreates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.
createDBSubnetGroupAsync in interface AmazonDocDBAsyncrequest - Represents the input to CreateDBSubnetGroup.public Future<DBSubnetGroup> createDBSubnetGroupAsync(CreateDBSubnetGroupRequest request, AsyncHandler<CreateDBSubnetGroupRequest,DBSubnetGroup> asyncHandler)
AmazonDocDBAsyncCreates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.
createDBSubnetGroupAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncCreates 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 AmazonDocDBAsyncrequest - Represents the input to CreateEventSubscription.public Future<EventSubscription> createEventSubscriptionAsync(CreateEventSubscriptionRequest request, AsyncHandler<CreateEventSubscriptionRequest,EventSubscription> asyncHandler)
AmazonDocDBAsyncCreates 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncCreates an Amazon DocumentDB global cluster that can span multiple multiple 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 AmazonDocDBAsyncrequest - Represents the input to CreateGlobalCluster.public Future<GlobalCluster> createGlobalClusterAsync(CreateGlobalClusterRequest request, AsyncHandler<CreateGlobalClusterRequest,GlobalCluster> asyncHandler)
AmazonDocDBAsyncCreates an Amazon DocumentDB global cluster that can span multiple multiple 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncDeletes 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 AmazonDocDBAsyncrequest - Represents the input to DeleteDBCluster.public Future<DBCluster> deleteDBClusterAsync(DeleteDBClusterRequest request, AsyncHandler<DeleteDBClusterRequest,DBCluster> asyncHandler)
AmazonDocDBAsyncDeletes 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncDeletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
deleteDBClusterParameterGroupAsync in interface AmazonDocDBAsyncrequest - Represents the input to DeleteDBClusterParameterGroup.public Future<DeleteDBClusterParameterGroupResult> deleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest request, AsyncHandler<DeleteDBClusterParameterGroupRequest,DeleteDBClusterParameterGroupResult> asyncHandler)
AmazonDocDBAsyncDeletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
deleteDBClusterParameterGroupAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncDeletes 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 AmazonDocDBAsyncrequest - Represents the input to DeleteDBClusterSnapshot.public Future<DBClusterSnapshot> deleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest request, AsyncHandler<DeleteDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
AmazonDocDBAsyncDeletes 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncDeletes a previously provisioned instance.
deleteDBInstanceAsync in interface AmazonDocDBAsyncrequest - Represents the input to DeleteDBInstance.public Future<DBInstance> deleteDBInstanceAsync(DeleteDBInstanceRequest request, AsyncHandler<DeleteDBInstanceRequest,DBInstance> asyncHandler)
AmazonDocDBAsyncDeletes a previously provisioned instance.
deleteDBInstanceAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncDeletes a subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroupAsync in interface AmazonDocDBAsyncrequest - Represents the input to DeleteDBSubnetGroup.public Future<DeleteDBSubnetGroupResult> deleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest request, AsyncHandler<DeleteDBSubnetGroupRequest,DeleteDBSubnetGroupResult> asyncHandler)
AmazonDocDBAsyncDeletes a subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroupAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncDeletes an Amazon DocumentDB event notification subscription.
deleteEventSubscriptionAsync in interface AmazonDocDBAsyncrequest - Represents the input to DeleteEventSubscription.public Future<EventSubscription> deleteEventSubscriptionAsync(DeleteEventSubscriptionRequest request, AsyncHandler<DeleteEventSubscriptionRequest,EventSubscription> asyncHandler)
AmazonDocDBAsyncDeletes an Amazon DocumentDB event notification subscription.
deleteEventSubscriptionAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncDeletes 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 AmazonDocDBAsyncrequest - Represents the input to DeleteGlobalCluster.public Future<GlobalCluster> deleteGlobalClusterAsync(DeleteGlobalClusterRequest request, AsyncHandler<DeleteGlobalClusterRequest,GlobalCluster> asyncHandler)
AmazonDocDBAsyncDeletes 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncReturns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.
describeCertificatesAsync in interface AmazonDocDBAsyncpublic Future<DescribeCertificatesResult> describeCertificatesAsync(DescribeCertificatesRequest request, AsyncHandler<DescribeCertificatesRequest,DescribeCertificatesResult> asyncHandler)
AmazonDocDBAsyncReturns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.
describeCertificatesAsync in interface AmazonDocDBAsyncasyncHandler - 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 AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncReturns the detailed parameter list for a particular cluster parameter group.
describeDBClusterParametersAsync in interface AmazonDocDBAsyncrequest - Represents the input to DescribeDBClusterParameters.public Future<DescribeDBClusterParametersResult> describeDBClusterParametersAsync(DescribeDBClusterParametersRequest request, AsyncHandler<DescribeDBClusterParametersRequest,DescribeDBClusterParametersResult> asyncHandler)
AmazonDocDBAsyncReturns the detailed parameter list for a particular cluster parameter group.
describeDBClusterParametersAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncReturns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other accounts, DescribeDBClusterSnapshotAttributes returns the
restore attribute and a list of IDs for the 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 accounts.
describeDBClusterSnapshotAttributesAsync in interface AmazonDocDBAsyncrequest - Represents the input to DescribeDBClusterSnapshotAttributes.public Future<DBClusterSnapshotAttributesResult> describeDBClusterSnapshotAttributesAsync(DescribeDBClusterSnapshotAttributesRequest request, AsyncHandler<DescribeDBClusterSnapshotAttributesRequest,DBClusterSnapshotAttributesResult> asyncHandler)
AmazonDocDBAsyncReturns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other accounts, DescribeDBClusterSnapshotAttributes returns the
restore attribute and a list of IDs for the 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 accounts.
describeDBClusterSnapshotAttributesAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncReturns information about cluster snapshots. This API operation supports pagination.
describeDBClusterSnapshotsAsync in interface AmazonDocDBAsyncrequest - Represents the input to DescribeDBClusterSnapshots.public Future<DescribeDBClusterSnapshotsResult> describeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest request, AsyncHandler<DescribeDBClusterSnapshotsRequest,DescribeDBClusterSnapshotsResult> asyncHandler)
AmazonDocDBAsyncReturns information about cluster snapshots. This API operation supports pagination.
describeDBClusterSnapshotsAsync in interface AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncReturns a list of the available engines.
describeDBEngineVersionsAsync in interface AmazonDocDBAsyncrequest - Represents the input to DescribeDBEngineVersions.public Future<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest request, AsyncHandler<DescribeDBEngineVersionsRequest,DescribeDBEngineVersionsResult> asyncHandler)
AmazonDocDBAsyncReturns a list of the available engines.
describeDBEngineVersionsAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncReturns information about provisioned Amazon DocumentDB instances. This API supports pagination.
describeDBInstancesAsync in interface AmazonDocDBAsyncrequest - Represents the input to DescribeDBInstances.public Future<DescribeDBInstancesResult> describeDBInstancesAsync(DescribeDBInstancesRequest request, AsyncHandler<DescribeDBInstancesRequest,DescribeDBInstancesResult> asyncHandler)
AmazonDocDBAsyncReturns information about provisioned Amazon DocumentDB instances. This API supports pagination.
describeDBInstancesAsync in interface AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncReturns the default engine and system parameter information for the cluster database engine.
describeEngineDefaultClusterParametersAsync in interface AmazonDocDBAsyncrequest - Represents the input to DescribeEngineDefaultClusterParameters.public Future<EngineDefaults> describeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest request, AsyncHandler<DescribeEngineDefaultClusterParametersRequest,EngineDefaults> asyncHandler)
AmazonDocDBAsyncReturns the default engine and system parameter information for the cluster database engine.
describeEngineDefaultClusterParametersAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncDisplays a list of categories for all event source types, or, if specified, for a specified source type.
describeEventCategoriesAsync in interface AmazonDocDBAsyncrequest - Represents the input to DescribeEventCategories.public Future<DescribeEventCategoriesResult> describeEventCategoriesAsync(DescribeEventCategoriesRequest request, AsyncHandler<DescribeEventCategoriesRequest,DescribeEventCategoriesResult> asyncHandler)
AmazonDocDBAsyncDisplays a list of categories for all event source types, or, if specified, for a specified source type.
describeEventCategoriesAsync in interface AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncReturns 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 AmazonDocDBAsyncrequest - Represents the input to DescribeEvents.public Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest request, AsyncHandler<DescribeEventsRequest,DescribeEventsResult> asyncHandler)
AmazonDocDBAsyncReturns 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncReturns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
describeGlobalClustersAsync in interface AmazonDocDBAsyncpublic Future<DescribeGlobalClustersResult> describeGlobalClustersAsync(DescribeGlobalClustersRequest request, AsyncHandler<DescribeGlobalClustersRequest,DescribeGlobalClustersResult> asyncHandler)
AmazonDocDBAsyncReturns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
describeGlobalClustersAsync in interface AmazonDocDBAsyncasyncHandler - 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)
AmazonDocDBAsyncReturns a list of orderable instance options for the specified engine.
describeOrderableDBInstanceOptionsAsync in interface AmazonDocDBAsyncrequest - Represents the input to DescribeOrderableDBInstanceOptions.public Future<DescribeOrderableDBInstanceOptionsResult> describeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest request, AsyncHandler<DescribeOrderableDBInstanceOptionsRequest,DescribeOrderableDBInstanceOptionsResult> asyncHandler)
AmazonDocDBAsyncReturns a list of orderable instance options for the specified engine.
describeOrderableDBInstanceOptionsAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncReturns a list of resources (for example, instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsAsync in interface AmazonDocDBAsyncrequest - Represents the input to DescribePendingMaintenanceActions.public Future<DescribePendingMaintenanceActionsResult> describePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest request, AsyncHandler<DescribePendingMaintenanceActionsRequest,DescribePendingMaintenanceActionsResult> asyncHandler)
AmazonDocDBAsyncReturns a list of resources (for example, instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncForces 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 AmazonDocDBAsyncrequest - Represents the input to FailoverDBCluster.public Future<DBCluster> failoverDBClusterAsync(FailoverDBClusterRequest request, AsyncHandler<FailoverDBClusterRequest,DBCluster> asyncHandler)
AmazonDocDBAsyncForces 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncLists all tags on an Amazon DocumentDB resource.
listTagsForResourceAsync in interface AmazonDocDBAsyncrequest - Represents the input to ListTagsForResource.public Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest request, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
AmazonDocDBAsyncLists all tags on an Amazon DocumentDB resource.
listTagsForResourceAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncModifies 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 AmazonDocDBAsyncrequest - Represents the input to ModifyDBCluster.public Future<DBCluster> modifyDBClusterAsync(ModifyDBClusterRequest request, AsyncHandler<ModifyDBClusterRequest,DBCluster> asyncHandler)
AmazonDocDBAsyncModifies 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 AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncAdds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
To share a manual cluster snapshot with other accounts, specify restore as the
AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the 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 accounts. Do not add the
all value for any manual cluster snapshots that contain private information that you don't want
available to all accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a
list of authorized account IDs for the ValuesToAdd parameter. You can't use all as a
value for that parameter in this case.
modifyDBClusterSnapshotAttributeAsync in interface AmazonDocDBAsyncrequest - Represents the input to ModifyDBClusterSnapshotAttribute.public Future<DBClusterSnapshotAttributesResult> modifyDBClusterSnapshotAttributeAsync(ModifyDBClusterSnapshotAttributeRequest request, AsyncHandler<ModifyDBClusterSnapshotAttributeRequest,DBClusterSnapshotAttributesResult> asyncHandler)
AmazonDocDBAsyncAdds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
To share a manual cluster snapshot with other accounts, specify restore as the
AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the 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 accounts. Do not add the
all value for any manual cluster snapshots that contain private information that you don't want
available to all accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a
list of authorized account IDs for the ValuesToAdd parameter. You can't use all as a
value for that parameter in this case.
modifyDBClusterSnapshotAttributeAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncModifies 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 AmazonDocDBAsyncrequest - Represents the input to ModifyDBInstance.public Future<DBInstance> modifyDBInstanceAsync(ModifyDBInstanceRequest request, AsyncHandler<ModifyDBInstanceRequest,DBInstance> asyncHandler)
AmazonDocDBAsyncModifies 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncModifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.
modifyDBSubnetGroupAsync in interface AmazonDocDBAsyncrequest - Represents the input to ModifyDBSubnetGroup.public Future<DBSubnetGroup> modifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest request, AsyncHandler<ModifyDBSubnetGroupRequest,DBSubnetGroup> asyncHandler)
AmazonDocDBAsyncModifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the Region.
modifyDBSubnetGroupAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncModifies an existing Amazon DocumentDB event notification subscription.
modifyEventSubscriptionAsync in interface AmazonDocDBAsyncrequest - Represents the input to ModifyEventSubscription.public Future<EventSubscription> modifyEventSubscriptionAsync(ModifyEventSubscriptionRequest request, AsyncHandler<ModifyEventSubscriptionRequest,EventSubscription> asyncHandler)
AmazonDocDBAsyncModifies an existing Amazon DocumentDB event notification subscription.
modifyEventSubscriptionAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncModify 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 AmazonDocDBAsyncrequest - Represents the input to ModifyGlobalCluster.public Future<GlobalCluster> modifyGlobalClusterAsync(ModifyGlobalClusterRequest request, AsyncHandler<ModifyGlobalClusterRequest,GlobalCluster> asyncHandler)
AmazonDocDBAsyncModify 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncYou 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 AmazonDocDBAsyncrequest - Represents the input to RebootDBInstance.public Future<DBInstance> rebootDBInstanceAsync(RebootDBInstanceRequest request, AsyncHandler<RebootDBInstanceRequest,DBInstance> asyncHandler)
AmazonDocDBAsyncYou 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncDetaches 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 AmazonDocDBAsyncrequest - Represents the input to RemoveFromGlobalCluster.public Future<GlobalCluster> removeFromGlobalClusterAsync(RemoveFromGlobalClusterRequest request, AsyncHandler<RemoveFromGlobalClusterRequest,GlobalCluster> asyncHandler)
AmazonDocDBAsyncDetaches 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncRemoves a source identifier from an existing Amazon DocumentDB event notification subscription.
removeSourceIdentifierFromSubscriptionAsync in interface AmazonDocDBAsyncrequest - Represents the input to RemoveSourceIdentifierFromSubscription.public Future<EventSubscription> removeSourceIdentifierFromSubscriptionAsync(RemoveSourceIdentifierFromSubscriptionRequest request, AsyncHandler<RemoveSourceIdentifierFromSubscriptionRequest,EventSubscription> asyncHandler)
AmazonDocDBAsyncRemoves a source identifier from an existing Amazon DocumentDB event notification subscription.
removeSourceIdentifierFromSubscriptionAsync in interface AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncRemoves metadata tags from an Amazon DocumentDB resource.
removeTagsFromResourceAsync in interface AmazonDocDBAsyncrequest - Represents the input to RemoveTagsFromResource.public Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest request, AsyncHandler<RemoveTagsFromResourceRequest,RemoveTagsFromResourceResult> asyncHandler)
AmazonDocDBAsyncRemoves metadata tags from an Amazon DocumentDB resource.
removeTagsFromResourceAsync in interface AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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)
AmazonDocDBAsyncCreates 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 AmazonDocDBAsyncrequest - Represents the input to RestoreDBClusterFromSnapshot.public Future<DBCluster> restoreDBClusterFromSnapshotAsync(RestoreDBClusterFromSnapshotRequest request, AsyncHandler<RestoreDBClusterFromSnapshotRequest,DBCluster> asyncHandler)
AmazonDocDBAsyncCreates 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 AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncrequest - 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 AmazonDocDBAsyncpublic 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 AmazonDocDBAsyncasyncHandler - 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 AmazonDocDBAsyncpublic 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 AmazonDocDBAsyncasyncHandler - 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.