Skip to content

Commit

Permalink
Adds note about Amazon S3 access points (#364)
Browse files Browse the repository at this point in the history
  • Loading branch information
markjschreiber authored Jan 22, 2024
1 parent 84d88cd commit 1f61877
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,16 @@ export S3_SPI_ENDPOINT_PROTOCOL=http
java -Ds3.spi.endpoint-protocol=http
```

## Amazon S3 Access Points

[Access points](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html) are named network endpoints that are attached to buckets that you can use to perform S3 object operations.
To perform an operation via an access point using this library you will need to use the [access point alias](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-alias.html)
as the access point arn is not a valid URI and cannot be used to form a Java `Path`.

### Limitations
- Not all S3 operations are [supported when using access links](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points-alias.html). If you notice a feature of this library that cannot be used via an access point please file an issue with this repository explaining your use case.
- Your actions may be additionally limited by policies present on the access point that are not present on the bucket

## Reading Files

Bytes from S3 objects can be read using an `S3SeekableByteChannel` which is an implementation of `java.nio.channel.SeekableByteChannel`.
Expand Down

0 comments on commit 1f61877

Please sign in to comment.