AWS keyspaces documentation change
Summary
Restructured and expanded documentation for using Amazon Keyspaces with AWS CloudShell. Added sections on integration options, prerequisites, setup steps, TLS configuration, authentication methods, best practices, and troubleshooting.
Security assessment
The changes add documentation for TLS certificate configuration and IAM authentication methods, which are security features. However, there's no evidence this addresses a specific security vulnerability. The additions are standard security documentation improvements.
Diff
diff --git a/keyspaces/latest/devguide/using-aws-with-cloudshell.md b/keyspaces/latest/devguide/using-aws-with-cloudshell.md index 9ff4ba9e5..d7637c17d 100644 --- a//keyspaces/latest/devguide/using-aws-with-cloudshell.md +++ b//keyspaces/latest/devguide/using-aws-with-cloudshell.md @@ -5 +5 @@ -Obtaining IAM permissions for AWS CloudShellInteracting with Amazon Keyspaces using AWS CloudShell +AWS CloudShell integration optionsPrerequisitesGetting started with AWS CloudShellObtaining IAM permissions for AWS CloudShellInstalling the cqlsh clientConfiguring TLS certificatesConnecting to Amazon KeyspacesUsing CQLSH with Amazon KeyspacesPersisting data in AWS CloudShellBest practicesTroubleshootingExample: How to interact with Amazon Keyspaces using AWS CloudShell @@ -9 +9 @@ Obtaining IAM permissions for AWS CloudShellInteracting with Amazon Keyspaces us -AWS CloudShell is a browser-based, pre-authenticated shell that you can launch directly from the AWS Management Console. You can run AWS CLI commands against AWS services using your preferred shell (Bash, PowerShell or Z shell). To work with Amazon Keyspaces using `cqlsh`, you must install the `cqlsh-expansion`. For `cqlsh-expansion` installation instructions, see [Using the cqlsh-expansion to connect to Amazon Keyspaces](./programmatic.cqlsh.html#using_cqlsh). +AWS CloudShell is a browser-based, pre-authenticated shell that you can launch directly from the AWS Management Console. You can run AWS CLI commands against AWS services using your preferred shell (Bash, PowerShell or Z shell). AWS CloudShell comes pre-authenticated with your console credentials and includes common tools for working with AWS services, including the AWS CLI, Python, and Node.js. @@ -12,0 +13,37 @@ You [launch AWS CloudShell from the AWS Management Console](https://docs.aws.ama +## AWS CloudShell integration options + +Amazon Keyspaces offers two ways to use AWS CloudShell: + + 1. **Integrated AWS CloudShell experience** \- A streamlined connection method available directly from the Amazon Keyspaces console that automatically initializes the `cqlsh-expansion` and connects to a specific keyspace. For complete instructions on using this integrated experience, see [Connect to Amazon Keyspaces using AWS CloudShell from the console](./console_cloudshell_integration.html). + + 2. **Manual AWS CloudShell setup** \- Manually install and configure `cqlsh` in AWS CloudShell. The steps are described in the following sections and provides more control over the setup process and enable custom configurations. + + + + +## Prerequisites + +Before using Amazon Keyspaces with AWS CloudShell, ensure you have: + + * An AWS account with access to Amazon Keyspaces and AWS CloudShell + + * Appropriate IAM permissions to use both services + + * Basic familiarity with Cassandra Query Language (CQL) + + + + +## Getting started with AWS CloudShell + +To access AWS CloudShell: + + 1. Sign in to the AWS Management Console + + 2. Launch AWS CloudShell by choosing the AWS CloudShell icon in the navigation bar at the top of the console, or by navigating to [https://console.aws.amazon.com/cloudshell/](https://console.aws.amazon.com/cloudshell/) + + 3. Wait for the AWS CloudShell environment to initialize + + + + @@ -41 +78,65 @@ For more information about how to restrict actions or limit access to specific r -## Interacting with Amazon Keyspaces using AWS CloudShell +## Installing the cqlsh client + +AWS CloudShell does not come with `cqlsh` pre-installed. You need to install it to interact with Amazon Keyspaces. You can install the Amazon Keyspaces-specific version of `cqlsh`. For `cqlsh-expansion` installation instructions, see [Using the cqlsh-expansion to connect to Amazon Keyspaces](./programmatic.cqlsh.html#using_cqlsh). + +## Configuring TLS certificates + +To connect to Amazon Keyspaces using a TLS connection, you need to download the required Amazon digital certificates. For detailed instructions on downloading and configuring the SSL certificate, see [How to manually configure cqlsh connections for TLS](./programmatic.cqlsh.html#encrypt_using_tls). + +## Connecting to Amazon Keyspaces + +You can connect to Amazon Keyspaces using either IAM credentials (recommended) or service-specific credentials. + +### Connecting with IAM credentials (recommended) + +AWS CloudShell is already authenticated with your IAM credentials. To connect using these credentials, you can use the SigV4 authentication plugin. For detailed instructions on using IAM credentials with `cqlsh`, see [Using the cqlsh-expansion to connect to Amazon Keyspaces](./programmatic.cqlsh.html#using_cqlsh). + +### Connecting with service-specific credentials + +If you have created service-specific credentials for Amazon Keyspaces, you can use them to connect. For information about creating and using service-specific credentials, see [Create service-specific credentials for programmatic access to Amazon Keyspaces](./programmatic.credentials.ssc.html). + +## Using CQLSH with Amazon Keyspaces + +When connected, you can use standard CQL commands to interact with your keyspaces and tables. For detailed information about supported CQL commands and operations, see [Using the cqlsh-expansion to connect to Amazon Keyspaces](./programmatic.cqlsh.html#using_cqlsh). + +## Persisting data in AWS CloudShell + +AWS CloudShell provides 1 GB of persistent storage in your home directory. This means scripts, certificates, and configuration files you create remain available across sessions. You can create a configuration file for `cqlsh` to simplify connections. + +With a configuration file, you can run `cqlsh` without specifying additional parameters. For more information about creating and using `cqlsh` configuration files, see [Using the cqlsh-expansion to connect to Amazon Keyspaces](./programmatic.cqlsh.html#using_cqlsh). + +## Best practices + +When using Amazon Keyspaces with AWS CloudShell, we recommend the following best practices: + + * Create scripts for repetitive tasks and store them in your persistent home directory. + + * Use environment variables for sensitive information rather than hardcoding them. + + * Remember that AWS CloudShell sessions may time out after inactivity. + + * Be mindful of the AWS CloudShell service quotas and limitations. + + * Consider using the AWS CLI for automated operations with Amazon Keyspaces. + + + + +## Troubleshooting + +If you encounter issues when connecting to Amazon Keyspaces from AWS CloudShell: + + * Verify your IAM permissions include the necessary Amazon Keyspaces actions. + + * Ensure that you are using the correct endpoint for your Region. + + * Check that the SSL certificates are correctly downloaded and referenced. + + * Verify that your service-specific credentials are correct and not expired. + + * If using a cqlshrc file, check its formatting and permissions. + + + + +## Example: How to interact with Amazon Keyspaces using AWS CloudShell @@ -55 +156 @@ When using the `cqlsh-expansion` in AWS CloudShell, you don't need to configure - * Start typing "cloudshell" in Search box and then choose the CloudShell option. + * Start typing `cloudshell` in the search box and then choose the CloudShell option. @@ -94 +195 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -Using the console +CloudShell console integration