AbstractAmazonDocDB (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.docdb.AbstractAmazonDocDB

All Implemented Interfaces:

AmazonDocDB

Direct Known Subclasses:

AbstractAmazonDocDBAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonDocDB
extends Object
implements AmazonDocDB
```
Abstract implementation of AmazonDocDB. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.docdb.AmazonDocDB
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AddTagsToResourceResult`	`addTagsToResource(AddTagsToResourceRequest request)` Adds metadata tags to an Amazon DocumentDB resource.
`ResourcePendingMaintenanceActions`	`applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)` Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
`DBClusterParameterGroup`	`copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest request)` Copies the specified cluster parameter group.
`DBClusterSnapshot`	`copyDBClusterSnapshot(CopyDBClusterSnapshotRequest request)` Copies a snapshot of a cluster.
`DBCluster`	`createDBCluster(CreateDBClusterRequest request)` Creates a new Amazon DocumentDB cluster.
`DBClusterParameterGroup`	`createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest request)` Creates a new cluster parameter group.
`DBClusterSnapshot`	`createDBClusterSnapshot(CreateDBClusterSnapshotRequest request)` Creates a snapshot of a cluster.
`DBInstance`	`createDBInstance(CreateDBInstanceRequest request)` Creates a new instance.
`DBSubnetGroup`	`createDBSubnetGroup(CreateDBSubnetGroupRequest request)` Creates a new subnet group.
`DBCluster`	`deleteDBCluster(DeleteDBClusterRequest request)` Deletes a previously provisioned cluster.
`DeleteDBClusterParameterGroupResult`	`deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest request)` Deletes a specified cluster parameter group.
`DBClusterSnapshot`	`deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest request)` Deletes a cluster snapshot.
`DBInstance`	`deleteDBInstance(DeleteDBInstanceRequest request)` Deletes a previously provisioned instance.
`DeleteDBSubnetGroupResult`	`deleteDBSubnetGroup(DeleteDBSubnetGroupRequest request)` Deletes a subnet group.
`DescribeCertificatesResult`	`describeCertificates(DescribeCertificatesRequest request)` Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account.
`DescribeDBClusterParameterGroupsResult`	`describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest request)` Returns a list of `DBClusterParameterGroup` descriptions.
`DescribeDBClusterParametersResult`	`describeDBClusterParameters(DescribeDBClusterParametersRequest request)` Returns the detailed parameter list for a particular cluster parameter group.
`DescribeDBClustersResult`	`describeDBClusters(DescribeDBClustersRequest request)` Returns information about provisioned Amazon DocumentDB clusters.
`DBClusterSnapshotAttributesResult`	`describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest request)` Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
`DescribeDBClusterSnapshotsResult`	`describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest request)` Returns information about cluster snapshots.
`DescribeDBEngineVersionsResult`	`describeDBEngineVersions(DescribeDBEngineVersionsRequest request)` Returns a list of the available engines.
`DescribeDBInstancesResult`	`describeDBInstances(DescribeDBInstancesRequest request)` Returns information about provisioned Amazon DocumentDB instances.
`DescribeDBSubnetGroupsResult`	`describeDBSubnetGroups(DescribeDBSubnetGroupsRequest request)` Returns a list of `DBSubnetGroup` descriptions.
`EngineDefaults`	`describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest request)` Returns the default engine and system parameter information for the cluster database engine.
`DescribeEventCategoriesResult`	`describeEventCategories(DescribeEventCategoriesRequest request)` Displays a list of categories for all event source types, or, if specified, for a specified source type.
`DescribeEventsResult`	`describeEvents(DescribeEventsRequest request)` Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
`DescribeOrderableDBInstanceOptionsResult`	`describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest request)` Returns a list of orderable instance options for the specified engine.
`DescribePendingMaintenanceActionsResult`	`describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)` Returns a list of resources (for example, instances) that have at least one pending maintenance action.
`DBCluster`	`failoverDBCluster(FailoverDBClusterRequest request)` Forces a failover for a cluster.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Lists all tags on an Amazon DocumentDB resource.
`DBCluster`	`modifyDBCluster(ModifyDBClusterRequest request)` Modifies a setting for an Amazon DocumentDB cluster.
`ModifyDBClusterParameterGroupResult`	`modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest request)` Modifies the parameters of a cluster parameter group.
`DBClusterSnapshotAttributesResult`	`modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest request)` Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
`DBInstance`	`modifyDBInstance(ModifyDBInstanceRequest request)` Modifies settings for an instance.
`DBSubnetGroup`	`modifyDBSubnetGroup(ModifyDBSubnetGroupRequest request)` Modifies an existing subnet group.
`DBInstance`	`rebootDBInstance(RebootDBInstanceRequest request)` You might need to reboot your instance, usually for maintenance reasons.
`RemoveTagsFromResourceResult`	`removeTagsFromResource(RemoveTagsFromResourceRequest request)` Removes metadata tags from an Amazon DocumentDB resource.
`ResetDBClusterParameterGroupResult`	`resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest request)` Modifies the parameters of a cluster parameter group to the default value.
`DBCluster`	`restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)` Creates a new cluster from a snapshot or cluster snapshot.
`DBCluster`	`restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request)` Restores a cluster to an arbitrary point in time.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`DBCluster`	`startDBCluster(StartDBClusterRequest request)` Restarts the stopped cluster that is specified by `DBClusterIdentifier`.
`DBCluster`	`stopDBCluster(StopDBClusterRequest request)` Stops the running cluster that is specified by `DBClusterIdentifier`.
`AmazonDocDBWaiters`	`waiters()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addTagsToResource
```
public AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    addTagsToResource in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to AddTagsToResource.
    
    Returns:
    
    Result of the AddTagsToResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - applyPendingMaintenanceAction
```
public ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
    
    Specified by:
    
    applyPendingMaintenanceAction in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to ApplyPendingMaintenanceAction.
    
    Returns:
    
    Result of the ApplyPendingMaintenanceAction operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - copyDBClusterParameterGroup
```
public DBClusterParameterGroup copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Copies the specified cluster parameter group.
    
    Specified by:
    
    copyDBClusterParameterGroup in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to CopyDBClusterParameterGroup.
    
    Returns:
    
    Result of the CopyDBClusterParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - copyDBClusterSnapshot
```
public DBClusterSnapshot copyDBClusterSnapshot(CopyDBClusterSnapshotRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    copyDBClusterSnapshot in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to CopyDBClusterSnapshot.
    
    Returns:
    
    Result of the CopyDBClusterSnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDBCluster
```
public DBCluster createDBCluster(CreateDBClusterRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Creates a new Amazon DocumentDB cluster.
    
    Specified by:
    
    createDBCluster in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to CreateDBCluster.
    
    Returns:
    
    Result of the CreateDBCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDBClusterParameterGroup
```
public DBClusterParameterGroup createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    createDBClusterParameterGroup in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input of CreateDBClusterParameterGroup.
    
    Returns:
    
    Result of the CreateDBClusterParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDBClusterSnapshot
```
public DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Creates a snapshot of a cluster.
    
    Specified by:
    
    createDBClusterSnapshot in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input of CreateDBClusterSnapshot.
    
    Returns:
    
    Result of the CreateDBClusterSnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDBInstance
```
public DBInstance createDBInstance(CreateDBInstanceRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Creates a new instance.
    
    Specified by:
    
    createDBInstance in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to CreateDBInstance.
    
    Returns:
    
    Result of the CreateDBInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDBSubnetGroup
```
public DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.
    
    Specified by:
    
    createDBSubnetGroup in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to CreateDBSubnetGroup.
    
    Returns:
    
    Result of the CreateDBSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDBCluster
```
public DBCluster deleteDBCluster(DeleteDBClusterRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    deleteDBCluster in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DeleteDBCluster.
    
    Returns:
    
    Result of the DeleteDBCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDBClusterParameterGroup
```
public DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
    
    Specified by:
    
    deleteDBClusterParameterGroup in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DeleteDBClusterParameterGroup.
    
    Returns:
    
    Result of the DeleteDBClusterParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDBClusterSnapshot
```
public DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    deleteDBClusterSnapshot in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DeleteDBClusterSnapshot.
    
    Returns:
    
    Result of the DeleteDBClusterSnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDBInstance
```
public DBInstance deleteDBInstance(DeleteDBInstanceRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Deletes a previously provisioned instance.
    
    Specified by:
    
    deleteDBInstance in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DeleteDBInstance.
    
    Returns:
    
    Result of the DeleteDBInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDBSubnetGroup
```
public DeleteDBSubnetGroupResult deleteDBSubnetGroup(DeleteDBSubnetGroupRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Deletes a subnet group.
    
    The specified database subnet group must not be associated with any DB instances.
    
    Specified by:
    
    deleteDBSubnetGroup in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DeleteDBSubnetGroup.
    
    Returns:
    
    Result of the DeleteDBSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeCertificates
```
public DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account.
    
    Specified by:
    
    describeCertificates in interface AmazonDocDB
    
    Returns:
    
    Result of the DescribeCertificates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDBClusterParameterGroups
```
public DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.
    
    Specified by:
    
    describeDBClusterParameterGroups in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DescribeDBClusterParameterGroups.
    
    Returns:
    
    Result of the DescribeDBClusterParameterGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDBClusterParameters
```
public DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Returns the detailed parameter list for a particular cluster parameter group.
    
    Specified by:
    
    describeDBClusterParameters in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DescribeDBClusterParameters.
    
    Returns:
    
    Result of the DescribeDBClusterParameters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDBClusterSnapshotAttributes
```
public DBClusterSnapshotAttributesResult describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    describeDBClusterSnapshotAttributes in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DescribeDBClusterSnapshotAttributes.
    
    Returns:
    
    Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDBClusterSnapshots
```
public DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Returns information about cluster snapshots. This API operation supports pagination.
    
    Specified by:
    
    describeDBClusterSnapshots in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DescribeDBClusterSnapshots.
    
    Returns:
    
    Result of the DescribeDBClusterSnapshots operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDBClusters
```
public DescribeDBClustersResult describeDBClusters(DescribeDBClustersRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    describeDBClusters in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DescribeDBClusters.
    
    Returns:
    
    Result of the DescribeDBClusters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDBEngineVersions
```
public DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Returns a list of the available engines.
    
    Specified by:
    
    describeDBEngineVersions in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DescribeDBEngineVersions.
    
    Returns:
    
    Result of the DescribeDBEngineVersions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDBInstances
```
public DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
    
    Specified by:
    
    describeDBInstances in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DescribeDBInstances.
    
    Returns:
    
    Result of the DescribeDBInstances operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDBSubnetGroups
```
public DescribeDBSubnetGroupsResult describeDBSubnetGroups(DescribeDBSubnetGroupsRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.
    
    Specified by:
    
    describeDBSubnetGroups in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DescribeDBSubnetGroups.
    
    Returns:
    
    Result of the DescribeDBSubnetGroups operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEngineDefaultClusterParameters
```
public EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Returns the default engine and system parameter information for the cluster database engine.
    
    Specified by:
    
    describeEngineDefaultClusterParameters in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DescribeEngineDefaultClusterParameters.
    
    Returns:
    
    Result of the DescribeEngineDefaultClusterParameters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEventCategories
```
public DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Displays a list of categories for all event source types, or, if specified, for a specified source type.
    
    Specified by:
    
    describeEventCategories in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DescribeEventCategories.
    
    Returns:
    
    Result of the DescribeEventCategories operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeEvents
```
public DescribeEventsResult describeEvents(DescribeEventsRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    describeEvents in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DescribeEvents.
    
    Returns:
    
    Result of the DescribeEvents operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeOrderableDBInstanceOptions
```
public DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Returns a list of orderable instance options for the specified engine.
    
    Specified by:
    
    describeOrderableDBInstanceOptions in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DescribeOrderableDBInstanceOptions.
    
    Returns:
    
    Result of the DescribeOrderableDBInstanceOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describePendingMaintenanceActions
```
public DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Returns a list of resources (for example, instances) that have at least one pending maintenance action.
    
    Specified by:
    
    describePendingMaintenanceActions in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to DescribePendingMaintenanceActions.
    
    Returns:
    
    Result of the DescribePendingMaintenanceActions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - failoverDBCluster
```
public DBCluster failoverDBCluster(FailoverDBClusterRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    failoverDBCluster in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to FailoverDBCluster.
    
    Returns:
    
    Result of the FailoverDBCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Lists all tags on an Amazon DocumentDB resource.
    
    Specified by:
    
    listTagsForResource in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to ListTagsForResource.
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyDBCluster
```
public DBCluster modifyDBCluster(ModifyDBClusterRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    modifyDBCluster in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to ModifyDBCluster.
    
    Returns:
    
    Result of the ModifyDBCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyDBClusterParameterGroup
```
public ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    modifyDBClusterParameterGroup in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to ModifyDBClusterParameterGroup.
    
    Returns:
    
    Result of the ModifyDBClusterParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyDBClusterSnapshotAttribute
```
public DBClusterSnapshotAttributesResult modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    modifyDBClusterSnapshotAttribute in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to ModifyDBClusterSnapshotAttribute.
    
    Returns:
    
    Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyDBInstance
```
public DBInstance modifyDBInstance(ModifyDBInstanceRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    modifyDBInstance in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to ModifyDBInstance.
    
    Returns:
    
    Result of the ModifyDBInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - modifyDBSubnetGroup
```
public DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.
    
    Specified by:
    
    modifyDBSubnetGroup in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to ModifyDBSubnetGroup.
    
    Returns:
    
    Result of the ModifyDBSubnetGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - rebootDBInstance
```
public DBInstance rebootDBInstance(RebootDBInstanceRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    rebootDBInstance in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to RebootDBInstance.
    
    Returns:
    
    Result of the RebootDBInstance operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - removeTagsFromResource
```
public RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Removes metadata tags from an Amazon DocumentDB resource.
    
    Specified by:
    
    removeTagsFromResource in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to RemoveTagsFromResource.
    
    Returns:
    
    Result of the RemoveTagsFromResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - resetDBClusterParameterGroup
```
public ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    resetDBClusterParameterGroup in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to ResetDBClusterParameterGroup.
    
    Returns:
    
    Result of the ResetDBClusterParameterGroup operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - restoreDBClusterFromSnapshot
```
public DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    restoreDBClusterFromSnapshot in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to RestoreDBClusterFromSnapshot.
    
    Returns:
    
    Result of the RestoreDBClusterFromSnapshot operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - restoreDBClusterToPointInTime
```
public DBCluster restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    restoreDBClusterToPointInTime in interface AmazonDocDB
    
    Parameters:
    
    request - Represents the input to RestoreDBClusterToPointInTime.
    
    Returns:
    
    Result of the RestoreDBClusterToPointInTime operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - startDBCluster
```
public DBCluster startDBCluster(StartDBClusterRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.
    
    Specified by:
    
    startDBCluster in interface AmazonDocDB
    
    Returns:
    
    Result of the StartDBCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - stopDBCluster
```
public DBCluster stopDBCluster(StopDBClusterRequest request)
```
    Description copied from interface: AmazonDocDB
    
    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.
    
    Specified by:
    
    stopDBCluster in interface AmazonDocDB
    
    Returns:
    
    Result of the StopDBCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AmazonDocDB
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AmazonDocDB
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AmazonDocDB
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
    
    Specified by:
    
    getCachedResponseMetadata in interface AmazonDocDB
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
public AmazonDocDBWaiters waiters()
```
    Specified by:
    
    waiters in interface AmazonDocDB

Did this page help you?

Class AbstractAmazonDocDB

Field Summary

Fields inherited from interface com.amazonaws.services.docdb.AmazonDocDB

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addTagsToResource

applyPendingMaintenanceAction

copyDBClusterParameterGroup

copyDBClusterSnapshot

createDBCluster

createDBClusterParameterGroup

createDBClusterSnapshot

createDBInstance

createDBSubnetGroup

deleteDBCluster

deleteDBClusterParameterGroup

deleteDBClusterSnapshot

deleteDBInstance

deleteDBSubnetGroup

describeCertificates

describeDBClusterParameterGroups

describeDBClusterParameters

describeDBClusterSnapshotAttributes

describeDBClusterSnapshots

describeDBClusters

describeDBEngineVersions

describeDBInstances

describeDBSubnetGroups

describeEngineDefaultClusterParameters

describeEventCategories

describeEvents

describeOrderableDBInstanceOptions

describePendingMaintenanceActions

failoverDBCluster

listTagsForResource

modifyDBCluster

modifyDBClusterParameterGroup

modifyDBClusterSnapshotAttribute

modifyDBInstance

modifyDBSubnetGroup

rebootDBInstance

removeTagsFromResource

resetDBClusterParameterGroup

restoreDBClusterFromSnapshot

restoreDBClusterToPointInTime

startDBCluster

stopDBCluster

shutdown

getCachedResponseMetadata

waiters