Amazon Web Services, Inc.

Amazon DocumentDB Elastic Clusters

Amazon DocumentDB elastic clusters Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Amazon DocumentDB elastic clusters
Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage capacity.
Amazon DocumentDB elastic clusters also simplify how developers interact with Amazon DocumentDB elastic-clusters by eliminating the need to choose, manage or upgrade instances.
Amazon DocumentDB elastic-clusters were created to:

provide a solution for customers looking for a database that provides virtually limitless scale with rich query capabilities and MongoDB API compatibility.

give customers higher connection limits, and to reduce downtime from patching.

continue investing in a cloud-native, elastic, and class leading architecture for JSON workloads.

Endpoints 19

  • POSTApply pending maintenance action/pending-actionThe type of pending maintenance action to be applied to the resource.
  • POSTCopy cluster snapshot/cluster-snapshot/:snapshotArn/copyCopies a snapshot of an elastic cluster.
  • POSTCreate cluster/clusterCreates a new Amazon DocumentDB elastic cluster and returns its cluster structure.
  • POSTCreate cluster snapshot/cluster-snapshotCreates a snapshot of an elastic cluster.
  • GETGet cluster/cluster/:clusterArnReturns information about a specific elastic cluster.
  • PUTUpdate cluster/cluster/:clusterArnModifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window
  • DELETEDelete cluster/cluster/:clusterArnDelete an elastic cluster.
  • GETGet cluster snapshot/cluster-snapshot/:snapshotArnReturns information about a specific elastic cluster snapshot
  • DELETEDelete cluster snapshot/cluster-snapshot/:snapshotArnDelete an elastic cluster snapshot.
  • GETGet pending maintenance action/pending-action/:resourceArnRetrieves all maintenance actions that are pending.
  • GETList cluster snapshots/cluster-snapshots?clusterArn=string&nextToken=string&maxResults=0&snapshotType=stringReturns information about snapshots for a specified elastic cluster.
  • GETList clusters/clusters?nextToken=string&maxResults=0Returns information about provisioned Amazon DocumentDB elastic clusters.
  • GETList pending maintenance actions/pending-actions?nextToken=string&maxResults=0Retrieves a list of all maintenance actions that are pending.
  • GETList tags for resource/tags/:resourceArnLists all tags on a elastic cluster resource
  • POSTTag resource/tags/:resourceArnAdds metadata tags to an elastic cluster resource
  • DELETEUntag resource/tags/:resourceArn?tagKeys=Removes metadata tags from an elastic cluster resource
  • POSTRestore cluster from snapshot/cluster-snapshot/:snapshotArn/restoreRestores an elastic cluster from a snapshot.
  • POSTStart cluster/cluster/:clusterArn/startRestarts the stopped elastic cluster that is specified by clusterARN .
  • POSTStop cluster/cluster/:clusterArn/stopStops the running elastic cluster that is specified by clusterArn . The elastic cluster must be in the available state.

API details

Base URL
https://docdb-elastic.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
19 operations on 14 pathsPOST 8GET 7DELETE 3PUT 1
Description format
AWS Smithy model, API version 2022-11-28

How to test the Amazon DocumentDB Elastic Clusters in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon DocumentDB Elastic Clusters collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Apply pending maintenance action” (POST /pending-action), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Amazon DocumentDB Elastic Clusters?

Amazon DocumentDB elastic clusters Amazon DocumentDB elastic-clusters support workloads with millions of reads/writes per second and petabytes of storage… It is listed under Developer tools and has 19 endpoints.

Who publishes the Amazon DocumentDB Elastic Clusters?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Amazon DocumentDB Elastic Clusters?

Requests go to https://docdb-elastic.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the Amazon DocumentDB Elastic Clusters?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the Amazon DocumentDB Elastic Clusters have?

19 operations on 14 paths (8 POST, 7 GET, 3 DELETE, 1 PUT).

Is forking the Amazon DocumentDB Elastic Clusters free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.