@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonDocDBAsync extends AmazonDocDB
AsyncHandler can be used to receive
notification when an asynchronous operation completes.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonDocDBAsync instead.
Amazon DocumentDB API documentation
ENDPOINT_PREFIXaddTagsToResource, applyPendingMaintenanceAction, copyDBClusterParameterGroup, copyDBClusterSnapshot, createDBCluster, createDBClusterParameterGroup, createDBClusterSnapshot, createDBInstance, createDBSubnetGroup, deleteDBCluster, deleteDBClusterParameterGroup, deleteDBClusterSnapshot, deleteDBInstance, deleteDBSubnetGroup, describeCertificates, describeDBClusterParameterGroups, describeDBClusterParameters, describeDBClusters, describeDBClusterSnapshotAttributes, describeDBClusterSnapshots, describeDBEngineVersions, describeDBInstances, describeDBSubnetGroups, describeEngineDefaultClusterParameters, describeEventCategories, describeEvents, describeOrderableDBInstanceOptions, describePendingMaintenanceActions, failoverDBCluster, getCachedResponseMetadata, listTagsForResource, modifyDBCluster, modifyDBClusterParameterGroup, modifyDBClusterSnapshotAttribute, modifyDBInstance, modifyDBSubnetGroup, rebootDBInstance, removeTagsFromResource, resetDBClusterParameterGroup, restoreDBClusterFromSnapshot, restoreDBClusterToPointInTime, shutdown, startDBCluster, stopDBCluster, waitersFuture<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest addTagsToResourceRequest)
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
AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.
addTagsToResourceRequest - Represents the input to AddTagsToResource.Future<AddTagsToResourceResult> addTagsToResourceAsync(AddTagsToResourceRequest addTagsToResourceRequest, AsyncHandler<AddTagsToResourceRequest,AddTagsToResourceResult> asyncHandler)
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
AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.
addTagsToResourceRequest - 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.Future<ResourcePendingMaintenanceActions> applyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
applyPendingMaintenanceActionRequest - Represents the input to ApplyPendingMaintenanceAction.Future<ResourcePendingMaintenanceActions> applyPendingMaintenanceActionAsync(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest, AsyncHandler<ApplyPendingMaintenanceActionRequest,ResourcePendingMaintenanceActions> asyncHandler)
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
applyPendingMaintenanceActionRequest - 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.Future<DBClusterParameterGroup> copyDBClusterParameterGroupAsync(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest)
Copies the specified cluster parameter group.
copyDBClusterParameterGroupRequest - Represents the input to CopyDBClusterParameterGroup.Future<DBClusterParameterGroup> copyDBClusterParameterGroupAsync(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest, AsyncHandler<CopyDBClusterParameterGroupRequest,DBClusterParameterGroup> asyncHandler)
Copies the specified cluster parameter group.
copyDBClusterParameterGroupRequest - 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.Future<DBClusterSnapshot> copyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest)
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 AWS 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.
copyDBClusterSnapshotRequest - Represents the input to CopyDBClusterSnapshot.Future<DBClusterSnapshot> copyDBClusterSnapshotAsync(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest, AsyncHandler<CopyDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
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 AWS 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.
copyDBClusterSnapshotRequest - 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.Future<DBCluster> createDBClusterAsync(CreateDBClusterRequest createDBClusterRequest)
Creates a new Amazon DocumentDB cluster.
createDBClusterRequest - Represents the input to CreateDBCluster.Future<DBCluster> createDBClusterAsync(CreateDBClusterRequest createDBClusterRequest, AsyncHandler<CreateDBClusterRequest,DBCluster> asyncHandler)
Creates a new Amazon DocumentDB cluster.
createDBClusterRequest - 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.Future<DBClusterParameterGroup> createDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest)
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.
createDBClusterParameterGroupRequest - Represents the input of CreateDBClusterParameterGroup.Future<DBClusterParameterGroup> createDBClusterParameterGroupAsync(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest, AsyncHandler<CreateDBClusterParameterGroupRequest,DBClusterParameterGroup> asyncHandler)
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.
createDBClusterParameterGroupRequest - 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.Future<DBClusterSnapshot> createDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest)
Creates a snapshot of a cluster.
createDBClusterSnapshotRequest - Represents the input of CreateDBClusterSnapshot.Future<DBClusterSnapshot> createDBClusterSnapshotAsync(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest, AsyncHandler<CreateDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
Creates a snapshot of a cluster.
createDBClusterSnapshotRequest - 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.Future<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest createDBInstanceRequest)
Creates a new instance.
createDBInstanceRequest - Represents the input to CreateDBInstance.Future<DBInstance> createDBInstanceAsync(CreateDBInstanceRequest createDBInstanceRequest, AsyncHandler<CreateDBInstanceRequest,DBInstance> asyncHandler)
Creates a new instance.
createDBInstanceRequest - 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.Future<DBSubnetGroup> createDBSubnetGroupAsync(CreateDBSubnetGroupRequest createDBSubnetGroupRequest)
Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.
createDBSubnetGroupRequest - Represents the input to CreateDBSubnetGroup.Future<DBSubnetGroup> createDBSubnetGroupAsync(CreateDBSubnetGroupRequest createDBSubnetGroupRequest, AsyncHandler<CreateDBSubnetGroupRequest,DBSubnetGroup> asyncHandler)
Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.
createDBSubnetGroupRequest - 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.Future<DBCluster> deleteDBClusterAsync(DeleteDBClusterRequest deleteDBClusterRequest)
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.
deleteDBClusterRequest - Represents the input to DeleteDBCluster.Future<DBCluster> deleteDBClusterAsync(DeleteDBClusterRequest deleteDBClusterRequest, AsyncHandler<DeleteDBClusterRequest,DBCluster> asyncHandler)
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.
deleteDBClusterRequest - 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.Future<DeleteDBClusterParameterGroupResult> deleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest)
Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
deleteDBClusterParameterGroupRequest - Represents the input to DeleteDBClusterParameterGroup.Future<DeleteDBClusterParameterGroupResult> deleteDBClusterParameterGroupAsync(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest, AsyncHandler<DeleteDBClusterParameterGroupRequest,DeleteDBClusterParameterGroupResult> asyncHandler)
Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
deleteDBClusterParameterGroupRequest - 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.Future<DBClusterSnapshot> deleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest)
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.
deleteDBClusterSnapshotRequest - Represents the input to DeleteDBClusterSnapshot.Future<DBClusterSnapshot> deleteDBClusterSnapshotAsync(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest, AsyncHandler<DeleteDBClusterSnapshotRequest,DBClusterSnapshot> asyncHandler)
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.
deleteDBClusterSnapshotRequest - 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.Future<DBInstance> deleteDBInstanceAsync(DeleteDBInstanceRequest deleteDBInstanceRequest)
Deletes a previously provisioned instance.
deleteDBInstanceRequest - Represents the input to DeleteDBInstance.Future<DBInstance> deleteDBInstanceAsync(DeleteDBInstanceRequest deleteDBInstanceRequest, AsyncHandler<DeleteDBInstanceRequest,DBInstance> asyncHandler)
Deletes a previously provisioned instance.
deleteDBInstanceRequest - 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.Future<DeleteDBSubnetGroupResult> deleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)
Deletes a subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroupRequest - Represents the input to DeleteDBSubnetGroup.Future<DeleteDBSubnetGroupResult> deleteDBSubnetGroupAsync(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest, AsyncHandler<DeleteDBSubnetGroupRequest,DeleteDBSubnetGroupResult> asyncHandler)
Deletes a subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroupRequest - 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.Future<DescribeCertificatesResult> describeCertificatesAsync(DescribeCertificatesRequest describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account.
describeCertificatesRequest - Future<DescribeCertificatesResult> describeCertificatesAsync(DescribeCertificatesRequest describeCertificatesRequest, AsyncHandler<DescribeCertificatesRequest,DescribeCertificatesResult> asyncHandler)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account.
describeCertificatesRequest - 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.Future<DescribeDBClusterParameterGroupsResult> describeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest)
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
describeDBClusterParameterGroupsRequest - Represents the input to DescribeDBClusterParameterGroups.Future<DescribeDBClusterParameterGroupsResult> describeDBClusterParameterGroupsAsync(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest, AsyncHandler<DescribeDBClusterParameterGroupsRequest,DescribeDBClusterParameterGroupsResult> asyncHandler)
Returns a list of DBClusterParameterGroup descriptions. If a
DBClusterParameterGroupName parameter is specified, the list contains only the description of the
specified cluster parameter group.
describeDBClusterParameterGroupsRequest - 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.Future<DescribeDBClusterParametersResult> describeDBClusterParametersAsync(DescribeDBClusterParametersRequest describeDBClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
describeDBClusterParametersRequest - Represents the input to DescribeDBClusterParameters.Future<DescribeDBClusterParametersResult> describeDBClusterParametersAsync(DescribeDBClusterParametersRequest describeDBClusterParametersRequest, AsyncHandler<DescribeDBClusterParametersRequest,DescribeDBClusterParametersResult> asyncHandler)
Returns the detailed parameter list for a particular cluster parameter group.
describeDBClusterParametersRequest - 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.Future<DBClusterSnapshotAttributesResult> describeDBClusterSnapshotAttributesAsync(DescribeDBClusterSnapshotAttributesRequest describeDBClusterSnapshotAttributesRequest)
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the
restore attribute and a list of IDs for the AWS 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 AWS accounts.
describeDBClusterSnapshotAttributesRequest - Represents the input to DescribeDBClusterSnapshotAttributes.Future<DBClusterSnapshotAttributesResult> describeDBClusterSnapshotAttributesAsync(DescribeDBClusterSnapshotAttributesRequest describeDBClusterSnapshotAttributesRequest, AsyncHandler<DescribeDBClusterSnapshotAttributesRequest,DBClusterSnapshotAttributesResult> asyncHandler)
Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
When you share snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the
restore attribute and a list of IDs for the AWS 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 AWS accounts.
describeDBClusterSnapshotAttributesRequest - 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.Future<DescribeDBClusterSnapshotsResult> describeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest)
Returns information about cluster snapshots. This API operation supports pagination.
describeDBClusterSnapshotsRequest - Represents the input to DescribeDBClusterSnapshots.Future<DescribeDBClusterSnapshotsResult> describeDBClusterSnapshotsAsync(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest, AsyncHandler<DescribeDBClusterSnapshotsRequest,DescribeDBClusterSnapshotsResult> asyncHandler)
Returns information about cluster snapshots. This API operation supports pagination.
describeDBClusterSnapshotsRequest - 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.Future<DescribeDBClustersResult> describeDBClustersAsync(DescribeDBClustersRequest describeDBClustersRequest)
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.
describeDBClustersRequest - Represents the input to DescribeDBClusters.Future<DescribeDBClustersResult> describeDBClustersAsync(DescribeDBClustersRequest describeDBClustersRequest, AsyncHandler<DescribeDBClustersRequest,DescribeDBClustersResult> asyncHandler)
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.
describeDBClustersRequest - 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.Future<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)
Returns a list of the available engines.
describeDBEngineVersionsRequest - Represents the input to DescribeDBEngineVersions.Future<DescribeDBEngineVersionsResult> describeDBEngineVersionsAsync(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest, AsyncHandler<DescribeDBEngineVersionsRequest,DescribeDBEngineVersionsResult> asyncHandler)
Returns a list of the available engines.
describeDBEngineVersionsRequest - 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.Future<DescribeDBInstancesResult> describeDBInstancesAsync(DescribeDBInstancesRequest describeDBInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
describeDBInstancesRequest - Represents the input to DescribeDBInstances.Future<DescribeDBInstancesResult> describeDBInstancesAsync(DescribeDBInstancesRequest describeDBInstancesRequest, AsyncHandler<DescribeDBInstancesRequest,DescribeDBInstancesResult> asyncHandler)
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
describeDBInstancesRequest - 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.Future<DescribeDBSubnetGroupsResult> describeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest)
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
describeDBSubnetGroupsRequest - Represents the input to DescribeDBSubnetGroups.Future<DescribeDBSubnetGroupsResult> describeDBSubnetGroupsAsync(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest, AsyncHandler<DescribeDBSubnetGroupsRequest,DescribeDBSubnetGroupsResult> asyncHandler)
Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the
list will contain only the descriptions of the specified DBSubnetGroup.
describeDBSubnetGroupsRequest - 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.Future<EngineDefaults> describeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.
describeEngineDefaultClusterParametersRequest - Represents the input to DescribeEngineDefaultClusterParameters.Future<EngineDefaults> describeEngineDefaultClusterParametersAsync(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest, AsyncHandler<DescribeEngineDefaultClusterParametersRequest,EngineDefaults> asyncHandler)
Returns the default engine and system parameter information for the cluster database engine.
describeEngineDefaultClusterParametersRequest - 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.Future<DescribeEventCategoriesResult> describeEventCategoriesAsync(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of categories for all event source types, or, if specified, for a specified source type.
describeEventCategoriesRequest - Represents the input to DescribeEventCategories.Future<DescribeEventCategoriesResult> describeEventCategoriesAsync(DescribeEventCategoriesRequest describeEventCategoriesRequest, AsyncHandler<DescribeEventCategoriesRequest,DescribeEventCategoriesResult> asyncHandler)
Displays a list of categories for all event source types, or, if specified, for a specified source type.
describeEventCategoriesRequest - 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.Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest describeEventsRequest)
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.
describeEventsRequest - Represents the input to DescribeEvents.Future<DescribeEventsResult> describeEventsAsync(DescribeEventsRequest describeEventsRequest, AsyncHandler<DescribeEventsRequest,DescribeEventsResult> asyncHandler)
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.
describeEventsRequest - 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.Future<DescribeOrderableDBInstanceOptionsResult> describeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest)
Returns a list of orderable instance options for the specified engine.
describeOrderableDBInstanceOptionsRequest - Represents the input to DescribeOrderableDBInstanceOptions.Future<DescribeOrderableDBInstanceOptionsResult> describeOrderableDBInstanceOptionsAsync(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest, AsyncHandler<DescribeOrderableDBInstanceOptionsRequest,DescribeOrderableDBInstanceOptionsResult> asyncHandler)
Returns a list of orderable instance options for the specified engine.
describeOrderableDBInstanceOptionsRequest - 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.Future<DescribePendingMaintenanceActionsResult> describePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsRequest - Represents the input to DescribePendingMaintenanceActions.Future<DescribePendingMaintenanceActionsResult> describePendingMaintenanceActionsAsync(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest, AsyncHandler<DescribePendingMaintenanceActionsRequest,DescribePendingMaintenanceActionsResult> asyncHandler)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsRequest - 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.Future<DBCluster> failoverDBClusterAsync(FailoverDBClusterRequest failoverDBClusterRequest)
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.
failoverDBClusterRequest - Represents the input to FailoverDBCluster.Future<DBCluster> failoverDBClusterAsync(FailoverDBClusterRequest failoverDBClusterRequest, AsyncHandler<FailoverDBClusterRequest,DBCluster> asyncHandler)
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.
failoverDBClusterRequest - 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.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an Amazon DocumentDB resource.
listTagsForResourceRequest - Represents the input to ListTagsForResource.Future<ListTagsForResourceResult> listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, AsyncHandler<ListTagsForResourceRequest,ListTagsForResourceResult> asyncHandler)
Lists all tags on an Amazon DocumentDB resource.
listTagsForResourceRequest - 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.Future<DBCluster> modifyDBClusterAsync(ModifyDBClusterRequest modifyDBClusterRequest)
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.
modifyDBClusterRequest - Represents the input to ModifyDBCluster.Future<DBCluster> modifyDBClusterAsync(ModifyDBClusterRequest modifyDBClusterRequest, AsyncHandler<ModifyDBClusterRequest,DBCluster> asyncHandler)
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.
modifyDBClusterRequest - 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.Future<ModifyDBClusterParameterGroupResult> modifyDBClusterParameterGroupAsync(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest)
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.
modifyDBClusterParameterGroupRequest - Represents the input to ModifyDBClusterParameterGroup.Future<ModifyDBClusterParameterGroupResult> modifyDBClusterParameterGroupAsync(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest, AsyncHandler<ModifyDBClusterParameterGroupRequest,ModifyDBClusterParameterGroupResult> asyncHandler)
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.
modifyDBClusterParameterGroupRequest - 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.Future<DBClusterSnapshotAttributesResult> modifyDBClusterSnapshotAttributeAsync(ModifyDBClusterSnapshotAttributeRequest modifyDBClusterSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual cluster snapshot with other AWS accounts, specify restore as the
AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the AWS
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 AWS accounts. Do not add the
all value for any manual DB cluster snapshots that contain private information that you don't want
available to all AWS accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by
specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use
all as a value for that parameter in this case.
modifyDBClusterSnapshotAttributeRequest - Represents the input to ModifyDBClusterSnapshotAttribute.Future<DBClusterSnapshotAttributesResult> modifyDBClusterSnapshotAttributeAsync(ModifyDBClusterSnapshotAttributeRequest modifyDBClusterSnapshotAttributeRequest, AsyncHandler<ModifyDBClusterSnapshotAttributeRequest,DBClusterSnapshotAttributesResult> asyncHandler)
Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
To share a manual cluster snapshot with other AWS accounts, specify restore as the
AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the AWS
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 AWS accounts. Do not add the
all value for any manual DB cluster snapshots that contain private information that you don't want
available to all AWS accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by
specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use
all as a value for that parameter in this case.
modifyDBClusterSnapshotAttributeRequest - 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.Future<DBInstance> modifyDBInstanceAsync(ModifyDBInstanceRequest modifyDBInstanceRequest)
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.
modifyDBInstanceRequest - Represents the input to ModifyDBInstance.Future<DBInstance> modifyDBInstanceAsync(ModifyDBInstanceRequest modifyDBInstanceRequest, AsyncHandler<ModifyDBInstanceRequest,DBInstance> asyncHandler)
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.
modifyDBInstanceRequest - 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.Future<DBSubnetGroup> modifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest)
Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.
modifyDBSubnetGroupRequest - Represents the input to ModifyDBSubnetGroup.Future<DBSubnetGroup> modifyDBSubnetGroupAsync(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest, AsyncHandler<ModifyDBSubnetGroupRequest,DBSubnetGroup> asyncHandler)
Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.
modifyDBSubnetGroupRequest - 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.Future<DBInstance> rebootDBInstanceAsync(RebootDBInstanceRequest rebootDBInstanceRequest)
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.
rebootDBInstanceRequest - Represents the input to RebootDBInstance.Future<DBInstance> rebootDBInstanceAsync(RebootDBInstanceRequest rebootDBInstanceRequest, AsyncHandler<RebootDBInstanceRequest,DBInstance> asyncHandler)
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.
rebootDBInstanceRequest - 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.Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from an Amazon DocumentDB resource.
removeTagsFromResourceRequest - Represents the input to RemoveTagsFromResource.Future<RemoveTagsFromResourceResult> removeTagsFromResourceAsync(RemoveTagsFromResourceRequest removeTagsFromResourceRequest, AsyncHandler<RemoveTagsFromResourceRequest,RemoveTagsFromResourceResult> asyncHandler)
Removes metadata tags from an Amazon DocumentDB resource.
removeTagsFromResourceRequest - 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.Future<ResetDBClusterParameterGroupResult> resetDBClusterParameterGroupAsync(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest)
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.
resetDBClusterParameterGroupRequest - Represents the input to ResetDBClusterParameterGroup.Future<ResetDBClusterParameterGroupResult> resetDBClusterParameterGroupAsync(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest, AsyncHandler<ResetDBClusterParameterGroupRequest,ResetDBClusterParameterGroupResult> asyncHandler)
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.
resetDBClusterParameterGroupRequest - 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.Future<DBCluster> restoreDBClusterFromSnapshotAsync(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest)
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.
restoreDBClusterFromSnapshotRequest - Represents the input to RestoreDBClusterFromSnapshot.Future<DBCluster> restoreDBClusterFromSnapshotAsync(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest, AsyncHandler<RestoreDBClusterFromSnapshotRequest,DBCluster> asyncHandler)
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.
restoreDBClusterFromSnapshotRequest - 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.Future<DBCluster> restoreDBClusterToPointInTimeAsync(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest)
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.
restoreDBClusterToPointInTimeRequest - Represents the input to RestoreDBClusterToPointInTime.Future<DBCluster> restoreDBClusterToPointInTimeAsync(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest, AsyncHandler<RestoreDBClusterToPointInTimeRequest,DBCluster> asyncHandler)
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.
restoreDBClusterToPointInTimeRequest - 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.Future<DBCluster> startDBClusterAsync(StartDBClusterRequest startDBClusterRequest)
Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
startDBClusterRequest - Future<DBCluster> startDBClusterAsync(StartDBClusterRequest startDBClusterRequest, AsyncHandler<StartDBClusterRequest,DBCluster> asyncHandler)
Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
startDBClusterRequest - 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.Future<DBCluster> stopDBClusterAsync(StopDBClusterRequest stopDBClusterRequest)
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.
stopDBClusterRequest - Future<DBCluster> stopDBClusterAsync(StopDBClusterRequest stopDBClusterRequest, AsyncHandler<StopDBClusterRequest,DBCluster> asyncHandler)
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.
stopDBClusterRequest - 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.