awsbase

README

aws-sdk-go-base

An opinionated AWS SDK for Go v2 library for consistent authentication configuration between projects plus additional helper functions. This library was originally started in HashiCorp Terraform, migrated with the Terraform AWS Provider during the Terraform 0.10 Core and Provider split, and now is offered as a separate library to allow easier dependency management in the Terraform ecosystem.

NOTE: This library is not currently designed or intended for usage outside the Terraform S3 Backend, the Terraform AWS Provider, and the Terraform AWS Cloud Control Provider.

This project publishes two Go modules, aws-sdk-go-base/v2 and aws-sdk-go-base/v2/awsv1shim/v2. The module aws-sdk-go-base/v2 returns configuration compatible with the AWS SDK for Go v2. In order to assist with migrating large code bases using the AWS SDK for Go v1, the module aws-sdk-go-base/v2/awsv1shim/v2 takes the AWS SDK for Go v2 configuration and returns configuration for the AWS SDK for Go v1.

Requirements

• Go 1.16

Development

Running make test will test both aws-sdk-go-base/v2 and aws-sdk-go-base/v2/awsv1shim/v2. To test individual cases, go test works as well, but be aware that it only works in the current module. To test both modules, run:

$ go test -v ./...
$ cd v2/awsv1shim && go test -v ./...

Code is validated using golangci-lint for general code quality, impi for import block formatting, and Semgrep to validate additional rules.

golangci-lint and impi are Go tools, and can be installed using either make tools or installing the Go packages. Installing the packages from the tools directory will ensure that you are using the expected version. Semgrep can be installed as described in the documentation or using a Docker container.

Validation can be run using make lint to run golangci-lint and impi. make semgrep will run Semgrep using a Docker container.

If running linters directly, be aware that golangci-lint will only run for the current module. To validate both modules, run:

$ golangci-lint run ./...
$ cd v2/awsv1shim && golangci-lint run ./...

Release Process

The two modules can be released separately. If changes are only made to awsv1shim, aws-sdk-go-base should not be released. However, if changes are made to aws-sdk-go-base, both modules should be released.

1. If creating a new release of aws-sdk-go-base
   1. Update the reference in the awsv1shim go.mod file
   2. Run go mod tidy
2. Update the CHANGELOG.md file
3. Push the updated files to GitHub
4. Push new version tags to GitHub. For more details on Go module versioning, see https://go.dev/doc/modules/version-numbers. (Commands git tag -a -m "" <version tag>, git push --tags)
   • For aws-sdk-go-base, use the form vX.Y.Z
   • For awsv1shim, use the form v2/awsv1shim/vX.Y.Z
5. Close the associated GitHub milestone
6. Create the releases on GitHub

Documentation

Index

• Constants
• func EC2MetadataEndpointMode_Values() []string
• func GetAwsAccountIDAndPartition(ctx context.Context, awsConfig aws.Config, c *Config) (string, string, error)
• func GetAwsConfig(ctx context.Context, c *Config) (aws.Config, error)
• func IsCannotAssumeRoleError(err error) bool
• func IsNoValidCredentialSourcesError(err error) bool
• func ValidateRegion(region string) error
• type APNInfo
• type AssumeRole
• type CannotAssumeRoleError
• type Config
• type InvalidRegionError
  • func (e *InvalidRegionError) Error() string
• type NoValidCredentialSourcesError
• type UserAgentProduct
• type UserAgentProducts

Constants

const (
	EC2MetadataEndpointModeIPv4 = "IPv4"
	EC2MetadataEndpointModeIPv6 = "IPv6"
)

Functions

func EC2MetadataEndpointMode_Values

func EC2MetadataEndpointMode_Values() []string

func GetAwsAccountIDAndPartition

func GetAwsAccountIDAndPartition(ctx context.Context, awsConfig aws.Config, c *Config) (string, string, error)

func GetAwsConfig

func GetAwsConfig(ctx context.Context, c *Config) (aws.Config, error)

func IsCannotAssumeRoleError

func IsCannotAssumeRoleError(err error) bool

IsCannotAssumeRoleError returns true if the error contains the CannotAssumeRoleError type.

func IsNoValidCredentialSourcesError

func IsNoValidCredentialSourcesError(err error) bool

IsNoValidCredentialSourcesError returns true if the error contains the NoValidCredentialSourcesError type.

func ValidateRegion

func ValidateRegion(region string) error

ValidateRegion checks if the given region is a valid AWS region.

Types

type APNInfo

type APNInfo = config.APNInfo

type AssumeRole

type AssumeRole = config.AssumeRole

type CannotAssumeRoleError

type CannotAssumeRoleError = config.CannotAssumeRoleError

CannotAssumeRoleError occurs when AssumeRole cannot complete.

type Config

type Config = config.Config

type InvalidRegionError

type InvalidRegionError struct {
	// contains filtered or unexported fields
}

func (*InvalidRegionError) Error

func (e *InvalidRegionError) Error() string

type NoValidCredentialSourcesError

type NoValidCredentialSourcesError = config.NoValidCredentialSourcesError

NoValidCredentialSourcesError occurs when all credential lookup methods have been exhausted without results.

type UserAgentProduct

type UserAgentProduct = config.UserAgentProduct

type UserAgentProducts

type UserAgentProducts = config.UserAgentProducts