Skip to content

Commit

Permalink
service/s3: Update hostCompatibleBucketName doc to reflect #848 chang…
Browse files Browse the repository at this point in the history
…es (#1683)

Updates the doc string for hostCompatibleBucketName adding link to the resolved Endpoint member driving the behavior.
  • Loading branch information
lggomez authored May 5, 2022
1 parent 55890a0 commit 11aebce
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions service/s3/internal/customizations/update_endpoint.go
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ type UpdateEndpointParameterAccessor struct {

// UpdateEndpointOptions provides the options for the UpdateEndpoint middleware setup.
type UpdateEndpointOptions struct {

// Accessor are parameter accessors used by the middleware
Accessor UpdateEndpointParameterAccessor

Expand Down Expand Up @@ -256,8 +255,11 @@ func removeBucketFromPath(u *url.URL, bucket string) {
}

// hostCompatibleBucketName returns true if the request should
// put the bucket in the host. This is false if S3ForcePathStyle is
// explicitly set or if the bucket is not DNS compatible.
// put the bucket in the host. This is false if the bucket is not
// DNS compatible or the EndpointResolver resolves an aws.Endpoint with
// HostnameImmutable member set to true.
//
// https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/aws#Endpoint.HostnameImmutable
func hostCompatibleBucketName(u *url.URL, bucket string) bool {
// Bucket might be DNS compatible but dots in the hostname will fail
// certificate validation, so do not use host-style.
Expand Down

0 comments on commit 11aebce

Please sign in to comment.