@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonDocDB
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonDocDB instead.
Amazon DocumentDB is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
EventSubscription |
addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing event notification subscription.
|
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.
|
EventSubscription |
createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an Amazon DocumentDB event notification subscription.
|
GlobalCluster |
createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest)
Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions.
|
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.
|
EventSubscription |
deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an Amazon DocumentDB event notification subscription.
|
GlobalCluster |
deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest)
Deletes a global cluster.
|
DescribeCertificatesResult |
describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web
Services 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.
|
DescribeEventSubscriptionsResult |
describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account.
|
DescribeGlobalClustersResult |
describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters.
|
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 cluster snapshot.
|
DBInstance |
modifyDBInstance(ModifyDBInstanceRequest modifyDBInstanceRequest)
Modifies settings for an instance.
|
DBSubnetGroup |
modifyDBSubnetGroup(ModifyDBSubnetGroupRequest modifyDBSubnetGroupRequest)
Modifies an existing subnet group.
|
EventSubscription |
modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing Amazon DocumentDB event notification subscription.
|
GlobalCluster |
modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest)
Modify a setting for an Amazon DocumentDB global cluster.
|
DBInstance |
rebootDBInstance(RebootDBInstanceRequest rebootDBInstanceRequest)
You might need to reboot your instance, usually for maintenance reasons.
|
GlobalCluster |
removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest)
Detaches an Amazon DocumentDB secondary cluster from a global cluster.
|
EventSubscription |
removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
|
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. |
GlobalCluster |
switchoverGlobalCluster(SwitchoverGlobalClusterRequest switchoverGlobalClusterRequest)
Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster
in the global database cluster.
|
AmazonDocDBWaiters |
waiters() |
static final String ENDPOINT_PREFIX
EventSubscription addSourceIdentifierToSubscription(AddSourceIdentifierToSubscriptionRequest addSourceIdentifierToSubscriptionRequest)
Adds a source identifier to an existing event notification subscription.
addSourceIdentifierToSubscriptionRequest - Represents the input to AddSourceIdentifierToSubscription.SubscriptionNotFoundException - The subscription name does not exist.SourceNotFoundException - The requested source could not be found.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
Identity and Access Management (IAM) policy for Amazon DocumentDB.
addTagsToResourceRequest - Represents the input to AddTagsToResource.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.ResourcePendingMaintenanceActions applyPendingMaintenanceAction(ApplyPendingMaintenanceActionRequest applyPendingMaintenanceActionRequest)
Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).
applyPendingMaintenanceActionRequest - Represents the input to ApplyPendingMaintenanceAction.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.DBClusterParameterGroup copyDBClusterParameterGroup(CopyDBClusterParameterGroupRequest copyDBClusterParameterGroupRequest)
Copies the specified cluster parameter group.
copyDBClusterParameterGroupRequest - Represents the input to CopyDBClusterParameterGroup.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.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 Amazon Web Services Region.
To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by
TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.
copyDBClusterSnapshotRequest - Represents the input to CopyDBClusterSnapshot.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 KMS key.DBCluster createDBCluster(CreateDBClusterRequest createDBClusterRequest)
Creates a new Amazon DocumentDB cluster.
createDBClusterRequest - Represents the input to CreateDBCluster.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 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.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.InvalidGlobalClusterStateException - The requested operation can't be performed while the cluster is in this state.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.
createDBClusterParameterGroupRequest - Represents the input of CreateDBClusterParameterGroup.DBParameterGroupQuotaExceededException - This request would cause you to exceed the allowed number of parameter groups.DBParameterGroupAlreadyExistsException - A parameter group with the same name already exists.DBClusterSnapshot createDBClusterSnapshot(CreateDBClusterSnapshotRequest createDBClusterSnapshotRequest)
Creates a snapshot of a cluster.
createDBClusterSnapshotRequest - Represents the input of CreateDBClusterSnapshot.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.DBInstance createDBInstance(CreateDBInstanceRequest createDBInstanceRequest)
Creates a new instance.
createDBInstanceRequest - Represents the input to CreateDBInstance.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 KMS key.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 Amazon Web Services Region.
createDBSubnetGroupRequest - Represents the input to CreateDBSubnetGroup.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).EventSubscription createEventSubscription(CreateEventSubscriptionRequest createEventSubscriptionRequest)
Creates an Amazon DocumentDB event notification subscription. This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.
You can specify the type of source (SourceType) that you want to be notified of. You can also
provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide
a list of event categories (EventCategories) for events that you want to be notified of. For
example, you can specify SourceType = db-instance,
SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.
If you specify both the SourceType and SourceIds (such as
SourceType = db-instance and SourceIdentifier = myDBInstance1), you are notified of all
the db-instance events for the specified source. If you specify a SourceType but do not
specify a SourceIdentifier, you receive notice of the events for that source type for all your
Amazon DocumentDB sources. If you do not specify either the SourceType or the
SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging
to your customer account.
createEventSubscriptionRequest - Represents the input to CreateEventSubscription.EventSubscriptionQuotaExceededException - You have reached the maximum number of event subscriptions.SubscriptionAlreadyExistException - The provided subscription name already exists.SNSInvalidTopicException - Amazon SNS has responded that there is a problem with the specified topic.SNSNoAuthorizationException - You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).SNSTopicArnNotFoundException - The SNS topic Amazon Resource Name (ARN) does not exist.SubscriptionCategoryNotFoundException - The provided category does not exist.SourceNotFoundException - The requested source could not be found.GlobalCluster createGlobalCluster(CreateGlobalClusterRequest createGlobalClusterRequest)
Creates an Amazon DocumentDB global cluster that can span multiple multiple Amazon Web Services Regions. The global cluster contains one primary cluster with read-write capability, and up-to give read-only secondary clusters. Global clusters uses storage-based fast replication across regions with latencies less than one second, using dedicated infrastructure with no impact to your workload’s performance.
You can create a global cluster that is initially empty, and then add a primary and a secondary to it. Or you can specify an existing cluster during the create operation, and this cluster becomes the primary of the global cluster.
This action only applies to Amazon DocumentDB clusters.
createGlobalClusterRequest - Represents the input to CreateGlobalCluster.GlobalClusterAlreadyExistsException - The GlobalClusterIdentifier already exists. Choose a new global cluster identifier (unique
name) to create a new global cluster.GlobalClusterQuotaExceededException - The number of global clusters for this account is already at the maximum allowed.InvalidDBClusterStateException - The cluster isn't in a valid state.DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.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.
deleteDBClusterRequest - Represents the input to DeleteDBCluster.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.DeleteDBClusterParameterGroupResult deleteDBClusterParameterGroup(DeleteDBClusterParameterGroupRequest deleteDBClusterParameterGroupRequest)
Deletes a specified cluster parameter group. The cluster parameter group to be deleted can't be associated with any clusters.
deleteDBClusterParameterGroupRequest - Represents the input to DeleteDBClusterParameterGroup.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.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.
deleteDBClusterSnapshotRequest - Represents the input to DeleteDBClusterSnapshot.InvalidDBClusterSnapshotStateException - The provided value isn't a valid cluster snapshot state.DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.DBInstance deleteDBInstance(DeleteDBInstanceRequest deleteDBInstanceRequest)
Deletes a previously provisioned instance.
deleteDBInstanceRequest - Represents the input to DeleteDBInstance.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.DeleteDBSubnetGroupResult deleteDBSubnetGroup(DeleteDBSubnetGroupRequest deleteDBSubnetGroupRequest)
Deletes a subnet group.
The specified database subnet group must not be associated with any DB instances.
deleteDBSubnetGroupRequest - Represents the input to DeleteDBSubnetGroup.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.EventSubscription deleteEventSubscription(DeleteEventSubscriptionRequest deleteEventSubscriptionRequest)
Deletes an Amazon DocumentDB event notification subscription.
deleteEventSubscriptionRequest - Represents the input to DeleteEventSubscription.SubscriptionNotFoundException - The subscription name does not exist.InvalidEventSubscriptionStateException - Someone else might be modifying a subscription. Wait a few seconds, and try again.GlobalCluster deleteGlobalCluster(DeleteGlobalClusterRequest deleteGlobalClusterRequest)
Deletes a global cluster. The primary and secondary clusters must already be detached or deleted before attempting to delete a global cluster.
This action only applies to Amazon DocumentDB clusters.
deleteGlobalClusterRequest - Represents the input to DeleteGlobalCluster.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.InvalidGlobalClusterStateException - The requested operation can't be performed while the cluster is in this state.DescribeCertificatesResult describeCertificates(DescribeCertificatesRequest describeCertificatesRequest)
Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this Amazon Web Services account.
describeCertificatesRequest - CertificateNotFoundException - CertificateIdentifier doesn't refer to an existing certificate.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.
describeDBClusterParameterGroupsRequest - Represents the input to DescribeDBClusterParameterGroups.DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.DescribeDBClusterParametersResult describeDBClusterParameters(DescribeDBClusterParametersRequest describeDBClusterParametersRequest)
Returns the detailed parameter list for a particular cluster parameter group.
describeDBClusterParametersRequest - Represents the input to DescribeDBClusterParameters.DBParameterGroupNotFoundException - DBParameterGroupName doesn't refer to an existing parameter group.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 Amazon Web Services accounts,
DescribeDBClusterSnapshotAttributes returns the restore attribute and a list of IDs for
the Amazon Web Services accounts that are authorized to copy or restore the manual cluster snapshot. If
all is included in the list of values for the restore attribute, then the manual
cluster snapshot is public and can be copied or restored by all Amazon Web Services accounts.
describeDBClusterSnapshotAttributesRequest - Represents the input to DescribeDBClusterSnapshotAttributes.DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.DescribeDBClusterSnapshotsResult describeDBClusterSnapshots(DescribeDBClusterSnapshotsRequest describeDBClusterSnapshotsRequest)
Returns information about cluster snapshots. This API operation supports pagination.
describeDBClusterSnapshotsRequest - Represents the input to DescribeDBClusterSnapshots.DBClusterSnapshotNotFoundException - DBClusterSnapshotIdentifier doesn't refer to an existing cluster snapshot.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.
describeDBClustersRequest - Represents the input to DescribeDBClusters.DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.DescribeDBEngineVersionsResult describeDBEngineVersions(DescribeDBEngineVersionsRequest describeDBEngineVersionsRequest)
Returns a list of the available engines.
describeDBEngineVersionsRequest - Represents the input to DescribeDBEngineVersions.DescribeDBInstancesResult describeDBInstances(DescribeDBInstancesRequest describeDBInstancesRequest)
Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.
describeDBInstancesRequest - Represents the input to DescribeDBInstances.DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.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.
describeDBSubnetGroupsRequest - Represents the input to DescribeDBSubnetGroups.DBSubnetGroupNotFoundException - DBSubnetGroupName doesn't refer to an existing subnet group.EngineDefaults describeEngineDefaultClusterParameters(DescribeEngineDefaultClusterParametersRequest describeEngineDefaultClusterParametersRequest)
Returns the default engine and system parameter information for the cluster database engine.
describeEngineDefaultClusterParametersRequest - Represents the input to DescribeEngineDefaultClusterParameters.DescribeEventCategoriesResult describeEventCategories(DescribeEventCategoriesRequest describeEventCategoriesRequest)
Displays a list of categories for all event source types, or, if specified, for a specified source type.
describeEventCategoriesRequest - Represents the input to DescribeEventCategories.DescribeEventSubscriptionsResult describeEventSubscriptions(DescribeEventSubscriptionsRequest describeEventSubscriptionsRequest)
Lists all the subscription descriptions for a customer account. The description for a subscription includes
SubscriptionName, SNSTopicARN, CustomerID, SourceType,
SourceID, CreationTime, and Status.
If you specify a SubscriptionName, lists the description for that subscription.
describeEventSubscriptionsRequest - Represents the input to DescribeEventSubscriptions.SubscriptionNotFoundException - The subscription name does not exist.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.
describeEventsRequest - Represents the input to DescribeEvents.DescribeGlobalClustersResult describeGlobalClusters(DescribeGlobalClustersRequest describeGlobalClustersRequest)
Returns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
describeGlobalClustersRequest - GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.DescribeOrderableDBInstanceOptionsResult describeOrderableDBInstanceOptions(DescribeOrderableDBInstanceOptionsRequest describeOrderableDBInstanceOptionsRequest)
Returns a list of orderable instance options for the specified engine.
describeOrderableDBInstanceOptionsRequest - Represents the input to DescribeOrderableDBInstanceOptions.DescribePendingMaintenanceActionsResult describePendingMaintenanceActions(DescribePendingMaintenanceActionsRequest describePendingMaintenanceActionsRequest)
Returns a list of resources (for example, instances) that have at least one pending maintenance action.
describePendingMaintenanceActionsRequest - Represents the input to DescribePendingMaintenanceActions.ResourceNotFoundException - The specified resource ID was not found.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.
failoverDBClusterRequest - Represents the input to FailoverDBCluster.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.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags on an Amazon DocumentDB resource.
listTagsForResourceRequest - Represents the input to ListTagsForResource.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.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.
modifyDBClusterRequest - Represents the input to ModifyDBCluster.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.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.
modifyDBClusterParameterGroupRequest - Represents the input to ModifyDBClusterParameterGroup.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.DBClusterSnapshotAttributesResult modifyDBClusterSnapshotAttribute(ModifyDBClusterSnapshotAttributeRequest modifyDBClusterSnapshotAttributeRequest)
Adds an attribute and values to, or removes an attribute and values from, a manual cluster snapshot.
To share a manual cluster snapshot with other Amazon Web Services accounts, specify restore as the
AttributeName, and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web
Services accounts that are authorized to restore the manual cluster snapshot. Use the value all to
make the manual cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services
accounts. Do not add the all value for any manual cluster snapshots that contain private information
that you don't want available to all Amazon Web Services accounts. If a manual cluster snapshot is encrypted, it
can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the
ValuesToAdd parameter. You can't use all as a value for that parameter in this case.
modifyDBClusterSnapshotAttributeRequest - Represents the input to ModifyDBClusterSnapshotAttribute.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.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.
modifyDBInstanceRequest - Represents the input to ModifyDBInstance.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.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 Amazon Web Services Region.
modifyDBSubnetGroupRequest - Represents the input to ModifyDBSubnetGroup.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).EventSubscription modifyEventSubscription(ModifyEventSubscriptionRequest modifyEventSubscriptionRequest)
Modifies an existing Amazon DocumentDB event notification subscription.
modifyEventSubscriptionRequest - Represents the input to ModifyEventSubscription.EventSubscriptionQuotaExceededException - You have reached the maximum number of event subscriptions.SubscriptionNotFoundException - The subscription name does not exist.SNSInvalidTopicException - Amazon SNS has responded that there is a problem with the specified topic.SNSNoAuthorizationException - You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).SNSTopicArnNotFoundException - The SNS topic Amazon Resource Name (ARN) does not exist.SubscriptionCategoryNotFoundException - The provided category does not exist.GlobalCluster modifyGlobalCluster(ModifyGlobalClusterRequest modifyGlobalClusterRequest)
Modify a setting for an Amazon DocumentDB global cluster. You can change one or more configuration parameters (for example: deletion protection), or the global cluster identifier by specifying these parameters and the new values in the request.
This action only applies to Amazon DocumentDB clusters.
modifyGlobalClusterRequest - Represents the input to ModifyGlobalCluster.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.InvalidGlobalClusterStateException - The requested operation can't be performed while the cluster is in this state.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.
rebootDBInstanceRequest - Represents the input to RebootDBInstance.InvalidDBInstanceStateException - The specified instance isn't in the available state.DBInstanceNotFoundException - DBInstanceIdentifier doesn't refer to an existing instance.GlobalCluster removeFromGlobalCluster(RemoveFromGlobalClusterRequest removeFromGlobalClusterRequest)
Detaches an Amazon DocumentDB secondary cluster from a global cluster. The cluster becomes a standalone cluster with read-write capability instead of being read-only and receiving data from a primary in a different region.
This action only applies to Amazon DocumentDB clusters.
removeFromGlobalClusterRequest - Represents the input to RemoveFromGlobalCluster.GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.InvalidGlobalClusterStateException - The requested operation can't be performed while the cluster is in this state.DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.EventSubscription removeSourceIdentifierFromSubscription(RemoveSourceIdentifierFromSubscriptionRequest removeSourceIdentifierFromSubscriptionRequest)
Removes a source identifier from an existing Amazon DocumentDB event notification subscription.
removeSourceIdentifierFromSubscriptionRequest - Represents the input to RemoveSourceIdentifierFromSubscription.SubscriptionNotFoundException - The subscription name does not exist.SourceNotFoundException - The requested source could not be found.RemoveTagsFromResourceResult removeTagsFromResource(RemoveTagsFromResourceRequest removeTagsFromResourceRequest)
Removes metadata tags from an Amazon DocumentDB resource.
removeTagsFromResourceRequest - Represents the input to RemoveTagsFromResource.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.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.
resetDBClusterParameterGroupRequest - Represents the input to ResetDBClusterParameterGroup.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.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.
restoreDBClusterFromSnapshotRequest - Represents the input to RestoreDBClusterFromSnapshot.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 KMS key.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.
restoreDBClusterToPointInTimeRequest - Represents the input to RestoreDBClusterToPointInTime.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 KMS key.StorageQuotaExceededException - The request would cause you to exceed the allowed amount of storage available across all instances.DBCluster startDBCluster(StartDBClusterRequest startDBClusterRequest)
Restarts the stopped cluster that is specified by DBClusterIdentifier. For more information, see Stopping and
Starting an Amazon DocumentDB Cluster.
startDBClusterRequest - 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.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.
stopDBClusterRequest - 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.GlobalCluster switchoverGlobalCluster(SwitchoverGlobalClusterRequest switchoverGlobalClusterRequest)
Switches over the specified secondary Amazon DocumentDB cluster to be the new primary Amazon DocumentDB cluster in the global database cluster.
switchoverGlobalClusterRequest - GlobalClusterNotFoundException - The GlobalClusterIdentifier doesn't refer to an existing global cluster.InvalidGlobalClusterStateException - The requested operation can't be performed while the cluster is in this state.DBClusterNotFoundException - DBClusterIdentifier doesn't refer to an existing cluster.InvalidDBClusterStateException - The cluster isn't in a valid state.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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.
request - The originally executed request.AmazonDocDBWaiters waiters()