ContextQMD
Back to Aws Doc Sdk Examples

Amazon Keyspaces code examples for the SDK for Kotlin

kotlin/services/keyspaces/README.md

latest4.8 KB
Original Source

Amazon Keyspaces code examples for the SDK for Kotlin

Overview

Shows how to use the AWS SDK for Kotlin to work with Amazon Keyspaces (for Apache Cassandra).

<!--custom.overview.start--> <!--custom.overview.end-->

Amazon Keyspaces is a scalable, highly available, and managed Apache Cassandra-compatible database service.

⚠ Important

  • Running this code might result in charges to your AWS account. For more details, see AWS Pricing and Free Tier.
  • Running the tests might result in charges to your AWS account.
  • We recommend that you grant your code least privilege. At most, grant only the minimum permissions required to perform the task. For more information, see Grant least privilege.
  • This code is not tested in every AWS Region. For more information, see AWS Regional Services.
<!--custom.important.start--> <!--custom.important.end-->

Code examples

Prerequisites

For prerequisites, see the README in the kotlin folder.

<!--custom.prerequisites.start--> <!--custom.prerequisites.end-->

Get started

Basics

Code examples that show you how to perform the essential operations within a service.

Single actions

Code excerpts that show you how to call individual service functions.

<!--custom.examples.start--> <!--custom.examples.end-->

Run the examples

Instructions

<!--custom.instructions.start--> <!--custom.instructions.end-->

Hello Amazon Keyspaces

This example shows you how to get started using Amazon Keyspaces.

Learn the basics

This example shows you how to do the following:

  • Create a keyspace and table. The table schema holds movie data and has point-in-time recovery enabled.
  • Connect to the keyspace using a secure TLS connection with SigV4 authentication.
  • Query the table. Add, retrieve, and update movie data.
  • Update the table. Add a column to track watched movies.
  • Restore the table to its previous state and clean up resources.
<!--custom.basic_prereqs.keyspaces_Scenario_GetStartedKeyspaces.start--> <!--custom.basic_prereqs.keyspaces_Scenario_GetStartedKeyspaces.end--> <!--custom.basics.keyspaces_Scenario_GetStartedKeyspaces.start--> <!--custom.basics.keyspaces_Scenario_GetStartedKeyspaces.end-->

Tests

⚠ Running tests might result in charges to your AWS account.

To find instructions for running these tests, see the README in the kotlin folder.

<!--custom.tests.start-->

To successfully run the JUnit tests, define the following values in the test:

  • fileName - The name of the JSON file that contains movie data. (Get this file from the GitHub repo at resources/sample_file.)
  • keyspaceName - The name of the keyspace to create.

You can run the JUnit tests from an IDE, such as IntelliJ, or from the command line. As each test runs, you can view messages that inform you if the various tests succeed or fail. For example, the following message informs you that Test 3 passed.

Test 3 passed

WARNING: Running these JUnit tests manipulates real AWS resources and might incur charges on your account.

<!--custom.tests.end-->

Additional resources

<!--custom.resources.start--> <!--custom.resources.end-->

Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: Apache-2.0