DocDBElasticClient

Suggest an Edit
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.

Installation

NPM
npm install @aws-sdk/client-docdb-elastic
Yarn
yarn add @aws-sdk/client-docdb-elastic
pnpm
pnpm add @aws-sdk/client-docdb-elastic

DocDBElasticClient Operations

Command
Summary
ApplyPendingMaintenanceActionCommand

The type of pending maintenance action to be applied to the resource.

CopyClusterSnapshotCommand

Copies a snapshot of an elastic cluster.

CreateClusterCommand

Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure.

CreateClusterSnapshotCommand

Creates a snapshot of an elastic cluster.

DeleteClusterCommand

Delete an elastic cluster.

DeleteClusterSnapshotCommand

Delete an elastic cluster snapshot.

GetClusterCommand

Returns information about a specific elastic cluster.

GetClusterSnapshotCommand

Returns information about a specific elastic cluster snapshot

GetPendingMaintenanceActionCommand

Retrieves all maintenance actions that are pending.

ListClusterSnapshotsCommand

Returns information about snapshots for a specified elastic cluster.

ListClustersCommand

Returns information about provisioned Amazon DocumentDB elastic clusters.

ListPendingMaintenanceActionsCommand

Retrieves a list of all maintenance actions that are pending.

ListTagsForResourceCommand

Lists all tags on a elastic cluster resource

RestoreClusterFromSnapshotCommand

Restores an elastic cluster from a snapshot.

StartClusterCommand

Restarts the stopped elastic cluster that is specified by clusterARN.

StopClusterCommand

Stops the running elastic cluster that is specified by clusterArn. The elastic cluster must be in the available state.

TagResourceCommand

Adds metadata tags to an elastic cluster resource

UntagResourceCommand

Removes metadata tags from an elastic cluster resource

UpdateClusterCommand

Modifies an elastic cluster. This includes updating admin-username/password, upgrading the API version, and setting up a backup window and maintenance window

DocDBElasticClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: DocDBElasticClientConfig