aws-elixir

View Source AWS.DocDBElastic (aws-elixir v1.0.4)

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.

Link to this section Summary

Functions

apply_pending_maintenance_action(client, input, options \\ [])

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

copy_cluster_snapshot(client, snapshot_arn, input, options \\ [])

Copies a snapshot of an elastic cluster.

create_cluster(client, input, options \\ [])

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

create_cluster_snapshot(client, input, options \\ [])

Creates a snapshot of an elastic cluster.

delete_cluster(client, cluster_arn, input, options \\ [])

Delete an elastic cluster.

delete_cluster_snapshot(client, snapshot_arn, input, options \\ [])

Delete an elastic cluster snapshot.

get_cluster(client, cluster_arn, options \\ [])

Returns information about a specific elastic cluster.

get_cluster_snapshot(client, snapshot_arn, options \\ [])

Returns information about a specific elastic cluster snapshot

get_pending_maintenance_action(client, resource_arn, options \\ [])

Retrieves all maintenance actions that are pending.

list_cluster_snapshots(client, cluster_arn \\ nil, max_results \\ nil, next_token \\ nil, snapshot_type \\ nil, options \\ [])

Returns information about snapshots for a specified elastic cluster.

list_clusters(client, max_results \\ nil, next_token \\ nil, options \\ [])

Returns information about provisioned Amazon DocumentDB elastic clusters.

list_pending_maintenance_actions(client, max_results \\ nil, next_token \\ nil, options \\ [])

Retrieves a list of all maintenance actions that are pending.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists all tags on a elastic cluster resource

metadata()
restore_cluster_from_snapshot(client, snapshot_arn, input, options \\ [])

Restores an elastic cluster from a snapshot.

start_cluster(client, cluster_arn, input, options \\ [])

Restarts the stopped elastic cluster that is specified by clusterARN.

stop_cluster(client, cluster_arn, input, options \\ [])

Stops the running elastic cluster that is specified by clusterArn.

tag_resource(client, resource_arn, input, options \\ [])

Adds metadata tags to an elastic cluster resource

untag_resource(client, resource_arn, input, options \\ [])

Removes metadata tags from an elastic cluster resource

update_cluster(client, cluster_arn, input, options \\ [])

Modifies an elastic cluster.

Link to this section Functions

Link to this function

apply_pending_maintenance_action(client, input, options \\ [])

View Source

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

Link to this function

copy_cluster_snapshot(client, snapshot_arn, input, options \\ [])

View Source

Copies a snapshot of an elastic cluster.

Link to this function

create_cluster(client, input, options \\ [])

View Source

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

Link to this function

create_cluster_snapshot(client, input, options \\ [])

View Source

Creates a snapshot of an elastic cluster.

Link to this function

delete_cluster(client, cluster_arn, input, options \\ [])

View Source

Delete an elastic cluster.

Link to this function

delete_cluster_snapshot(client, snapshot_arn, input, options \\ [])

View Source

Delete an elastic cluster snapshot.

Link to this function

get_cluster(client, cluster_arn, options \\ [])

View Source

Returns information about a specific elastic cluster.

Link to this function

get_cluster_snapshot(client, snapshot_arn, options \\ [])

View Source

Returns information about a specific elastic cluster snapshot

Link to this function

get_pending_maintenance_action(client, resource_arn, options \\ [])

View Source

Retrieves all maintenance actions that are pending.

Link to this function

list_cluster_snapshots(client, cluster_arn \\ nil, max_results \\ nil, next_token \\ nil, snapshot_type \\ nil, options \\ [])

View Source

Returns information about snapshots for a specified elastic cluster.

Link to this function

list_clusters(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Returns information about provisioned Amazon DocumentDB elastic clusters.

Link to this function

list_pending_maintenance_actions(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Retrieves a list of all maintenance actions that are pending.

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

Lists all tags on a elastic cluster resource

Link to this function

metadata()

View Source
Link to this function

restore_cluster_from_snapshot(client, snapshot_arn, input, options \\ [])

View Source

Restores an elastic cluster from a snapshot.

Link to this function

start_cluster(client, cluster_arn, input, options \\ [])

View Source

Restarts the stopped elastic cluster that is specified by clusterARN.

Link to this function

stop_cluster(client, cluster_arn, input, options \\ [])

View Source

Stops the running elastic cluster that is specified by clusterArn.

The elastic cluster must be in the available state.

Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds metadata tags to an elastic cluster resource

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes metadata tags from an elastic cluster resource

Link to this function

update_cluster(client, cluster_arn, input, options \\ [])

View Source

Modifies an elastic cluster.

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