Method Detail

addTagsToResource

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.

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.

createDBClusterParameterGroup

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.

deleteDBCluster

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.

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.

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.

describeEvents

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.

failoverDBCluster

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.

modifyDBClusterParameterGroup

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.

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.

modifyDBClusterSnapshotAttribute

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.

rebootDBInstance

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.

resetDBClusterParameterGroup

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.

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.

restoreDBClusterFromSnapshot

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.

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.

restoreDBClusterToPointInTime

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.

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.

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

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.