Client

docdbelastic

R Documentation

Amazon DocumentDB Elastic Clusters

Description

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.

Usage

docdbelastic(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
endpoint	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- docdbelastic(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

apply_pending_maintenance_action	The type of pending maintenance action to be applied to the resource
copy_cluster_snapshot	Copies a snapshot of an elastic cluster
create_cluster	Creates a new Amazon DocumentDB elastic cluster and returns its cluster structure
create_cluster_snapshot	Creates a snapshot of an elastic cluster
delete_cluster	Delete an elastic cluster
delete_cluster_snapshot	Delete an elastic cluster snapshot
get_cluster	Returns information about a specific elastic cluster
get_cluster_snapshot	Returns information about a specific elastic cluster snapshot
get_pending_maintenance_action	Retrieves all maintenance actions that are pending
list_clusters	Returns information about provisioned Amazon DocumentDB elastic clusters
list_cluster_snapshots	Returns information about snapshots for a specified elastic cluster
list_pending_maintenance_actions	Retrieves a list of all maintenance actions that are pending
list_tags_for_resource	Lists all tags on a elastic cluster resource
restore_cluster_from_snapshot	Restores an elastic cluster from a snapshot
start_cluster	Restarts the stopped elastic cluster that is specified by clusterARN
stop_cluster	Stops the running elastic cluster that is specified by clusterArn
tag_resource	Adds metadata tags to an elastic cluster resource
untag_resource	Removes metadata tags from an elastic cluster resource
update_cluster	Modifies an elastic cluster

Examples

## Not run: 
svc <- docdbelastic()
svc$apply_pending_maintenance_action(
  Foo = 123
)

## End(Not run)