Skip to content

Commit

Permalink
Update the .env.example and readme with information on the STS sessio…
Browse files Browse the repository at this point in the history
…n token support.
  • Loading branch information
patrickcarlohickman committed Jun 29, 2020
1 parent 07dd2f8 commit 3493a99
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# >= 5.1
SQS_KEY=
SQS_SECRET=
SQS_TOKEN=
SQS_PREFIX=
SQS_QUEUE=
SQS_REGION=

# < 5.1
# SQS_KEY=
# SQS_SECRET=
# SQS_TOKEN=
# SQS_QUEUE=
# SQS_REGION=

# Alternate credential keys
# AWS_ACCESS_KEY_ID=
# AWS_SECRET_ACCESS_KEY=
# AWS_SECRET_ACCESS_KEY=
# AWS_SESSION_TOKEN=
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,10 @@ $app->instance('queue', $queue->getQueueManager());

The `key` and `secret` config options may be omitted if using one of the alternative options for providing AWS credentials (e.g. using an AWS credentials file). More informataion about this is available in the [AWS PHP SDK guide here](https://docs.aws.amazon.com/aws-sdk-php/v3/guide/guide/credentials.html).

#### AWS STS Session Token

The `'token' => env('AWS_SESSION_TOKEN'),` config option may be added if you need to specify an AWS STS temporary session token in the config. This is needed for some specific environments, such as AWS Lambda.

## Usage

For the most part, usage of this queue driver is the same as the built in queue drivers. There are, however, a few extra things to consider when working with Amazon's SQS FIFO queues.
Expand Down

0 comments on commit 3493a99

Please sign in to comment.