AWS SDK for C++AWS SDK for C++ Version 1.11.440 |
#include <KeyspacesClient.h>
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.
Definition at line 43 of file KeyspacesClient.h.
Definition at line 46 of file KeyspacesClient.h.
Definition at line 50 of file KeyspacesClient.h.
Definition at line 51 of file KeyspacesClient.h.
Aws::Keyspaces::KeyspacesClientConfiguration()
,
nullptr
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Keyspaces::KeyspacesClientConfiguration()
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
nullptr
,
Aws::Keyspaces::KeyspacesClientConfiguration()
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config is not specified, it will be initialized to default values.
Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, the default http client factory will be used
The CreateKeyspace
operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.
CreateKeyspace
is an asynchronous operation. You can monitor the creation status of the new keyspace by using the GetKeyspace
operation.
For more information, see Create a keyspace in the Amazon Keyspaces Developer Guide.
nullptr
An Async wrapper for CreateKeyspace that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 128 of file KeyspacesClient.h.
A Callable wrapper for CreateKeyspace that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 119 of file KeyspacesClient.h.
The CreateTable
operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.
CreateTable
is an asynchronous operation. When the request is received, the status of the table is set to CREATING
. You can monitor the creation status of the new table by using the GetTable
operation, which returns the current status
of the table. You can start using a table when the status is ACTIVE
.
For more information, see Create a table in the Amazon Keyspaces Developer Guide.
nullptr
An Async wrapper for CreateTable that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 163 of file KeyspacesClient.h.
A Callable wrapper for CreateTable that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 154 of file KeyspacesClient.h.
The CreateType
operation creates a new user-defined type in the specified keyspace.
For more information, see User-defined types (UDTs) in the Amazon Keyspaces Developer Guide.
nullptr
An Async wrapper for CreateType that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 192 of file KeyspacesClient.h.
A Callable wrapper for CreateType that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 183 of file KeyspacesClient.h.
nullptr
An Async wrapper for DeleteKeyspace that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 218 of file KeyspacesClient.h.
A Callable wrapper for DeleteKeyspace that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 209 of file KeyspacesClient.h.
The DeleteTable
operation deletes a table and all of its data. After a DeleteTable
request is received, the specified table is in the DELETING
state until Amazon Keyspaces completes the deletion. If the table is in the ACTIVE
state, you can delete it. If a table is either in the CREATING
or UPDATING
states, then Amazon Keyspaces returns a ResourceInUseException
. If the specified table does not exist, Amazon Keyspaces returns a ResourceNotFoundException
. If the table is already in the DELETING
state, no error is returned.
nullptr
An Async wrapper for DeleteTable that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 251 of file KeyspacesClient.h.
A Callable wrapper for DeleteTable that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 242 of file KeyspacesClient.h.
The DeleteType
operation deletes a user-defined type (UDT). You can only delete a type that is not used in a table or another UDT.
nullptr
An Async wrapper for DeleteType that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 278 of file KeyspacesClient.h.
A Callable wrapper for DeleteType that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 269 of file KeyspacesClient.h.
Returns the name and the Amazon Resource Name (ARN) of the specified table.
nullptr
An Async wrapper for GetKeyspace that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 304 of file KeyspacesClient.h.
A Callable wrapper for GetKeyspace that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 295 of file KeyspacesClient.h.
Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.
To read table metadata using GetTable
, the IAM principal needs Select
action permissions for the table and the system keyspace.
nullptr
An Async wrapper for GetTable that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 333 of file KeyspacesClient.h.
Returns auto scaling related settings of the specified table in JSON format. If the table is a multi-Region table, the Amazon Web Services Region specific auto scaling settings of the table are included.
Amazon Keyspaces auto scaling helps you provision throughput capacity for variable workloads efficiently by increasing and decreasing your table's read and write capacity automatically in response to application traffic. For more information, see Managing throughput capacity automatically with Amazon Keyspaces auto scaling in the Amazon Keyspaces Developer Guide.
GetTableAutoScalingSettings
can't be used as an action in an IAM policy.
To define permissions for GetTableAutoScalingSettings
, you must allow the following two actions in the IAM policy statement's Action
element:
application-autoscaling:DescribeScalableTargets
application-autoscaling:DescribeScalingPolicies
nullptr
An Async wrapper for GetTableAutoScalingSettings that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 373 of file KeyspacesClient.h.
A Callable wrapper for GetTableAutoScalingSettings that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 364 of file KeyspacesClient.h.
A Callable wrapper for GetTable that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 324 of file KeyspacesClient.h.
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.
To read keyspace metadata using GetType
, the IAM principal needs Select
action permissions for the system keyspace.
nullptr
An Async wrapper for GetType that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 403 of file KeyspacesClient.h.
A Callable wrapper for GetType that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 394 of file KeyspacesClient.h.
{}
)
const
nullptr
,
{}
An Async wrapper for ListKeyspaces that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 429 of file KeyspacesClient.h.
{}
)
const
A Callable wrapper for ListKeyspaces that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 420 of file KeyspacesClient.h.
The ListTables
operation returns a list of tables for a specified keyspace.
To read keyspace metadata using ListTables
, the IAM principal needs Select
action permissions for the system keyspace.
nullptr
An Async wrapper for ListTables that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 457 of file KeyspacesClient.h.
A Callable wrapper for ListTables that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 448 of file KeyspacesClient.h.
Returns a list of all tags associated with the specified Amazon Keyspaces resource.
To read keyspace metadata using ListTagsForResource
, the IAM principal needs Select
action permissions for the specified resource and the system keyspace.
nullptr
An Async wrapper for ListTagsForResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 486 of file KeyspacesClient.h.
A Callable wrapper for ListTagsForResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 477 of file KeyspacesClient.h.
The ListTypes
operation returns a list of types for a specified keyspace.
To read keyspace metadata using ListTypes
, the IAM principal needs Select
action permissions for the system keyspace.
nullptr
An Async wrapper for ListTypes that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 514 of file KeyspacesClient.h.
A Callable wrapper for ListTypes that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 505 of file KeyspacesClient.h.
Restores the table to the specified point in time within the earliest_restorable_timestamp
and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.
Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.
When you restore using point in time recovery, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp (day:hour:minute:second)
to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp.
In addition to the table's schema, data, and TTL settings, RestoreTable
restores the capacity mode, auto scaling settings, encryption settings, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted.
You can also overwrite these settings during restore:
Read/write capacity mode
Provisioned throughput capacity units
Auto scaling settings
Point-in-time (PITR) settings
Tags
For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide.
Note that the following settings are not restored, and you must configure them manually for the new table:
Identity and Access Management (IAM) policies
Amazon CloudWatch metrics and alarms
nullptr
An Async wrapper for RestoreTable that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 565 of file KeyspacesClient.h.
A Callable wrapper for RestoreTable that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 556 of file KeyspacesClient.h.
Associates a set of tags with a Amazon Keyspaces resource. You can then activate these user-defined tags so that they appear on the Cost Management Console for cost allocation tracking. For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
For IAM policy examples that show how to control access to Amazon Keyspaces resources based on tags, see Amazon Keyspaces resource access based on tags in the Amazon Keyspaces Developer Guide.
nullptr
An Async wrapper for TagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 599 of file KeyspacesClient.h.
A Callable wrapper for TagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 590 of file KeyspacesClient.h.
nullptr
An Async wrapper for UntagResource that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 625 of file KeyspacesClient.h.
A Callable wrapper for UntagResource that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 616 of file KeyspacesClient.h.
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. Note that you can only update one specific table setting per update operation.
nullptr
An Async wrapper for UpdateTable that queues the request into a thread executor and triggers associated callback when operation has finished.
Definition at line 653 of file KeyspacesClient.h.
A Callable wrapper for UpdateTable that returns a future to the operation so that it can be executed in parallel to other requests.
Definition at line 644 of file KeyspacesClient.h.
Definition at line 660 of file KeyspacesClient.h.