Skip to content

Commit

Permalink
docs: add Authentication and access credentials section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
vvatanabe committed Nov 9, 2023
1 parent 424e825 commit 76284c2
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,9 @@ Implementing message queueing with Amazon DynamoDB in Go.
* [Required IAM Policy](#required-iam-policy)
* [Create Table with AWS CLI](#create-table-with-aws-cli)
* [Create Table with Terraform](#create-table-with-terraform)
- [Authentication and access credentials](#authentication-and-access-credentials)
* [Environment Variables](#environment-variables)
* [Shared Configuration and Credentials Files](#shared-configuration-and-credentials-files)
- [Usage for DynamoMQ CLI](#usage-for-dynamomq-cli)
* [Available Commands](#available-commands)
* [Global Flags](#global-flags)
Expand Down Expand Up @@ -95,6 +98,22 @@ Please refer to [dynamomq-table.json](./dynamomq-table.json).

Please refer to [dynamomq-table.tf](./dynamomq-table.tf).

## Authentication and access credentials

DynamoMQ's CLI and library configure AWS Config with credentials obtained from external configuration sources. This setup allows for flexible and secure management of access credentials. The following are the default sources for configuration:

### Environment Variables

- `AWS_REGION` - Specifies the AWS region.
- `AWS_PROFILE` - Identifies the AWS profile to be used.
- `AWS_ACCESS_KEY_ID` - Your AWS access key.
- `AWS_SECRET_ACCESS_KEY` - Your AWS secret key.
- `AWS_SESSION_TOKEN` - Session token for temporary credentials.

### Shared Configuration and Credentials Files

These files provide a common location for storing AWS credentials and configuration settings, enabling consistent credential management across different AWS tools and applications.

## Usage for DynamoMQ CLI

The `dynamomq` command-line interface provides a range of commands to interact with your DynamoDB-based message queue. Below are the available commands and global flags that can be used with `dynamomq`.
Expand Down

0 comments on commit 76284c2

Please sign in to comment.