Client

dax	R Documentation

Amazon DynamoDB Accelerator (DAX)¶

Description¶

DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency. You can create a DAX cluster easily, using the AWS Management Console. With a few simple modifications to your code, your application can begin taking advantage of the DAX cluster and realize significant improvements in read performance.

Usage¶

dax(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 <- dax(
  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¶

create_cluster: Creates a DAX cluster
create_parameter_group: Creates a new parameter group
create_subnet_group: Creates a new subnet group
decrease_replication_factor: Removes one or more nodes from a DAX cluster
delete_cluster: Deletes a previously provisioned DAX cluster
delete_parameter_group: Deletes the specified parameter group
delete_subnet_group: Deletes a subnet group
describe_clusters: Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied
describe_default_parameters: Returns the default system parameter information for the DAX caching software
describe_events: Returns events related to DAX clusters and parameter groups
describe_parameter_groups: Returns a list of parameter group descriptions
describe_parameters: Returns the detailed parameter list for a particular parameter group
describe_subnet_groups: Returns a list of subnet group descriptions
increase_replication_factor: Adds one or more nodes to a DAX cluster
list_tags: List all of the tags for a DAX cluster
reboot_node: Reboots a single node of a DAX cluster
tag_resource: Associates a set of tags with a DAX resource
untag_resource: Removes the association of tags from a DAX resource
update_cluster: Modifies the settings for a DAX cluster
update_parameter_group: Modifies the parameters of a parameter group
update_subnet_group: Modifies an existing subnet group

Examples¶

## Not run: 
svc <- dax()
svc$create_cluster(
  Foo = 123
)

## End(Not run)