com.amazonaws.services.docdb

Interface AmazonDocDB

All Known Subinterfaces:

AmazonDocDBAsync

All Known Implementing Classes:

AbstractAmazonDocDB, AbstractAmazonDocDBAsync, AmazonDocDBAsyncClient, AmazonDocDBClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonDocDB

Interface for accessing Amazon DocDB.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonDocDB instead.

Amazon DocumentDB API documentation

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
AddTagsToResourceResult	addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest) Adds metadata tags to an Amazon DocumentDB resource.
ResourcePendingMaintenanceActions	applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest) Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
DBClusterParameterGroup	copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest) Copies the specified cluster parameter group.
DBClusterSnapshot	copyDBClusterSnapshot(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest) Copies a snapshot of a cluster.
DBCluster	createDBCluster(CreateDBClusterRequest createDBClusterRequest) Creates a new Amazon DocumentDB cluster.
DBClusterParameterGroup	createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest) Creates a new cluster parameter group.
DBClusterSnapshot	createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest) Creates a snapshot of a cluster.
DBInstance	createDBInstance(CreateDBInstanceRequest createDBInstanceRequest) Creates a new instance.
DBSubnetGroup	createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest) Creates a new subnet group.
DBCluster	deleteDBCluster(DeleteDBClusterRequest deleteDBClusterRequest) Deletes a previously provisioned cluster.
DeleteDBClusterParameterGroupResult	deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest) Deletes a specified cluster parameter group.
DBClusterSnapshot	deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest) Deletes a cluster snapshot.
DBInstance	deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest) Deletes a previously provisioned instance.
DeleteDBSubnetGroupResult	deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest) Deletes a subnet group.
DescribeCertificatesResult	describeCertificates(DescribeCertificatesRequest describeCertificatesRequest) Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account.
DescribeDBClusterParameterGroupsResult	describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest) Returns a list of DBClusterParameterGroup descriptions.
DescribeDBClusterParametersResult	describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest) Returns the detailed parameter list for a particular cluster parameter group.
DescribeDBClustersResult	describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest) Returns information about provisioned Amazon DocumentDB clusters.
DBClusterSnapshotAttributesResult	describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest describeDBClusterSnapshotAttributesRequest) Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.
DescribeDBClusterSnapshotsResult	describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest) Returns information about cluster snapshots.
DescribeDBEngineVersionsResult	describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest) Returns a list of the available engines.
DescribeDBInstancesResult	describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest) Returns information about provisioned Amazon DocumentDB instances.
DescribeDBSubnetGroupsResult	describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest) Returns a list of DBSubnetGroup descriptions.
EngineDefaults	describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest) Returns the default engine and system parameter information for the cluster database engine.
DescribeEventCategoriesResult	describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest) Displays a list of categories for all event source types, or, if specified, for a specified source type.
DescribeEventsResult	describeEvents(DescribeEventsRequest describeEventsRequest) Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days.
DescribeOrderableDBInstanceOptionsResult	describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest) Returns a list of orderable instance options for the specified engine.
DescribePendingMaintenanceActionsResult	describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) Returns a list of resources (for example, instances) that have at least one pending maintenance action.
DBCluster	failoverDBCluster(FailoverDBClusterRequest failoverDBClusterRequest) 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 listTagsForResourceRequest) Lists all tags on an Amazon DocumentDB resource.
DBCluster	modifyDBCluster(ModifyDBClusterRequest modifyDBClusterRequest) Modifies a setting for an Amazon DocumentDB cluster.
ModifyDBClusterParameterGroupResult	modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest) Modifies the parameters of a cluster parameter group.
DBClusterSnapshotAttributesResult	modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest modifyDBClusterSnapshotAttributeRequest) Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.
DBInstance	modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest) Modifies settings for an instance.
DBSubnetGroup	modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest) Modifies an existing subnet group.
DBInstance	rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest) You might need to reboot your instance, usually for maintenance reasons.
RemoveTagsFromResourceResult	removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest) Removes metadata tags from an Amazon DocumentDB resource.
ResetDBClusterParameterGroupResult	resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest) Modifies the parameters of a cluster parameter group to the default value.
DBCluster	restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest) Creates a new cluster from a snapshot or cluster snapshot.
DBCluster	restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest) 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 startDBClusterRequest) Restarts the stopped cluster that is specified by DBClusterIdentifier.
DBCluster	stopDBCluster(StopDBClusterRequest stopDBClusterRequest) Stops the running cluster that is specified by DBClusterIdentifier.
AmazonDocDBWaiters	waiters()

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

addTagsToResource

AddTagsToResourceResult addTagsToResource(AddTagsToResourceRequest addTagsToResourceRequest)

Adds metadata tags to an Amazon DocumentDB resource. You can use these tags with cost allocation reporting to track costs that are associated with Amazon DocumentDB resources. or in a Condition statement in an AWS Identity and Access Management (IAM) policy for Amazon DocumentDB.

Parameters:

addTagsToResourceRequest - Represents the input to AddTagsToResource.

Returns:

Result of the AddTagsToResource operation returned by the service.

Throws:

DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.

DBSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing snapshot.

DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.

See Also:

AWS API Documentation

applyPendingMaintenanceAction

ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

Parameters:

applyPendingMaintenanceActionRequest - Represents the input to ApplyPendingMaintenanceAction.

Returns:

Result of the ApplyPendingMaintenanceAction operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource ID was not found.

InvalidDBClusterStateException - The cluster isn't in a valid state.

InvalidDBInstanceStateException - The specified instance isn't in the available state.

See Also:

AWS API Documentation

copyDBClusterParameterGroup

DBClusterParameterGroup copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest)

Copies the specified cluster parameter group.

Parameters:

copyDBClusterParameterGroupRequest - Represents the input to CopyDBClusterParameterGroup.

Returns:

Result of the CopyDBClusterParameterGroup operation returned by the service.

Throws:

DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.

DBParameterGroupQuotaExceededException - This request would cause you to exceed the allowed number of parameter groups.

DBParameterGroupAlreadyExistsException - A parameter group with the same name already exists.

See Also:

AWS API Documentation

copyDBClusterSnapshot

DBClusterSnapshot copyDBClusterSnapshot(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest)

Copies a snapshot of a cluster.

To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same AWS Region.

To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.

Parameters:

copyDBClusterSnapshotRequest - Represents the input to CopyDBClusterSnapshot.

Returns:

Result of the CopyDBClusterSnapshot operation returned by the service.

Throws:

DBClusterSnapshotAlreadyExistsException - You already have a cluster snapshot with the given identifier.

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

InvalidDBClusterStateException - The cluster isn't in a valid state.

InvalidDBClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.

SnapshotQuotaExceededException - The request would cause you to exceed the allowed number of snapshots.

KMSKeyNotAccessibleException - An error occurred when accessing an AWS KMS key.

See Also:

AWS API Documentation

createDBCluster

DBCluster createDBCluster(CreateDBClusterRequest createDBClusterRequest)

Creates a new Amazon DocumentDB cluster.

Parameters:

createDBClusterRequest - Represents the input to CreateDBCluster.

Returns:

Result of the CreateDBCluster operation returned by the service.

Throws:

DBClusterAlreadyExistsException - You already have a cluster with the given identifier.

InsufficientStorageClusterCapacityException - There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

DBClusterQuotaExceededException - The cluster can't be created because you have reached the maximum allowed quota of clusters.

StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.

DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.

InvalidVPCNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

InvalidDBClusterStateException - The cluster isn't in a valid state.

InvalidDBSubnetGroupStateException - The subnet group can't be deleted because it's in use.

InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

InvalidDBInstanceStateException - The specified instance isn't in the available state.

DBClusterParameterGroupNotFoundException - DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.

KMSKeyNotAccessibleException - An error occurred when accessing an AWS KMS key.

DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.

DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.

DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

See Also:

AWS API Documentation

createDBClusterParameterGroup

DBClusterParameterGroup createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest)

Creates a new cluster parameter group.

Parameters in a cluster parameter group apply to all of the instances in a cluster.

A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.

Parameters:

createDBClusterParameterGroupRequest - Represents the input of CreateDBClusterParameterGroup.

Returns:

Result of the CreateDBClusterParameterGroup operation returned by the service.

Throws:

DBParameterGroupQuotaExceededException - This request would cause you to exceed the allowed number of parameter groups.

DBParameterGroupAlreadyExistsException - A parameter group with the same name already exists.

See Also:

AWS API Documentation

createDBClusterSnapshot

DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest)

Creates a snapshot of a cluster.

Parameters:

createDBClusterSnapshotRequest - Represents the input of CreateDBClusterSnapshot.

Returns:

Result of the CreateDBClusterSnapshot operation returned by the service.

Throws:

DBClusterSnapshotAlreadyExistsException - You already have a cluster snapshot with the given identifier.

InvalidDBClusterStateException - The cluster isn't in a valid state.

DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.

SnapshotQuotaExceededException - The request would cause you to exceed the allowed number of snapshots.

InvalidDBClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.

See Also:

AWS API Documentation

createDBInstance

DBInstance createDBInstance(CreateDBInstanceRequest createDBInstanceRequest)

Creates a new instance.

Parameters:

createDBInstanceRequest - Represents the input to CreateDBInstance.

Returns:

Result of the CreateDBInstance operation returned by the service.

Throws:

DBInstanceAlreadyExistsException - You already have a instance with the given identifier.

InsufficientDBInstanceCapacityException - The specified instance class isn't available in the specified Availability Zone.

DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.

DBSecurityGroupNotFoundException - DBSecurityGroupName doesn't refer to an existing security group.

InstanceQuotaExceededException - The request would cause you to exceed the allowed number of instances.

StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.

DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.

DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

InvalidDBClusterStateException - The cluster isn't in a valid state.

InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

InvalidVPCNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.

StorageTypeNotSupportedException - Storage of the specified StorageType can't be associated with the DB instance.

AuthorizationNotFoundException - The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.

Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.

KMSKeyNotAccessibleException - An error occurred when accessing an AWS KMS key.

See Also:

AWS API Documentation

createDBSubnetGroup

DBSubnetGroup createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest)

Creates a new subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.

Parameters:

createDBSubnetGroupRequest - Represents the input to CreateDBSubnetGroup.

Returns:

Result of the CreateDBSubnetGroup operation returned by the service.

Throws:

DBSubnetGroupAlreadyExistsException - DBSubnetGroupName is already being used by an existing subnet group.

DBSubnetGroupQuotaExceededException - The request would cause you to exceed the allowed number of subnet groups.

DBSubnetQuotaExceededException - The request would cause you to exceed the allowed number of subnets in a subnet group.

DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

See Also:

AWS API Documentation

deleteDBCluster

DBCluster deleteDBCluster(DeleteDBClusterRequest deleteDBClusterRequest)

Deletes a previously provisioned cluster. When you delete a cluster, all automated backups for that cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified cluster are not deleted.

Parameters:

deleteDBClusterRequest - Represents the input to DeleteDBCluster.

Returns:

Result of the DeleteDBCluster operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.

InvalidDBClusterStateException - The cluster isn't in a valid state.

DBClusterSnapshotAlreadyExistsException - You already have a cluster snapshot with the given identifier.

SnapshotQuotaExceededException - The request would cause you to exceed the allowed number of snapshots.

InvalidDBClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.

See Also:

AWS API Documentation

deleteDBClusterParameterGroup

DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest)

Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.

Parameters:

deleteDBClusterParameterGroupRequest - Represents the input to DeleteDBClusterParameterGroup.

Returns:

Result of the DeleteDBClusterParameterGroup operation returned by the service.

Throws:

InvalidDBParameterGroupStateException - The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.

See Also:

AWS API Documentation

deleteDBClusterSnapshot

DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest)

Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.

The cluster snapshot must be in the available state to be deleted.

Parameters:

deleteDBClusterSnapshotRequest - Represents the input to DeleteDBClusterSnapshot.

Returns:

Result of the DeleteDBClusterSnapshot operation returned by the service.

Throws:

InvalidDBClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

See Also:

AWS API Documentation

deleteDBInstance

DBInstance deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest)

Deletes a previously provisioned instance.

Parameters:

deleteDBInstanceRequest - Represents the input to DeleteDBInstance.

Returns:

Result of the DeleteDBInstance operation returned by the service.

Throws:

DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.

InvalidDBInstanceStateException - The specified instance isn't in the available state.

DBSnapshotAlreadyExistsException - DBSnapshotIdentifier is already being used by an existing snapshot.

SnapshotQuotaExceededException - The request would cause you to exceed the allowed number of snapshots.

InvalidDBClusterStateException - The cluster isn't in a valid state.

See Also:

AWS API Documentation

deleteDBSubnetGroup

DeleteDBSubnetGroupResult deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)

Deletes a subnet group.

The specified database subnet group must not be associated with any DB instances.

Parameters:

deleteDBSubnetGroupRequest - Represents the input to DeleteDBSubnetGroup.

Returns:

Result of the DeleteDBSubnetGroup operation returned by the service.

Throws:

InvalidDBSubnetGroupStateException - The subnet group can't be deleted because it's in use.

InvalidDBSubnetStateException - The subnet isn't in the available state.

DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.

See Also:

AWS API Documentation

describeCertificates

DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this AWS account.

Parameters:

describeCertificatesRequest -

Returns:

Result of the DescribeCertificates operation returned by the service.

Throws:

CertificateNotFoundException - CertificateIdentifier doesn't refer to an existing certificate.

See Also:

AWS API Documentation

describeDBClusterParameterGroups

DescribeDBClusterParameterGroupsResult describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest)

Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list contains only the description of the specified cluster parameter group.

Parameters:

describeDBClusterParameterGroupsRequest - Represents the input to DescribeDBClusterParameterGroups.

Returns:

Result of the DescribeDBClusterParameterGroups operation returned by the service.

Throws:

DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.

See Also:

AWS API Documentation

describeDBClusterParameters

DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest)

Returns the detailed parameter list for a particular cluster parameter group.

Parameters:

describeDBClusterParametersRequest - Represents the input to DescribeDBClusterParameters.

Returns:

Result of the DescribeDBClusterParameters operation returned by the service.

Throws:

DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.

See Also:

AWS API Documentation

describeDBClusterSnapshotAttributes

DBClusterSnapshotAttributesResult describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest describeDBClusterSnapshotAttributesRequest)

Returns a list of cluster snapshot attribute names and values for a manual DB cluster snapshot.

When you share snapshots with other AWS accounts, DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for the AWS accounts that are authorized to copy or restore the manual cluster snapshot. If all is included in the list of values for the restore attribute, then the manual cluster snapshot is public and can be copied or restored by all AWS accounts.

Parameters:

describeDBClusterSnapshotAttributesRequest - Represents the input to DescribeDBClusterSnapshotAttributes.

Returns:

Result of the DescribeDBClusterSnapshotAttributes operation returned by the service.

Throws:

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

See Also:

AWS API Documentation

describeDBClusterSnapshots

DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest)

Returns information about cluster snapshots. This API operation supports pagination.

Parameters:

describeDBClusterSnapshotsRequest - Represents the input to DescribeDBClusterSnapshots.

Returns:

Result of the DescribeDBClusterSnapshots operation returned by the service.

Throws:

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

See Also:

AWS API Documentation

describeDBClusters

DescribeDBClustersResult describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest)

Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.

Parameters:

describeDBClustersRequest - Represents the input to DescribeDBClusters.

Returns:

Result of the DescribeDBClusters operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.

See Also:

AWS API Documentation

describeDBEngineVersions

DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)

Returns a list of the available engines.

Parameters:

describeDBEngineVersionsRequest - Represents the input to DescribeDBEngineVersions.

Returns:

Result of the DescribeDBEngineVersions operation returned by the service.

See Also:

AWS API Documentation

describeDBInstances

DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest)

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.

Parameters:

describeDBInstancesRequest - Represents the input to DescribeDBInstances.

Returns:

Result of the DescribeDBInstances operation returned by the service.

Throws:

DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.

See Also:

AWS API Documentation

describeDBSubnetGroups

DescribeDBSubnetGroupsResult describeDBSubnetGroups(DescribeDBSubnetGroupsRequest describeDBSubnetGroupsRequest)

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

Parameters:

describeDBSubnetGroupsRequest - Represents the input to DescribeDBSubnetGroups.

Returns:

Result of the DescribeDBSubnetGroups operation returned by the service.

Throws:

DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.

See Also:

AWS API Documentation

describeEngineDefaultClusterParameters

EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)

Returns the default engine and system parameter information for the cluster database engine.

Parameters:

describeEngineDefaultClusterParametersRequest - Represents the input to DescribeEngineDefaultClusterParameters.

Returns:

Result of the DescribeEngineDefaultClusterParameters operation returned by the service.

See Also:

AWS API Documentation

describeEventCategories

DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)

Displays a list of categories for all event source types, or, if specified, for a specified source type.

Parameters:

describeEventCategoriesRequest - Represents the input to DescribeEventCategories.

Returns:

Result of the DescribeEventCategories operation returned by the service.

See Also:

AWS API Documentation

describeEvents

DescribeEventsResult describeEvents(DescribeEventsRequest describeEventsRequest)

Returns events related to instances, security groups, snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, security group, snapshot, or parameter group by providing the name as a parameter. By default, the events of the past hour are returned.

Parameters:

describeEventsRequest - Represents the input to DescribeEvents.

Returns:

Result of the DescribeEvents operation returned by the service.

See Also:

AWS API Documentation

describeOrderableDBInstanceOptions

DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest)

Returns a list of orderable instance options for the specified engine.

Parameters:

describeOrderableDBInstanceOptionsRequest - Represents the input to DescribeOrderableDBInstanceOptions.

Returns:

Result of the DescribeOrderableDBInstanceOptions operation returned by the service.

See Also:

AWS API Documentation

describePendingMaintenanceActions

DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)

Returns a list of resources (for example, instances) that have at least one pending maintenance action.

Parameters:

describePendingMaintenanceActionsRequest - Represents the input to DescribePendingMaintenanceActions.

Returns:

Result of the DescribePendingMaintenanceActions operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource ID was not found.

See Also:

AWS API Documentation

failoverDBCluster

DBCluster failoverDBCluster(FailoverDBClusterRequest failoverDBClusterRequest)

Forces a failover for a cluster.

A failover for a cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the cluster to be the primary instance (the cluster writer).

If the primary instance fails, Amazon DocumentDB automatically fails over to an Amazon DocumentDB replica, if one exists. You can force a failover when you want to simulate a failure of a primary instance for testing.

Parameters:

failoverDBClusterRequest - Represents the input to FailoverDBCluster.

Returns:

Result of the FailoverDBCluster operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.

InvalidDBClusterStateException - The cluster isn't in a valid state.

InvalidDBInstanceStateException - The specified instance isn't in the available state.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists all tags on an Amazon DocumentDB resource.

Parameters:

listTagsForResourceRequest - Represents the input to ListTagsForResource.

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.

DBSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing snapshot.

DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.

See Also:

AWS API Documentation

modifyDBCluster

DBCluster modifyDBCluster(ModifyDBClusterRequest modifyDBClusterRequest)

Modifies a setting for an Amazon DocumentDB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Parameters:

modifyDBClusterRequest - Represents the input to ModifyDBCluster.

Returns:

Result of the ModifyDBCluster operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.

InvalidDBClusterStateException - The cluster isn't in a valid state.

StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.

DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.

InvalidVPCNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

InvalidDBSubnetGroupStateException - The subnet group can't be deleted because it's in use.

InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

DBClusterParameterGroupNotFoundException - DBClusterParameterGroupName doesn't refer to an existing cluster parameter group.

InvalidDBSecurityGroupStateException - The state of the security group doesn't allow deletion.

InvalidDBInstanceStateException - The specified instance isn't in the available state.

DBClusterAlreadyExistsException - You already have a cluster with the given identifier.

See Also:

AWS API Documentation

modifyDBClusterParameterGroup

ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest)

Modifies the parameters of a cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request.

Changes to dynamic parameters are applied immediately. Changes to static parameters require a reboot or maintenance window before the change can take effect.

After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.

Parameters:

modifyDBClusterParameterGroupRequest - Represents the input to ModifyDBClusterParameterGroup.

Returns:

Result of the ModifyDBClusterParameterGroup operation returned by the service.

Throws:

DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.

InvalidDBParameterGroupStateException - The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

See Also:

AWS API Documentation

modifyDBClusterSnapshotAttribute

DBClusterSnapshotAttributesResult modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest modifyDBClusterSnapshotAttributeRequest)

Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot.

To share a manual cluster snapshot with other AWS accounts, specify restore as the AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the AWS accounts that are authorized to restore the manual cluster snapshot. Use the value all to make the manual cluster snapshot public, which means that it can be copied or restored by all AWS accounts. Do not add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all AWS accounts. If a manual cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized AWS account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case.

Parameters:

modifyDBClusterSnapshotAttributeRequest - Represents the input to ModifyDBClusterSnapshotAttribute.

Returns:

Result of the ModifyDBClusterSnapshotAttribute operation returned by the service.

Throws:

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

InvalidDBClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.

SharedSnapshotQuotaExceededException - You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.

See Also:

AWS API Documentation

modifyDBInstance

DBInstance modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest)

Modifies settings for an instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request.

Parameters:

modifyDBInstanceRequest - Represents the input to ModifyDBInstance.

Returns:

Result of the ModifyDBInstance operation returned by the service.

Throws:

InvalidDBInstanceStateException - The specified instance isn't in the available state.

InvalidDBSecurityGroupStateException - The state of the security group doesn't allow deletion.

DBInstanceAlreadyExistsException - You already have a instance with the given identifier.

DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.

DBSecurityGroupNotFoundException - DBSecurityGroupName doesn't refer to an existing security group.

DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.

InsufficientDBInstanceCapacityException - The specified instance class isn't available in the specified Availability Zone.

StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.

InvalidVPCNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

DBUpgradeDependencyFailureException - The upgrade failed because a resource that the depends on can't be modified.

StorageTypeNotSupportedException - Storage of the specified StorageType can't be associated with the DB instance.

AuthorizationNotFoundException - The specified CIDR IP or Amazon EC2 security group isn't authorized for the specified security group.

Amazon DocumentDB also might not be authorized to perform necessary actions on your behalf using IAM.

CertificateNotFoundException - CertificateIdentifier doesn't refer to an existing certificate.

See Also:

AWS API Documentation

modifyDBSubnetGroup

DBSubnetGroup modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest)

Modifies an existing subnet group. subnet groups must contain at least one subnet in at least two Availability Zones in the AWS Region.

Parameters:

modifyDBSubnetGroupRequest - Represents the input to ModifyDBSubnetGroup.

Returns:

Result of the ModifyDBSubnetGroup operation returned by the service.

Throws:

DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.

DBSubnetQuotaExceededException - The request would cause you to exceed the allowed number of subnets in a subnet group.

SubnetAlreadyInUseException - The subnet is already in use in the Availability Zone.

DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the subnet group should cover at least two Availability Zones unless there is only one Availability Zone.

InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

See Also:

AWS API Documentation

rebootDBInstance

DBInstance rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest)

You might need to reboot your instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the cluster parameter group that is associated with the instance, you must reboot the instance for the changes to take effect.

Rebooting an instance restarts the database engine service. Rebooting an instance results in a momentary outage, during which the instance status is set to rebooting.

Parameters:

rebootDBInstanceRequest - Represents the input to RebootDBInstance.

Returns:

Result of the RebootDBInstance operation returned by the service.

Throws:

InvalidDBInstanceStateException - The specified instance isn't in the available state.

DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.

See Also:

AWS API Documentation

removeTagsFromResource

RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)

Removes metadata tags from an Amazon DocumentDB resource.

Parameters:

removeTagsFromResourceRequest - Represents the input to RemoveTagsFromResource.

Returns:

Result of the RemoveTagsFromResource operation returned by the service.

Throws:

DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.

DBSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing snapshot.

DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.

See Also:

AWS API Documentation

resetDBClusterParameterGroup

ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest)

Modifies the parameters of a cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire cluster parameter group, specify the DBClusterParameterGroupName and ResetAllParameters parameters.

When you reset the entire group, dynamic parameters are updated immediately and static parameters are set to pending-reboot to take effect on the next DB instance reboot.

Parameters:

resetDBClusterParameterGroupRequest - Represents the input to ResetDBClusterParameterGroup.

Returns:

Result of the ResetDBClusterParameterGroup operation returned by the service.

Throws:

InvalidDBParameterGroupStateException - The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.

DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.

See Also:

AWS API Documentation

restoreDBClusterFromSnapshot

DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest)

Creates a new cluster from a snapshot or cluster snapshot.

If a snapshot is specified, the target cluster is created from the source DB snapshot with a default configuration and default security group.

If a cluster snapshot is specified, the target cluster is created from the source cluster restore point with the same configuration as the original source DB cluster, except that the new cluster is created with the default security group.

Parameters:

restoreDBClusterFromSnapshotRequest - Represents the input to RestoreDBClusterFromSnapshot.

Returns:

Result of the RestoreDBClusterFromSnapshot operation returned by the service.

Throws:

DBClusterAlreadyExistsException - You already have a cluster with the given identifier.

DBClusterQuotaExceededException - The cluster can't be created because you have reached the maximum allowed quota of clusters.

StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.

DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.

DBSnapshotNotFoundException - DBSnapshotIdentifier doesn't refer to an existing snapshot.

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

InsufficientDBClusterCapacityException - The cluster doesn't have enough capacity for the current operation.

InsufficientStorageClusterCapacityException - There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

InvalidDBSnapshotStateException - The state of the snapshot doesn't allow deletion.

InvalidDBClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.

StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.

InvalidVPCNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

InvalidRestoreException - You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.

DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.

InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

KMSKeyNotAccessibleException - An error occurred when accessing an AWS KMS key.

See Also:

AWS API Documentation

restoreDBClusterToPointInTime

DBCluster restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest)

Restores a cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target cluster is created from the source cluster with the same configuration as the original cluster, except that the new cluster is created with the default security group.

Parameters:

restoreDBClusterToPointInTimeRequest - Represents the input to RestoreDBClusterToPointInTime.

Returns:

Result of the RestoreDBClusterToPointInTime operation returned by the service.

Throws:

DBClusterAlreadyExistsException - You already have a cluster with the given identifier.

DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.

DBClusterQuotaExceededException - The cluster can't be created because you have reached the maximum allowed quota of clusters.

DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.

DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.

InsufficientDBClusterCapacityException - The cluster doesn't have enough capacity for the current operation.

InsufficientStorageClusterCapacityException - There is not enough storage available for the current action. You might be able to resolve this error by updating your subnet group to use different Availability Zones that have more storage available.

InvalidDBClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.

InvalidDBClusterStateException - The cluster isn't in a valid state.

InvalidDBSnapshotStateException - The state of the snapshot doesn't allow deletion.

InvalidRestoreException - You cannot restore from a virtual private cloud (VPC) backup to a non-VPC DB instance.

InvalidSubnetException - The requested subnet is not valid, or multiple subnets were requested that are not all in a common virtual private cloud (VPC).

InvalidVPCNetworkStateException - The subnet group doesn't cover all Availability Zones after it is created because of changes that were made.

KMSKeyNotAccessibleException - An error occurred when accessing an AWS KMS key.

StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.

See Also:

AWS API Documentation

startDBCluster

DBCluster startDBCluster(StartDBClusterRequest startDBClusterRequest)

Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

Parameters:

startDBClusterRequest -

Returns:

Result of the StartDBCluster operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.

InvalidDBClusterStateException - The cluster isn't in a valid state.

InvalidDBInstanceStateException - The specified instance isn't in the available state.

See Also:

AWS API Documentation

stopDBCluster

DBCluster stopDBCluster(StopDBClusterRequest stopDBClusterRequest)

Stops the running cluster that is specified by DBClusterIdentifier. The cluster must be in the available state. For more information, see Stopping and Starting an Amazon DocumentDB Cluster.

Parameters:

stopDBClusterRequest -

Returns:

Result of the StopDBCluster operation returned by the service.

Throws:

DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.

InvalidDBClusterStateException - The cluster isn't in a valid state.

InvalidDBInstanceStateException - The specified instance isn't in the available state.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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. 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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.

waiters

AmazonDocDBWaiters waiters()