Skip to content

Commit

Permalink
Improve docs for AmazonS3Builder::from_env (#6977)
Browse files Browse the repository at this point in the history
* Improve docs for `AmazonS3Builder::from_env`

* wording

* Update object_store/src/aws/builder.rs

---------

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
  • Loading branch information
kylebarron and alamb authored Jan 15, 2025
1 parent 90d77bd commit 12a1235
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion object_store/src/aws/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -427,14 +427,19 @@ impl AmazonS3Builder {

/// Fill the [`AmazonS3Builder`] with regular AWS environment variables
///
/// Variables extracted from environment:
/// All environment variables starting with `AWS_` will be evaluated. Names must
/// match acceptable input to [`AmazonS3ConfigKey::from_str`]. Only upper-case environment
/// variables are accepted.
///
/// Some examples of variables extracted from environment:
/// * `AWS_ACCESS_KEY_ID` -> access_key_id
/// * `AWS_SECRET_ACCESS_KEY` -> secret_access_key
/// * `AWS_DEFAULT_REGION` -> region
/// * `AWS_ENDPOINT` -> endpoint
/// * `AWS_SESSION_TOKEN` -> token
/// * `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` -> <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html>
/// * `AWS_ALLOW_HTTP` -> set to "true" to permit HTTP connections without TLS
/// * `AWS_REQUEST_PAYER` -> set to "true" to permit operations on requester-pays buckets.
/// # Example
/// ```
/// use object_store::aws::AmazonS3Builder;
Expand Down

0 comments on commit 12a1235

Please sign in to comment.