/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.docdb; import javax.annotation.Generated; import com.amazonaws.services.docdb.model.*; /** * Interface for accessing Amazon DocDB asynchronously. Each asynchronous method will return a Java Future object * representing the asynchronous operation; overloads which accept an {@code 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 * {@link com.amazonaws.services.docdb.AbstractAmazonDocDBAsync} instead. *
**
* Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, * operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same * application code and use the same drivers and tools that you use with MongoDB. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AmazonDocDBAsync extends AmazonDocDB { /** ** Adds a source identifier to an existing event notification subscription. *
* * @param addSourceIdentifierToSubscriptionRequest * Represents the input to AddSourceIdentifierToSubscription. * @return A Java Future containing the result of the AddSourceIdentifierToSubscription operation returned by the * service. * @sample AmazonDocDBAsync.AddSourceIdentifierToSubscription * @see AWS API Documentation */ java.util.concurrent.Future* Adds a source identifier to an existing event notification subscription. *
* * @param addSourceIdentifierToSubscriptionRequest * Represents the input to AddSourceIdentifierToSubscription. * @param 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. * @return A Java Future containing the result of the AddSourceIdentifierToSubscription operation returned by the * service. * @sample AmazonDocDBAsyncHandler.AddSourceIdentifierToSubscription * @see AWS API Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance). *
* * @param applyPendingMaintenanceActionRequest * Represents the input to ApplyPendingMaintenanceAction. * @return A Java Future containing the result of the ApplyPendingMaintenanceAction operation returned by the * service. * @sample AmazonDocDBAsync.ApplyPendingMaintenanceAction * @see AWS API Documentation */ java.util.concurrent.Future* Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance). *
* * @param applyPendingMaintenanceActionRequest * Represents the input to ApplyPendingMaintenanceAction. * @param 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. * @return A Java Future containing the result of the ApplyPendingMaintenanceAction operation returned by the * service. * @sample AmazonDocDBAsyncHandler.ApplyPendingMaintenanceAction * @see AWS API Documentation */ java.util.concurrent.Future* Copies the specified cluster parameter group. *
* * @param copyDBClusterParameterGroupRequest * Represents the input to CopyDBClusterParameterGroup. * @return A Java Future containing the result of the CopyDBClusterParameterGroup operation returned by the service. * @sample AmazonDocDBAsync.CopyDBClusterParameterGroup * @see AWS API Documentation */ java.util.concurrent.Future* Copies the specified cluster parameter group. *
* * @param copyDBClusterParameterGroupRequest * Represents the input to CopyDBClusterParameterGroup. * @param 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. * @return A Java Future containing the result of the CopyDBClusterParameterGroup operation returned by the service. * @sample AmazonDocDBAsyncHandler.CopyDBClusterParameterGroup * @see AWS API Documentation */ java.util.concurrent.Future* Copies a snapshot of a cluster. *
*
* To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier
* must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster
* snapshot, whether encrypted or not, in the same Amazon Web Services Region.
*
* To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by
* TargetDBClusterSnapshotIdentifier
while that cluster snapshot is in the copying status.
*
* Copies a snapshot of a cluster. *
*
* To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier
* must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster
* snapshot, whether encrypted or not, in the same Amazon Web Services Region.
*
* To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by
* TargetDBClusterSnapshotIdentifier
while that cluster snapshot is in the copying status.
*
* Creates a new Amazon DocumentDB cluster. *
* * @param createDBClusterRequest * Represents the input to CreateDBCluster. * @return A Java Future containing the result of the CreateDBCluster operation returned by the service. * @sample AmazonDocDBAsync.CreateDBCluster * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a new Amazon DocumentDB cluster. *
* * @param createDBClusterRequest * Represents the input to CreateDBCluster. * @param 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. * @return A Java Future containing the result of the CreateDBCluster operation returned by the service. * @sample AmazonDocDBAsyncHandler.CreateDBCluster * @see AWS API * Documentation */ java.util.concurrent.Future* 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.
*
* 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.
*
* Creates a snapshot of a cluster. *
* * @param createDBClusterSnapshotRequest * Represents the input of CreateDBClusterSnapshot. * @return A Java Future containing the result of the CreateDBClusterSnapshot operation returned by the service. * @sample AmazonDocDBAsync.CreateDBClusterSnapshot * @see AWS * API Documentation */ java.util.concurrent.Future* Creates a snapshot of a cluster. *
* * @param createDBClusterSnapshotRequest * Represents the input of CreateDBClusterSnapshot. * @param 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. * @return A Java Future containing the result of the CreateDBClusterSnapshot operation returned by the service. * @sample AmazonDocDBAsyncHandler.CreateDBClusterSnapshot * @see AWS * API Documentation */ java.util.concurrent.Future* Creates a new instance. *
* * @param createDBInstanceRequest * Represents the input to CreateDBInstance. * @return A Java Future containing the result of the CreateDBInstance operation returned by the service. * @sample AmazonDocDBAsync.CreateDBInstance * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a new instance. *
* * @param createDBInstanceRequest * Represents the input to CreateDBInstance. * @param 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. * @return A Java Future containing the result of the CreateDBInstance operation returned by the service. * @sample AmazonDocDBAsyncHandler.CreateDBInstance * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in * the Amazon Web Services Region. *
* * @param createDBSubnetGroupRequest * Represents the input to CreateDBSubnetGroup. * @return A Java Future containing the result of the CreateDBSubnetGroup operation returned by the service. * @sample AmazonDocDBAsync.CreateDBSubnetGroup * @see AWS API * Documentation */ java.util.concurrent.Future* Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in * the Amazon Web Services Region. *
* * @param createDBSubnetGroupRequest * Represents the input to CreateDBSubnetGroup. * @param 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. * @return A Java Future containing the result of the CreateDBSubnetGroup operation returned by the service. * @sample AmazonDocDBAsyncHandler.CreateDBSubnetGroup * @see AWS API * Documentation */ java.util.concurrent.Future* Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name * (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an * ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in * the Amazon SNS console. *
*
* You can specify the type of source (SourceType
) that you want to be notified of. You can also
* provide a list of Amazon DocumentDB sources (SourceIds
) that trigger the events, and you can provide
* a list of event categories (EventCategories
) for events that you want to be notified of. For
* example, you can specify SourceType = db-instance
,
* SourceIds = mydbinstance1, mydbinstance2
and EventCategories = Availability, Backup
.
*
* If you specify both the SourceType
and SourceIds
(such as
* SourceType = db-instance
and SourceIdentifier = myDBInstance1
), you are notified of all
* the db-instance
events for the specified source. If you specify a SourceType
but do not
* specify a SourceIdentifier
, you receive notice of the events for that source type for all your
* Amazon DocumentDB sources. If you do not specify either the SourceType
or the
* SourceIdentifier
, you are notified of events generated from all Amazon DocumentDB sources belonging
* to your customer account.
*
* Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name * (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an * ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in * the Amazon SNS console. *
*
* You can specify the type of source (SourceType
) that you want to be notified of. You can also
* provide a list of Amazon DocumentDB sources (SourceIds
) that trigger the events, and you can provide
* a list of event categories (EventCategories
) for events that you want to be notified of. For
* example, you can specify SourceType = db-instance
,
* SourceIds = mydbinstance1, mydbinstance2
and EventCategories = Availability, Backup
.
*
* If you specify both the SourceType
and SourceIds
(such as
* SourceType = db-instance
and SourceIdentifier = myDBInstance1
), you are notified of all
* the db-instance
events for the specified source. If you specify a SourceType
but do not
* specify a SourceIdentifier
, you receive notice of the events for that source type for all your
* Amazon DocumentDB sources. If you do not specify either the SourceType
or the
* SourceIdentifier
, you are notified of events generated from all Amazon DocumentDB sources belonging
* to your customer account.
*
* Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The * global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary * clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, * using dedicated infrastructure with no impact to your workload’s performance. *
* ** You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can * specify an existing cluster during the create operation, and this cluster becomes the primary of the global * cluster. *
** This action only applies to Amazon DocumentDB clusters. *
** Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The * global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary * clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, * using dedicated infrastructure with no impact to your workload’s performance. *
* ** You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can * specify an existing cluster during the create operation, and this cluster becomes the primary of the global * cluster. *
** This action only applies to Amazon DocumentDB clusters. *
** 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. *
* * * @param deleteDBClusterRequest * Represents the input to DeleteDBCluster. * @return A Java Future containing the result of the DeleteDBCluster operation returned by the service. * @sample AmazonDocDBAsync.DeleteDBCluster * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * * @param deleteDBClusterRequest * Represents the input to DeleteDBCluster. * @param 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. * @return A Java Future containing the result of the DeleteDBCluster operation returned by the service. * @sample AmazonDocDBAsyncHandler.DeleteDBCluster * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with * any clusters. *
* * @param deleteDBClusterParameterGroupRequest * Represents the input to DeleteDBClusterParameterGroup. * @return A Java Future containing the result of the DeleteDBClusterParameterGroup operation returned by the * service. * @sample AmazonDocDBAsync.DeleteDBClusterParameterGroup * @see AWS API Documentation */ java.util.concurrent.Future* Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with * any clusters. *
* * @param deleteDBClusterParameterGroupRequest * Represents the input to DeleteDBClusterParameterGroup. * @param 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. * @return A Java Future containing the result of the DeleteDBClusterParameterGroup operation returned by the * service. * @sample AmazonDocDBAsyncHandler.DeleteDBClusterParameterGroup * @see AWS API Documentation */ java.util.concurrent.Future* 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.
*
* 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.
*
* Deletes a previously provisioned instance. *
* * @param deleteDBInstanceRequest * Represents the input to DeleteDBInstance. * @return A Java Future containing the result of the DeleteDBInstance operation returned by the service. * @sample AmazonDocDBAsync.DeleteDBInstance * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes a previously provisioned instance. *
* * @param deleteDBInstanceRequest * Represents the input to DeleteDBInstance. * @param 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. * @return A Java Future containing the result of the DeleteDBInstance operation returned by the service. * @sample AmazonDocDBAsyncHandler.DeleteDBInstance * @see AWS API * Documentation */ java.util.concurrent.Future* Deletes a subnet group. *
** The specified database subnet group must not be associated with any DB instances. *
** Deletes a subnet group. *
** The specified database subnet group must not be associated with any DB instances. *
** Deletes an Amazon DocumentDB event notification subscription. *
* * @param deleteEventSubscriptionRequest * Represents the input to DeleteEventSubscription. * @return A Java Future containing the result of the DeleteEventSubscription operation returned by the service. * @sample AmazonDocDBAsync.DeleteEventSubscription * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes an Amazon DocumentDB event notification subscription. *
* * @param deleteEventSubscriptionRequest * Represents the input to DeleteEventSubscription. * @param 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. * @return A Java Future containing the result of the DeleteEventSubscription operation returned by the service. * @sample AmazonDocDBAsyncHandler.DeleteEventSubscription * @see AWS * API Documentation */ java.util.concurrent.Future* Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before * attempting to delete a global cluster. *
** This action only applies to Amazon DocumentDB clusters. *
** Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before * attempting to delete a global cluster. *
** This action only applies to Amazon DocumentDB clusters. *
** Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web * Services account. *
* * @param describeCertificatesRequest * @return A Java Future containing the result of the DescribeCertificates operation returned by the service. * @sample AmazonDocDBAsync.DescribeCertificates * @see AWS API * Documentation */ java.util.concurrent.Future* Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web * Services account. *
* * @param describeCertificatesRequest * @param 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. * @return A Java Future containing the result of the DescribeCertificates operation returned by the service. * @sample AmazonDocDBAsyncHandler.DescribeCertificates * @see AWS API * Documentation */ java.util.concurrent.Future
* Returns a list of DBClusterParameterGroup
descriptions. If a
* DBClusterParameterGroupName
parameter is specified, the list contains only the description of the
* specified cluster parameter group.
*
* Returns a list of DBClusterParameterGroup
descriptions. If a
* DBClusterParameterGroupName
parameter is specified, the list contains only the description of the
* specified cluster parameter group.
*
* Returns the detailed parameter list for a particular cluster parameter group. *
* * @param describeDBClusterParametersRequest * Represents the input to DescribeDBClusterParameters. * @return A Java Future containing the result of the DescribeDBClusterParameters operation returned by the service. * @sample AmazonDocDBAsync.DescribeDBClusterParameters * @see AWS API Documentation */ java.util.concurrent.Future* Returns the detailed parameter list for a particular cluster parameter group. *
* * @param describeDBClusterParametersRequest * Represents the input to DescribeDBClusterParameters. * @param 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. * @return A Java Future containing the result of the DescribeDBClusterParameters operation returned by the service. * @sample AmazonDocDBAsyncHandler.DescribeDBClusterParameters * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot. *
*
* When you share snapshots with other Amazon Web Services accounts,
* DescribeDBClusterSnapshotAttributes
returns the restore
attribute and a list of IDs for
* the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If
* all
is included in the list of values for the restore
attribute, then the manual
* cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
*
* Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot. *
*
* When you share snapshots with other Amazon Web Services accounts,
* DescribeDBClusterSnapshotAttributes
returns the restore
attribute and a list of IDs for
* the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If
* all
is included in the list of values for the restore
attribute, then the manual
* cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
*
* Returns information about cluster snapshots. This API operation supports pagination. *
* * @param describeDBClusterSnapshotsRequest * Represents the input to DescribeDBClusterSnapshots. * @return A Java Future containing the result of the DescribeDBClusterSnapshots operation returned by the service. * @sample AmazonDocDBAsync.DescribeDBClusterSnapshots * @see AWS API Documentation */ java.util.concurrent.Future* Returns information about cluster snapshots. This API operation supports pagination. *
* * @param describeDBClusterSnapshotsRequest * Represents the input to DescribeDBClusterSnapshots. * @param 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. * @return A Java Future containing the result of the DescribeDBClusterSnapshots operation returned by the service. * @sample AmazonDocDBAsyncHandler.DescribeDBClusterSnapshots * @see AWS API Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Returns a list of the available engines. *
* * @param describeDBEngineVersionsRequest * Represents the input to DescribeDBEngineVersions. * @return A Java Future containing the result of the DescribeDBEngineVersions operation returned by the service. * @sample AmazonDocDBAsync.DescribeDBEngineVersions * @see AWS * API Documentation */ java.util.concurrent.Future* Returns a list of the available engines. *
* * @param describeDBEngineVersionsRequest * Represents the input to DescribeDBEngineVersions. * @param 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. * @return A Java Future containing the result of the DescribeDBEngineVersions operation returned by the service. * @sample AmazonDocDBAsyncHandler.DescribeDBEngineVersions * @see AWS * API Documentation */ java.util.concurrent.Future* Returns information about provisioned Amazon DocumentDB instances. This API supports pagination. *
* * @param describeDBInstancesRequest * Represents the input to DescribeDBInstances. * @return A Java Future containing the result of the DescribeDBInstances operation returned by the service. * @sample AmazonDocDBAsync.DescribeDBInstances * @see AWS API * Documentation */ java.util.concurrent.Future* Returns information about provisioned Amazon DocumentDB instances. This API supports pagination. *
* * @param describeDBInstancesRequest * Represents the input to DescribeDBInstances. * @param 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. * @return A Java Future containing the result of the DescribeDBInstances operation returned by the service. * @sample AmazonDocDBAsyncHandler.DescribeDBInstances * @see AWS API * Documentation */ java.util.concurrent.Future
* Returns a list of DBSubnetGroup
descriptions. If a DBSubnetGroupName
is specified, the
* list will contain only the descriptions of the specified DBSubnetGroup
.
*
* Returns a list of DBSubnetGroup
descriptions. If a DBSubnetGroupName
is specified, the
* list will contain only the descriptions of the specified DBSubnetGroup
.
*
* Returns the default engine and system parameter information for the cluster database engine. *
* * @param describeEngineDefaultClusterParametersRequest * Represents the input to DescribeEngineDefaultClusterParameters. * @return A Java Future containing the result of the DescribeEngineDefaultClusterParameters operation returned by * the service. * @sample AmazonDocDBAsync.DescribeEngineDefaultClusterParameters * @see AWS API Documentation */ java.util.concurrent.Future* Returns the default engine and system parameter information for the cluster database engine. *
* * @param describeEngineDefaultClusterParametersRequest * Represents the input to DescribeEngineDefaultClusterParameters. * @param 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. * @return A Java Future containing the result of the DescribeEngineDefaultClusterParameters operation returned by * the service. * @sample AmazonDocDBAsyncHandler.DescribeEngineDefaultClusterParameters * @see AWS API Documentation */ java.util.concurrent.Future* Displays a list of categories for all event source types, or, if specified, for a specified source type. *
* * @param describeEventCategoriesRequest * Represents the input to DescribeEventCategories. * @return A Java Future containing the result of the DescribeEventCategories operation returned by the service. * @sample AmazonDocDBAsync.DescribeEventCategories * @see AWS * API Documentation */ java.util.concurrent.Future* Displays a list of categories for all event source types, or, if specified, for a specified source type. *
* * @param describeEventCategoriesRequest * Represents the input to DescribeEventCategories. * @param 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. * @return A Java Future containing the result of the DescribeEventCategories operation returned by the service. * @sample AmazonDocDBAsyncHandler.DescribeEventCategories * @see AWS * API Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* 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. *
* * @param describeEventsRequest * Represents the input to DescribeEvents. * @return A Java Future containing the result of the DescribeEvents operation returned by the service. * @sample AmazonDocDBAsync.DescribeEvents * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param describeEventsRequest * Represents the input to DescribeEvents. * @param 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. * @return A Java Future containing the result of the DescribeEvents operation returned by the service. * @sample AmazonDocDBAsyncHandler.DescribeEvents * @see AWS API * Documentation */ java.util.concurrent.Future* Returns information about Amazon DocumentDB global clusters. This API supports pagination. *
** This action only applies to Amazon DocumentDB clusters. *
** Returns information about Amazon DocumentDB global clusters. This API supports pagination. *
** This action only applies to Amazon DocumentDB clusters. *
** Returns a list of orderable instance options for the specified engine. *
* * @param describeOrderableDBInstanceOptionsRequest * Represents the input to DescribeOrderableDBInstanceOptions. * @return A Java Future containing the result of the DescribeOrderableDBInstanceOptions operation returned by the * service. * @sample AmazonDocDBAsync.DescribeOrderableDBInstanceOptions * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of orderable instance options for the specified engine. *
* * @param describeOrderableDBInstanceOptionsRequest * Represents the input to DescribeOrderableDBInstanceOptions. * @param 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. * @return A Java Future containing the result of the DescribeOrderableDBInstanceOptions operation returned by the * service. * @sample AmazonDocDBAsyncHandler.DescribeOrderableDBInstanceOptions * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of resources (for example, instances) that have at least one pending maintenance action. *
* * @param describePendingMaintenanceActionsRequest * Represents the input to DescribePendingMaintenanceActions. * @return A Java Future containing the result of the DescribePendingMaintenanceActions operation returned by the * service. * @sample AmazonDocDBAsync.DescribePendingMaintenanceActions * @see AWS API Documentation */ java.util.concurrent.Future* Returns a list of resources (for example, instances) that have at least one pending maintenance action. *
* * @param describePendingMaintenanceActionsRequest * Represents the input to DescribePendingMaintenanceActions. * @param 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. * @return A Java Future containing the result of the DescribePendingMaintenanceActions operation returned by the * service. * @sample AmazonDocDBAsyncHandler.DescribePendingMaintenanceActions * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param failoverDBClusterRequest * Represents the input to FailoverDBCluster. * @return A Java Future containing the result of the FailoverDBCluster operation returned by the service. * @sample AmazonDocDBAsync.FailoverDBCluster * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param failoverDBClusterRequest * Represents the input to FailoverDBCluster. * @param 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. * @return A Java Future containing the result of the FailoverDBCluster operation returned by the service. * @sample AmazonDocDBAsyncHandler.FailoverDBCluster * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all tags on an Amazon DocumentDB resource. *
* * @param listTagsForResourceRequest * Represents the input to ListTagsForResource. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonDocDBAsync.ListTagsForResource * @see AWS API * Documentation */ java.util.concurrent.Future* Lists all tags on an Amazon DocumentDB resource. *
* * @param listTagsForResourceRequest * Represents the input to ListTagsForResource. * @param 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. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AmazonDocDBAsyncHandler.ListTagsForResource * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param modifyDBClusterRequest * Represents the input to ModifyDBCluster. * @return A Java Future containing the result of the ModifyDBCluster operation returned by the service. * @sample AmazonDocDBAsync.ModifyDBCluster * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param modifyDBClusterRequest * Represents the input to ModifyDBCluster. * @param 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. * @return A Java Future containing the result of the ModifyDBCluster operation returned by the service. * @sample AmazonDocDBAsyncHandler.ModifyDBCluster * @see AWS API * Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot. *
*
* To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore
as the
* AttributeName
, and use the ValuesToAdd
parameter to add a list of IDs of the Amazon Web
* Services accounts that are authorized to restore the manual cluster snapshot. Use the value all
to
* make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services
* accounts. Do not add the all
value for any manual cluster snapshots that contain private information
* that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it
* can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the
* ValuesToAdd
parameter. You can't use all
as a value for that parameter in this case.
*
* Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot. *
*
* To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore
as the
* AttributeName
, and use the ValuesToAdd
parameter to add a list of IDs of the Amazon Web
* Services accounts that are authorized to restore the manual cluster snapshot. Use the value all
to
* make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services
* accounts. Do not add the all
value for any manual cluster snapshots that contain private information
* that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it
* can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the
* ValuesToAdd
parameter. You can't use all
as a value for that parameter in this case.
*
* 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. *
* * @param modifyDBInstanceRequest * Represents the input to ModifyDBInstance. * @return A Java Future containing the result of the ModifyDBInstance operation returned by the service. * @sample AmazonDocDBAsync.ModifyDBInstance * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param modifyDBInstanceRequest * Represents the input to ModifyDBInstance. * @param 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. * @return A Java Future containing the result of the ModifyDBInstance operation returned by the service. * @sample AmazonDocDBAsyncHandler.ModifyDBInstance * @see AWS API * Documentation */ java.util.concurrent.Future* Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability * Zones in the Amazon Web Services Region. *
* * @param modifyDBSubnetGroupRequest * Represents the input to ModifyDBSubnetGroup. * @return A Java Future containing the result of the ModifyDBSubnetGroup operation returned by the service. * @sample AmazonDocDBAsync.ModifyDBSubnetGroup * @see AWS API * Documentation */ java.util.concurrent.Future* Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability * Zones in the Amazon Web Services Region. *
* * @param modifyDBSubnetGroupRequest * Represents the input to ModifyDBSubnetGroup. * @param 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. * @return A Java Future containing the result of the ModifyDBSubnetGroup operation returned by the service. * @sample AmazonDocDBAsyncHandler.ModifyDBSubnetGroup * @see AWS API * Documentation */ java.util.concurrent.Future* Modifies an existing Amazon DocumentDB event notification subscription. *
* * @param modifyEventSubscriptionRequest * Represents the input to ModifyEventSubscription. * @return A Java Future containing the result of the ModifyEventSubscription operation returned by the service. * @sample AmazonDocDBAsync.ModifyEventSubscription * @see AWS * API Documentation */ java.util.concurrent.Future* Modifies an existing Amazon DocumentDB event notification subscription. *
* * @param modifyEventSubscriptionRequest * Represents the input to ModifyEventSubscription. * @param 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. * @return A Java Future containing the result of the ModifyEventSubscription operation returned by the service. * @sample AmazonDocDBAsyncHandler.ModifyEventSubscription * @see AWS * API Documentation */ java.util.concurrent.Future* Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters * (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new * values in the request. *
** This action only applies to Amazon DocumentDB clusters. *
** Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters * (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new * values in the request. *
** This action only applies to Amazon DocumentDB clusters. *
** 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. *
* * @param rebootDBInstanceRequest * Represents the input to RebootDBInstance. * @return A Java Future containing the result of the RebootDBInstance operation returned by the service. * @sample AmazonDocDBAsync.RebootDBInstance * @see AWS API * Documentation */ java.util.concurrent.Future* 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. *
* * @param rebootDBInstanceRequest * Represents the input to RebootDBInstance. * @param 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. * @return A Java Future containing the result of the RebootDBInstance operation returned by the service. * @sample AmazonDocDBAsyncHandler.RebootDBInstance * @see AWS API * Documentation */ java.util.concurrent.Future* Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster * with read-write capability instead of being read-only and receiving data from a primary in a different region. *
** This action only applies to Amazon DocumentDB clusters. *
** Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster * with read-write capability instead of being read-only and receiving data from a primary in a different region. *
** This action only applies to Amazon DocumentDB clusters. *
** Removes a source identifier from an existing Amazon DocumentDB event notification subscription. *
* * @param removeSourceIdentifierFromSubscriptionRequest * Represents the input to RemoveSourceIdentifierFromSubscription. * @return A Java Future containing the result of the RemoveSourceIdentifierFromSubscription operation returned by * the service. * @sample AmazonDocDBAsync.RemoveSourceIdentifierFromSubscription * @see AWS API Documentation */ java.util.concurrent.Future* Removes a source identifier from an existing Amazon DocumentDB event notification subscription. *
* * @param removeSourceIdentifierFromSubscriptionRequest * Represents the input to RemoveSourceIdentifierFromSubscription. * @param 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. * @return A Java Future containing the result of the RemoveSourceIdentifierFromSubscription operation returned by * the service. * @sample AmazonDocDBAsyncHandler.RemoveSourceIdentifierFromSubscription * @see AWS API Documentation */ java.util.concurrent.Future* Removes metadata tags from an Amazon DocumentDB resource. *
* * @param removeTagsFromResourceRequest * Represents the input to RemoveTagsFromResource. * @return A Java Future containing the result of the RemoveTagsFromResource operation returned by the service. * @sample AmazonDocDBAsync.RemoveTagsFromResource * @see AWS * API Documentation */ java.util.concurrent.Future* Removes metadata tags from an Amazon DocumentDB resource. *
* * @param removeTagsFromResourceRequest * Represents the input to RemoveTagsFromResource. * @param 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. * @return A Java Future containing the result of the RemoveTagsFromResource operation returned by the service. * @sample AmazonDocDBAsyncHandler.RemoveTagsFromResource * @see AWS * API Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* 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. *
* * @param restoreDBClusterFromSnapshotRequest * Represents the input to RestoreDBClusterFromSnapshot. * @return A Java Future containing the result of the RestoreDBClusterFromSnapshot operation returned by the * service. * @sample AmazonDocDBAsync.RestoreDBClusterFromSnapshot * @see AWS API Documentation */ java.util.concurrent.Future* 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. *
* * @param restoreDBClusterFromSnapshotRequest * Represents the input to RestoreDBClusterFromSnapshot. * @param 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. * @return A Java Future containing the result of the RestoreDBClusterFromSnapshot operation returned by the * service. * @sample AmazonDocDBAsyncHandler.RestoreDBClusterFromSnapshot * @see AWS API Documentation */ java.util.concurrent.Future
* 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.
*
* 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.
*
* Restarts the stopped cluster that is specified by DBClusterIdentifier
. For more information, see Stopping and
* Starting an Amazon DocumentDB Cluster.
*
* Restarts the stopped cluster that is specified by DBClusterIdentifier
. For more information, see Stopping and
* Starting an Amazon DocumentDB Cluster.
*
* 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.
*
* 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.
*