Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve s3 format examples in README #394

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -354,11 +354,27 @@ S3 has several addressing schemes used to reference your bucket. These are
listed here: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-bucket-intro.html

Some examples for these addressing schemes:
- s3::https://s3.amazonaws.com/bucket/foo
- s3::https://s3-eu-west-1.amazonaws.com/bucket/foo
- bucket.s3.amazonaws.com/foo
- bucket.s3-eu-west-1.amazonaws.com/foo/bar
- "s3::http://127.0.0.1:9000/test-bucket/hello.txt?aws_access_key_id=KEYID&aws_access_key_secret=SECRETKEY&region=us-east-2"
- virtual-host style without http protocol prefix
- bucket.s3.amazonaws.com/foo
- bucket.s3-eu-west-1.amazonaws.com/foo/bar
- path-based style without http protocol prefix
- s3.eu-west-1.amazonaws.com/bucket/bar
- s3 protocol
- s3://s3.amazonaws.com/bucket/foo
- forced protocol without http protocol prefix
- s3::s3.amazonaws.com/bucket/foo
- s3::s3-eu-west-1.amazonaws.com/bucket/foo
- forced protocol with http protocol prefix
- s3::https://s3.amazonaws.com/bucket/foo
- s3::https://s3-eu-west-1.amazonaws.com/bucket/foo
- "s3::http://127.0.0.1:9000/test-bucket/hello.txt?aws_access_key_id=KEYID&aws_access_key_secret=SECRETKEY&region=us-east-2"


Unsupported formats (will _not_ work)
- virtual-host style with http protocol prefix
- https://bucket.s3.amazonaws.com/foo
- path-based style with http protocol prefix
- https://bucket.s3-eu-west-1.amazonaws.com/foo/bar

### GCS (`gcs`)

Expand Down