Amazon MemoryDB¶

Description¶

MemoryDB is a fully managed, Redis OSS-compatible, in-memory database that delivers ultra-fast performance and Multi-AZ durability for modern applications built using microservices architectures. MemoryDB stores the entire database in-memory, enabling low latency and high throughput data access. It is compatible with Redis OSS, a popular open source data store, enabling you to leverage Redis OSS’ flexible and friendly data structures, APIs, and commands.

Usage¶

memorydb(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
- use_dual_stack: Set this to true to use the dualstack (IPv4 and IPv6) endpoint for a service, where available, falling back to the regular endpoint when it isn't. Defaults to the AWS_USE_DUALSTACK_ENDPOINT environment variable when unset.
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 <- memorydb(
  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",
    use_dual_stack = "logical"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

`batch_update_cluster`	Apply the service update to a list of clusters supplied
`copy_snapshot`	Makes a copy of an existing snapshot
`create_acl`	Creates an Access Control List
`create_cluster`	Creates a cluster
`create_multi_region_cluster`	Creates a new multi-Region cluster
`create_parameter_group`	Creates a new MemoryDB parameter group
`create_snapshot`	Creates a copy of an entire cluster at a specific moment in time
`create_subnet_group`	Creates a subnet group
`create_user`	Creates a MemoryDB user
`delete_acl`	Deletes an Access Control List
`delete_cluster`	Deletes a cluster
`delete_multi_region_cluster`	Deletes an existing multi-Region cluster
`delete_parameter_group`	Deletes the specified parameter group
`delete_snapshot`	Deletes an existing snapshot
`delete_subnet_group`	Deletes a subnet group
`delete_user`	Deletes a user
`describe_ac_ls`	Returns a list of ACLs
`describe_clusters`	Returns information about all provisioned clusters if no cluster identifier is specified, or about a specific cluster if a cluster name is supplied
`describe_engine_versions`	Returns a list of the available Redis OSS engine versions
`describe_events`	Returns events related to clusters, security groups, and parameter groups
`describe_multi_region_clusters`	Returns details about one or more multi-Region clusters
`describe_multi_region_parameter_groups`	Returns a list of multi-region parameter groups
`describe_multi_region_parameters`	Returns the detailed parameter list for a particular multi-region parameter group
`describe_parameter_groups`	Returns a list of parameter group descriptions
`describe_parameters`	Returns the detailed parameter list for a particular parameter group
`describe_reserved_nodes`	Returns information about reserved nodes for this account, or about a specified reserved node
`describe_reserved_nodes_offerings`	Lists available reserved node offerings
`describe_service_updates`	Returns details of the service updates
`describe_snapshots`	Returns information about cluster snapshots
`describe_subnet_groups`	Returns a list of subnet group descriptions
`describe_users`	Returns a list of users
`failover_shard`	Used to failover a shard
`list_allowed_multi_region_cluster_updates`	Lists the allowed updates for a multi-Region cluster
`list_allowed_node_type_updates`	Lists all available node types that you can scale to from your cluster's current node type
`list_tags`	Lists all tags currently on a named resource
`purchase_reserved_nodes_offering`	Allows you to purchase a reserved node offering
`reset_parameter_group`	Modifies the parameters of a parameter group to the engine or system default value
`tag_resource`	Use this operation to add tags to a resource
`untag_resource`	Use this operation to remove tags on a resource
`update_acl`	Changes the list of users that belong to the Access Control List
`update_cluster`	Modifies the settings for a cluster
`update_multi_region_cluster`	Updates the configuration of an existing multi-Region cluster
`update_parameter_group`	Updates the parameters of a parameter group
`update_subnet_group`	Updates a subnet group
`update_user`	Changes user password(s) and/or access string

Examples¶

svc <- memorydb()
svc$batch_update_cluster(
  Foo = 123
)