config

Documentation

Index

• Constants
• Variables
• type AWSConfig
  • func AWSConfigCredentialsSet(set *goauth.CredentialsSet, key string) (*AWSConfig, error)
  • func AWSConfigCredentialsSetFile(filename, key string) (*AWSConfig, error)
  • func AWSConfigMoreCredentialsBasic(creds *goauth.Credentials) (*AWSConfig, error)
  • func NewAWSConfigStatic(region, accessKeyID, accessKeySecret string) *AWSConfig
  • func (cfg AWSConfig) ClientParams() (client.ConfigProvider, []*aws.Config, error)
  • func (cfg AWSConfig) Config() *aws.Config
  • func (cfg AWSConfig) ConfigV2(ctx context.Context) (aws2.Config, error)
  • func (cfg AWSConfig) NewSession() (*session.Session, error)
  • func (cfg AWSConfig) RegionOrDefault() string

Constants

const (
	CredentialsTypeEnvironment = "environment" // uses AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN (optional)
	CredentialsTypeShared      = "shared"
	CredentialsTypeStatic      = "static"

	RegionUSEast1 = "us-east-1"
	RegionUSWest1 = "us-west-1"
	RegionDefault = RegionUSEast1 // from AWS: "If you don’t select a region, then us-east-1 will be used by default." https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/setup-credentials.html
)

Variables

var ErrAWSConfigCannotBeNil = errors.New("config.AWSConfig cannot be nil")

Types

type AWSConfig

type AWSConfig struct {
	CredentialsType string
	SharedProfile   string // `.aws/credentials`
	StaticID        string
	StaticSecret    string
	StaticToken     string // optional per https://docs.aws.amazon.com/sdk-for-go/api/aws/session/
	Endpoint        string
	Region          string
	PathStyleForce  bool
}

AWSConfig handles credentials from https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html

func AWSConfigCredentialsSet

func AWSConfigCredentialsSet(set *goauth.CredentialsSet, key string) (*AWSConfig, error)

func AWSConfigCredentialsSetFile

func AWSConfigCredentialsSetFile(filename, key string) (*AWSConfig, error)

func AWSConfigMoreCredentialsBasic

func AWSConfigMoreCredentialsBasic(creds *goauth.Credentials) (*AWSConfig, error)

func NewAWSConfigStatic

func NewAWSConfigStatic(region, accessKeyID, accessKeySecret string) *AWSConfig

func (AWSConfig) ClientParams

func (cfg AWSConfig) ClientParams() (client.ConfigProvider, []*aws.Config, error)

ClientParams returns the params used to set up a service.

func (AWSConfig) Config

func (cfg AWSConfig) Config() *aws.Config

func (AWSConfig) ConfigV2

func (cfg AWSConfig) ConfigV2(ctx context.Context) (aws2.Config, error)

func (AWSConfig) NewSession

func (cfg AWSConfig) NewSession() (*session.Session, error)

func (AWSConfig) RegionOrDefault

func (cfg AWSConfig) RegionOrDefault() string