Client

keyspaces

R Documentation

Amazon Keyspaces

Description

Amazon Keyspaces (for Apache Cassandra) is a scalable, highly available, and managed Apache Cassandra-compatible database service. Amazon Keyspaces makes it easy to migrate, run, and scale Cassandra workloads in the Amazon Web Services Cloud. With just a few clicks on the Amazon Web Services Management Console or a few lines of code, you can create keyspaces and tables in Amazon Keyspaces, without deploying any infrastructure or installing software.

In addition to supporting Cassandra Query Language (CQL) requests via open-source Cassandra drivers, Amazon Keyspaces supports data definition language (DDL) operations to manage keyspaces and tables using the Amazon Web Services SDK and CLI, as well as infrastructure as code (IaC) services and tools such as CloudFormation and Terraform. This API reference describes the supported DDL operations in detail.

For the list of all supported CQL APIs, see Supported Cassandra APIs, operations, and data types in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.

To learn how Amazon Keyspaces API actions are recorded with CloudTrail, see Amazon Keyspaces information in CloudTrail in the Amazon Keyspaces Developer Guide.

For more information about Amazon Web Services APIs, for example how to implement retry logic or how to sign Amazon Web Services API requests, see Amazon Web Services APIs in the General Reference.

Usage

keyspaces(
  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 <- keyspaces(
  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_keyspace	The CreateKeyspace operation adds a new keyspace to your account
create_table	The CreateTable operation adds a new table to the specified keyspace
create_type	The CreateType operation creates a new user-defined type in the specified keyspace
delete_keyspace	The DeleteKeyspace operation deletes a keyspace and all of its tables
delete_table	The DeleteTable operation deletes a table and all of its data
delete_type	The DeleteType operation deletes a user-defined type (UDT)
get_keyspace	Returns the name of the specified keyspace, the Amazon Resource Name (ARN), the replication strategy, the Amazon Web Services Regions of a multi-Region keyspace, and the status of newly added Regions after an UpdateKeyspace operation
get_table	Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata
get_table_auto_scaling_settings	Returns auto scaling related settings of the specified table in JSON format
get_type	The GetType operation returns information about the type, for example the field definitions, the timestamp when the type was last modified, the level of nesting, the status, and details about if the type is used in other types and tables
list_keyspaces	The ListKeyspaces operation returns a list of keyspaces
list_tables	The ListTables operation returns a list of tables for a specified keyspace
list_tags_for_resource	Returns a list of all tags associated with the specified Amazon Keyspaces resource
list_types	The ListTypes operation returns a list of types for a specified keyspace
restore_table	Restores the table to the specified point in time within the earliest_restorable_timestamp and the current time
tag_resource	Associates a set of tags with a Amazon Keyspaces resource
untag_resource	Removes the association of tags from a Amazon Keyspaces resource
update_keyspace	Adds a new Amazon Web Services Region to the keyspace
update_table	Adds new columns to the table or updates one of the table's settings, for example capacity mode, auto scaling, encryption, point-in-time recovery, or ttl settings

Examples

## Not run: 
svc <- keyspaces()
svc$create_keyspace(
  Foo = 123
)

## End(Not run)