Add documentation for IAM role authentication

Signed-off-by: Kiera Jost <kjost@splunk.com>
2021-08-06 14:59:14 -06:00
parent 2d7bf1c6b0
commit fdece1f716
4 changed files with 18 additions and 6 deletions
@@ -26,3 +26,15 @@ awsS3:

 Then make sure the environment variables `AWS_ACCESS_KEY_ID` and
 `AWS_SECRET_ACCESS_KEY` are set when you run Backstage.
+
+Users with multiple AWS accounts may want to use a role for S3 storage that is
+in a different AWS account. Using the roleArn parameter as seen below, you can
+instruct the AWS S3 reader to assume a role before accessing S3:
+
+```yaml
+awsS3:
+  - host: amazonaws.com
+    accessKeyId: ${AWS_ACCESS_KEY_ID}
+    secretAccessKey: ${AWS_SECRET_ACCESS_KEY}
+    roleArn: 'arn:aws:iam::xxxxxxxxxxxx:role/example-role'
+```