From fe66699249817b1e54772cde508bdd5835efc9f0 Mon Sep 17 00:00:00 2001 From: Ben Abrams Date: Wed, 5 Oct 2016 12:11:21 -0700 Subject: [PATCH] closes #1 Additional doc on using IAM as opposed to access keys. --- README.md | 4 ++-- config.yml.sample | 1 + 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0bef313..e05312b 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,8 @@ Options: Copy the example config file ``config.yml.sample`` to ``config.yml`` and fill in the configuration details. You will need AWS Credentials and are strongly encouraged to use an IAM user with access limited to -the AWS CloudWatch Events SQS queue. +the AWS CloudWatch Events SQS queue.You will need to specify the region +in the config even if you are using IAM Credentials. The app takes one arg '-c' that points at the config file. If -c is omitted it will look for the config file in the current directory. @@ -68,4 +69,3 @@ config.yml.sample for an example of the config. ### Limitations Currently only supports a single AWS region. - diff --git a/config.yml.sample b/config.yml.sample index c26f115..fdc544d 100644 --- a/config.yml.sample +++ b/config.yml.sample @@ -1,4 +1,5 @@ :aws: + # only region is required when using iam which is recommended :access_key_id: 'AWS Access Key' :secret_access_key: 'AWS Secret Access Key' :region: 'us-west-2'