keyspaces/aws.sdk.kotlin.services.keyspaces

Package-level declarations

Types

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.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

createKeyspace

inline suspend fun KeyspacesClient.createKeyspace(crossinline block: CreateKeyspaceRequest.Builder.() -> Unit): CreateKeyspaceResponse

The CreateKeyspace operation adds a new keyspace to your account. In an Amazon Web Services account, keyspace names must be unique within each Region.

createTable

inline suspend fun KeyspacesClient.createTable(crossinline block: CreateTableRequest.Builder.() -> Unit): CreateTableResponse

The CreateTable operation adds a new table to the specified keyspace. Within a keyspace, table names must be unique.

createType

inline suspend fun KeyspacesClient.createType(crossinline block: CreateTypeRequest.Builder.() -> Unit): CreateTypeResponse

The CreateType operation creates a new user-defined type in the specified keyspace.

deleteKeyspace

inline suspend fun KeyspacesClient.deleteKeyspace(crossinline block: DeleteKeyspaceRequest.Builder.() -> Unit): DeleteKeyspaceResponse

The DeleteKeyspace operation deletes a keyspace and all of its tables.

deleteTable

inline suspend fun KeyspacesClient.deleteTable(crossinline block: DeleteTableRequest.Builder.() -> Unit): DeleteTableResponse

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.

deleteType

inline suspend fun KeyspacesClient.deleteType(crossinline block: DeleteTypeRequest.Builder.() -> Unit): DeleteTypeResponse

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.

getKeyspace

inline suspend fun KeyspacesClient.getKeyspace(crossinline block: GetKeyspaceRequest.Builder.() -> Unit): GetKeyspaceResponse

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.

getTable

inline suspend fun KeyspacesClient.getTable(crossinline block: GetTableRequest.Builder.() -> Unit): GetTableResponse

Returns information about the table, including the table's name and current status, the keyspace name, configuration settings, and metadata.

getTableAutoScalingSettings

inline suspend fun KeyspacesClient.getTableAutoScalingSettings(crossinline block: GetTableAutoScalingSettingsRequest.Builder.() -> Unit): GetTableAutoScalingSettingsResponse

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.

getType

inline suspend fun KeyspacesClient.getType(crossinline block: GetTypeRequest.Builder.() -> Unit): GetTypeResponse

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.

listKeyspaces

inline suspend fun KeyspacesClient.listKeyspaces(crossinline block: ListKeyspacesRequest.Builder.() -> Unit): ListKeyspacesResponse

The ListKeyspaces operation returns a list of keyspaces.

listTables

inline suspend fun KeyspacesClient.listTables(crossinline block: ListTablesRequest.Builder.() -> Unit): ListTablesResponse

The ListTables operation returns a list of tables for a specified keyspace.

listTagsForResource

inline suspend fun KeyspacesClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

Returns a list of all tags associated with the specified Amazon Keyspaces resource.

listTypes

inline suspend fun KeyspacesClient.listTypes(crossinline block: ListTypesRequest.Builder.() -> Unit): ListTypesResponse

The ListTypes operation returns a list of types for a specified keyspace.

restoreTable

inline suspend fun KeyspacesClient.restoreTable(crossinline block: RestoreTableRequest.Builder.() -> Unit): RestoreTableResponse

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.

tagResource

inline suspend fun KeyspacesClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

untagResource

inline suspend fun KeyspacesClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes the association of tags from a Amazon Keyspaces resource.

updateKeyspace

inline suspend fun KeyspacesClient.updateKeyspace(crossinline block: UpdateKeyspaceRequest.Builder.() -> Unit): UpdateKeyspaceResponse

Adds a new Amazon Web Services Region to the keyspace. You can add a new Region to a keyspace that is either a single or a multi-Region keyspace. Amazon Keyspaces is going to replicate all tables in the keyspace to the new Region. To successfully replicate all tables to the new Region, they must use client-side timestamps for conflict resolution. To enable client-side timestamps, specify clientSideTimestamps.status = enabled when invoking the API. For more information about client-side timestamps, see Client-side timestamps in Amazon Keyspaces in the Amazon Keyspaces Developer Guide.

updateTable

inline suspend fun KeyspacesClient.updateTable(crossinline block: UpdateTableRequest.Builder.() -> Unit): UpdateTableResponse

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.

withConfig

fun KeyspacesClient.withConfig(block: KeyspacesClient.Config.Builder.() -> Unit): KeyspacesClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.