Skip to content

Commit

Permalink
chore(s3): update builder region doc
Browse files Browse the repository at this point in the history
  • Loading branch information
saiintbrisson committed May 9, 2023
1 parent af273fa commit 408a326
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions core/src/services/s3/backend.rs
Original file line number Diff line number Diff line change
Expand Up @@ -371,10 +371,12 @@ impl S3Builder {
self
}

/// Region represent the signing region of this endpoint.
/// Region represent the signing region of this endpoint. This is required
/// if you are using the default AWS S3 endpoint.
///
/// If using a custom endpoint,
/// - If region is set, we will take user's input first.
/// - If not, we will use `us-east-1` as default.
/// - If not, the default `us-east-1` will be used.
pub fn region(&mut self, region: &str) -> &mut Self {
if !region.is_empty() {
self.region = Some(region.to_string())
Expand Down

0 comments on commit 408a326

Please sign in to comment.