Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mars-lan authored Oct 9, 2024
1 parent 42168e3 commit 3b2ae56
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion metaphor/s3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,29 @@ This connector extracts technical metadata from a S3 compatible object storage.

## Setup

You must specify an AWS user credential to access S3 API. You can also specify a role ARN and let the connector assume the role before accessing AWS APIs.
We recommend creating a dedicated AWS IAM user for the crawler with limited permissions based on the following IAM policy:

```json
{
"Version": "2012-10-17",
"Statement":
[
{
"Effect": "Allow",
"Action":
[
"s3:GetObject",
"s3:ListBucket"
],
"Resource":
[
"arn:aws:s3:::<bucket>",
"arn:aws:s3:::<bucket>/*"
]
}
]
}
```

## Config File

Expand Down

0 comments on commit 3b2ae56

Please sign in to comment.