Skip to content

Commit

Permalink
Update docs to reflect new flag for s3 bucket addressing style
Browse files Browse the repository at this point in the history
  • Loading branch information
EdwardDowling committed Jan 17, 2025
1 parent c4c42ec commit 5a4f54a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/pages/reference/backends.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -651,8 +651,8 @@ Service reads these parameters to configure its interactions with S3:
- `use_fips_endpoint=true` - [Configure S3 FIPS
endpoints](#configuring-aws-fips-endpoints)

- `use_s3_path_style` - Whether to use path-style instead of virtual-host-style URLs for the
bucket. Only applies when a custom endpoint is set. Defaults to true when unset. If used
- `use_s3_virtual_style_addressing` - Whether to use virtual-host-style instead of path-style URLs for the
bucket. Only applies when a custom endpoint is set. Defaults to false when unset. If used
without a custom endpoint set, this option has no effect.

### S3 IAM policy
Expand Down
5 changes: 5 additions & 0 deletions lib/events/s3sessions/s3handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,11 @@ type Config struct {
DisableServerSideEncryption bool

// UseVirtualStyleAddressing use a virtual-hosted–style URI.
// Path style e.g. https://s3.region-code.amazonaws.com/bucket-name/key-name
// Virtual hosted style e.g. https://bucket-name.s3.region-code.amazonaws.com/key-name
// Teleport defaults to path-style addressing for better interoperability
// with 3rd party S3-compatible services out of the box.
// See https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html for more details.
UseVirtualStyleAddressing bool
}

Expand Down

0 comments on commit 5a4f54a

Please sign in to comment.