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 a DB instance).
DBClusterParameterGroup	copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest) Copies the specified DB cluster parameter group.
DBClusterSnapshot	copyDBClusterSnapshot(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest) Copies a snapshot of a DB cluster.
DBCluster	createDBCluster(CreateDBClusterRequest createDBClusterRequest) Creates a new Amazon DocumentDB DB cluster.
DBClusterParameterGroup	createDBClusterParameterGroup(CreateDBClusterParameterGroupRequest createDBClusterParameterGroupRequest) Creates a new DB cluster parameter group.
DBClusterSnapshot	createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest) Creates a snapshot of a DB cluster.
DBInstance	createDBInstance(CreateDBInstanceRequest createDBInstanceRequest) Creates a new DB instance.
DBSubnetGroup	createDBSubnetGroup(CreateDBSubnetGroupRequest createDBSubnetGroupRequest) Creates a new DB subnet group.
DBCluster	deleteDBCluster(DeleteDBClusterRequest deleteDBClusterRequest) Deletes a previously provisioned DB cluster.
DeleteDBClusterParameterGroupResult	deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest) Deletes a specified DB cluster parameter group.
DBClusterSnapshot	deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest) Deletes a DB cluster snapshot.
DBInstance	deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest) Deletes a previously provisioned DB instance.
DeleteDBSubnetGroupResult	deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest) Deletes a DB subnet group.
DescribeDBClusterParameterGroupsResult	describeDBClusterParameterGroups(DescribeDBClusterParameterGroupsRequest describeDBClusterParameterGroupsRequest) Returns a list of DBClusterParameterGroup descriptions.
DescribeDBClusterParametersResult	describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest) Returns the detailed parameter list for a particular DB cluster parameter group.
DescribeDBClustersResult	describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest) Returns information about provisioned Amazon DocumentDB DB clusters.
DBClusterSnapshotAttributesResult	describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest describeDBClusterSnapshotAttributesRequest) Returns a list of DB cluster snapshot attribute names and values for a manual DB cluster snapshot.
DescribeDBClusterSnapshotsResult	describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest) Returns information about DB cluster snapshots.
DescribeDBEngineVersionsResult	describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest) Returns a list of the available DB 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 DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days.
DescribeOrderableDBInstanceOptionsResult	describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest) Returns a list of orderable DB instance options for the specified engine.
DescribePendingMaintenanceActionsResult	describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest) Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.
DBCluster	failoverDBCluster(FailoverDBClusterRequest failoverDBClusterRequest) Forces a failover for a DB 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 DB cluster.
ModifyDBClusterParameterGroupResult	modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest) Modifies the parameters of a DB 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 a DB instance.
DBSubnetGroup	modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest) Modifies an existing DB subnet group.
DBInstance	rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest) You might need to reboot your DB 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 DB cluster parameter group to the default value.
DBCluster	restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest) Creates a new DB cluster from a DB snapshot or DB cluster snapshot.
DBCluster	restoreDBClusterToPointInTime(RestoreDBClusterToPointInTimeRequest restoreDBClusterToPointInTimeRequest) Restores a DB cluster to an arbitrary point in time.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
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 DB instance.

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

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

See Also:

AWS API Documentation

applyPendingMaintenanceAction

ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)

Applies a pending maintenance action to a resource (for example, to a DB 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.

See Also:

AWS API Documentation

copyDBClusterParameterGroup

DBClusterParameterGroup copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest)

Copies the specified DB 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 DB parameter group.

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

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

See Also:

AWS API Documentation

copyDBClusterSnapshot

DBClusterSnapshot copyDBClusterSnapshot(CopyDBClusterSnapshotRequest copyDBClusterSnapshotRequest)

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

To cancel the copy operation after it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB 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 DB cluster snapshot with the given identifier.

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

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

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

SnapshotQuotaExceededException - The request would cause you to exceed the allowed number of DB 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 DB cluster.

Parameters:

createDBClusterRequest - Represents the input to CreateDBCluster.

Returns:

Result of the CreateDBCluster operation returned by the service.

Throws:

DBClusterAlreadyExistsException - You already have a DB 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 DB cluster can't be created because you have reached the maximum allowed quota of DB clusters.

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

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

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

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

InvalidDBSubnetGroupStateException - The DB 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 DB instance isn't in the available state.

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

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

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

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

DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the DB 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 DB cluster parameter group.

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

A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your DB cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the DB instances in the DB cluster without failover.

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

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 DB parameter groups.

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

See Also:

AWS API Documentation

createDBClusterSnapshot

DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest)

Creates a snapshot of a DB cluster.

Parameters:

createDBClusterSnapshotRequest - Represents the input of CreateDBClusterSnapshot.

Returns:

Result of the CreateDBClusterSnapshot operation returned by the service.

Throws:

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

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

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

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

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

See Also:

AWS API Documentation

createDBInstance

DBInstance createDBInstance(CreateDBInstanceRequest createDBInstanceRequest)

Creates a new DB instance.

Parameters:

createDBInstanceRequest - Represents the input to CreateDBInstance.

Returns:

Result of the CreateDBInstance operation returned by the service.

Throws:

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

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

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

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

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

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

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

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

InvalidDBClusterStateException - The DB 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 DB 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 DB 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 DB 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 DB subnet group. DB 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 DB subnet group.

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

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

DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the DB 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 DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB 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 DB cluster.

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

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

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

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

See Also:

AWS API Documentation

deleteDBClusterParameterGroup

DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest)

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

Parameters:

deleteDBClusterParameterGroupRequest - Represents the input to DeleteDBClusterParameterGroup.

Returns:

Result of the DeleteDBClusterParameterGroup operation returned by the service.

Throws:

InvalidDBParameterGroupStateException - The DB 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 DB parameter group.

See Also:

AWS API Documentation

deleteDBClusterSnapshot

DBClusterSnapshot deleteDBClusterSnapshot(DeleteDBClusterSnapshotRequest deleteDBClusterSnapshotRequest)

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

The DB 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 DB cluster snapshot state.

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

See Also:

AWS API Documentation

deleteDBInstance

DBInstance deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest)

Deletes a previously provisioned DB 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 DB instance.

InvalidDBInstanceStateException - The specified DB 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 DB snapshots.

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

See Also:

AWS API Documentation

deleteDBSubnetGroup

DeleteDBSubnetGroupResult deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)

Deletes a DB 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 DB subnet group can't be deleted because it's in use.

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

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

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 DB 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 DB parameter group.

See Also:

AWS API Documentation

describeDBClusterParameters

DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest)

Returns the detailed parameter list for a particular DB 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 DB parameter group.

See Also:

AWS API Documentation

describeDBClusterSnapshotAttributes

DBClusterSnapshotAttributesResult describeDBClusterSnapshotAttributes(DescribeDBClusterSnapshotAttributesRequest describeDBClusterSnapshotAttributesRequest)

Returns a list of DB 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 DB cluster snapshot. If all is included in the list of values for the restore attribute, then the manual DB 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 DB cluster snapshot.

See Also:

AWS API Documentation

describeDBClusterSnapshots

DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest)

Returns information about DB 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 DB cluster snapshot.

See Also:

AWS API Documentation

describeDBClusters

DescribeDBClustersResult describeDBClusters(DescribeDBClustersRequest describeDBClustersRequest)

Returns information about provisioned Amazon DocumentDB DB clusters. This API operation supports pagination.

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

See Also:

AWS API Documentation

describeDBEngineVersions

DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)

Returns a list of the available DB 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 DB 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 DB 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 DB instances, DB security groups, DB snapshots, and DB parameter groups for the past 14 days. You can obtain events specific to a particular DB instance, DB security group, DB snapshot, or DB 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 DB 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, DB 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 DB cluster.

A failover for a DB cluster promotes one of the Amazon DocumentDB replicas (read-only instances) in the DB 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 DB cluster.

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

InvalidDBInstanceStateException - The specified DB 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 DB instance.

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

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

See Also:

AWS API Documentation

modifyDBCluster

DBCluster modifyDBCluster(ModifyDBClusterRequest modifyDBClusterRequest)

Modifies a setting for an Amazon DocumentDB DB 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 DB cluster.

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

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

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

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

InvalidDBSubnetGroupStateException - The DB 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 DB cluster parameter group.

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

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

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

See Also:

AWS API Documentation

modifyDBClusterParameterGroup

ModifyDBClusterParameterGroupResult modifyDBClusterParameterGroup(ModifyDBClusterParameterGroupRequest modifyDBClusterParameterGroupRequest)

Modifies the parameters of a DB 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 DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB 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 DB cluster. This step is especially important for parameters that are critical when creating the default database for a DB 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 DB parameter group.

InvalidDBParameterGroupStateException - The DB 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 DB 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 DB cluster snapshot. Use the value all to make the manual DB 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 DB 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 DB cluster snapshot.

InvalidDBClusterSnapshotStateException - The provided value isn't a valid DB 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 a DB 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 DB instance isn't in the available state.

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

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

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

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

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

InsufficientDBInstanceCapacityException - The specified DB 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 DB instances.

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

DBUpgradeDependencyFailureException - The DB upgrade failed because a resource that the DB 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 DB 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 DB subnet group. DB 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 DB subnet group.

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

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

DBSubnetGroupDoesNotCoverEnoughAZsException - Subnets in the DB 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 DB instance, usually for maintenance reasons. For example, if you make certain changes, or if you change the DB cluster parameter group that is associated with the DB instance, you must reboot the instance for the changes to take effect.

Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB 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 DB instance isn't in the available state.

DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing DB 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 DB instance.

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

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

See Also:

AWS API Documentation

resetDBClusterParameterGroup

ResetDBClusterParameterGroupResult resetDBClusterParameterGroup(ResetDBClusterParameterGroupRequest resetDBClusterParameterGroupRequest)

Modifies the parameters of a DB cluster parameter group to the default value. To reset specific parameters, submit a list of the following: ParameterName and ApplyMethod. To reset the entire DB 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 DB 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 DB parameter group.

See Also:

AWS API Documentation

restoreDBClusterFromSnapshot

DBCluster restoreDBClusterFromSnapshot(RestoreDBClusterFromSnapshotRequest restoreDBClusterFromSnapshotRequest)

Creates a new DB cluster from a DB snapshot or DB cluster snapshot.

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

If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB 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 DB cluster with the given identifier.

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

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

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

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

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

InsufficientDBClusterCapacityException - The DB 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 DB snapshot doesn't allow deletion.

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

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

InvalidVPCNetworkStateException - The DB 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 DB 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 DB cluster to an arbitrary point in time. Users can restore to any point in time before LatestRestorableTime for up to BackupRetentionPeriod days. The target DB cluster is created from the source DB cluster with the same configuration as the original DB cluster, except that the new DB cluster is created with the default DB 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 DB cluster with the given identifier.

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

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

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

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

InsufficientDBClusterCapacityException - The DB 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 DB cluster snapshot state.

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

InvalidDBSnapshotStateException - The state of the DB 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 DB 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 DB instances.

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()