Documentation
¶
Overview ¶
Package awsopt configures the aws-sdk-go-v2 library consistently across multiple AWS service clients. It centralizes config.LoadOptionsFunc calls into a composable Options slice that can be built once and handed to any AWS-based package in this library.
How It Works ¶
Options is a typed slice of config.LoadOptionsFunc values. Options are accumulated with method calls and then materialized into an aws.Config via Options.LoadDefaultConfig, which delegates to the standard config.LoadDefaultConfig from the SDK:
- Create an Options value (zero value is ready to use).
- Append options with Options.WithAWSOption, Options.WithRegion, or Options.WithRegionFromURL.
- Call Options.LoadDefaultConfig to obtain an aws.Config that can be passed directly to any aws-sdk-go-v2 service constructor.
Integrated Packages ¶
awsopt is used as the AWS configuration layer by:
- github.com/tecnickcom/nurago/pkg/awssecretcache
- github.com/tecnickcom/nurago/pkg/s3
- github.com/tecnickcom/nurago/pkg/sqs
Usage ¶
var opts awsopt.Options
opts.WithRegionFromURL("https://s3.eu-west-1.amazonaws.com", "")
awsCfg, err := opts.LoadDefaultConfig(ctx)
if err != nil {
return err
}
// awsCfg is ready for any aws-sdk-go-v2 service client:
// s3.NewFromConfig(awsCfg), secretsmanager.NewFromConfig(awsCfg), …
When consuming an awsopt-based package, pass additional options via the package's own WithAWSOptions helper so all AWS clients in the process share consistent configuration.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Options ¶
type Options []config.LoadOptionsFunc
Options is a set of all AWS options to apply.
An Options value is not safe for concurrent modification: build it from a single goroutine with the With* methods, then share the finished value read-only (for example by passing it to a consuming package's WithAWSOptions).
func (*Options) LoadDefaultConfig ¶
LoadDefaultConfig builds an aws.Config from the accumulated options.
It turns one shared Options value into an SDK configuration in a single call, delegating to the SDK's config.LoadDefaultConfig. This keeps region, credentials, and any custom SDK loaders consistent across packages that consume awsopt.
func (*Options) WithAWSOption ¶
func (c *Options) WithAWSOption(opt config.LoadOptionsFunc)
WithAWSOption appends any raw aws-sdk-go-v2 load option.
Use it as the escape hatch for an SDK feature that has no dedicated helper in this package.
func (*Options) WithRegion ¶
WithRegion appends an explicit AWS region option.
Use it when the region is already known. Every downstream AWS client built from the same Options value uses this region.
func (*Options) WithRegionFromURL ¶
WithRegionFromURL appends a region derived from an AWS endpoint URL.
The region is the right-most host label that looks like an AWS region code. This is partition-agnostic (it does not depend on the DNS suffix), so every endpoint form works, including future partitions, with no code changes:
https://sqs.eu-west-1.amazonaws.com -> eu-west-1 (standard) https://ec2.us-west-2.api.aws -> us-west-2 (dual-stack) https://sqs.cn-north-1.amazonaws.com.cn -> cn-north-1 (China) https://sqs.us-iso-east-1.c2s.ic.gov -> us-iso-east-1 (ISO) https://vpce-0abc.sqs.us-east-1.vpce.amazonaws.com -> us-east-1 (VPC endpoint)
The scheme is optional, matching is case-insensitive, and userinfo, port, and path are ignored (only the host is inspected). Scanning right-to-left means a region-shaped label further left (such as a bucket named like a region in "bucket.s3.eu-west-1.amazonaws.com") does not shadow the real region.
The region must be its own dot-separated host label. Endpoints that fold the region into a larger label are not recognized and fall back, notably the dash-style S3 website endpoint "bucket.s3-website-us-east-1.amazonaws.com" (the dot-style "bucket.s3-website.us-east-1.amazonaws.com" works).
Because it is partition-agnostic, the host is not verified to be AWS-owned, so a non-AWS URL that happens to carry a region-shaped label yields that region. Pass a genuine AWS endpoint.
When the URL carries no region, defaultRegion is used if it is non-empty. Otherwise no region option is added at all: region resolution is left to the SDK's config.LoadDefaultConfig, which applies AWS's canonical precedence (AWS_REGION, then AWS_DEFAULT_REGION, then the shared config file ~/.aws/config, then EC2 IMDS). It only pins a region when it has an explicit one (from the URL or defaultRegion) and otherwise defers to the SDK rather than substituting a hardcoded default.
Source Files