config

Documentation

Index

• Constants
• Variables
• func AwsAccessKeyFromEnv(k string) (string, error)
• func LoadAwsConfig(access, secret, region string) (aws.Config, error)
• func LoadFromData[C any](data []byte) (*C, error)
• func LoadFromFile[C any](path string) (*C, error)
• func LoadFromS3[C any](client *s3.Client, bucket, key string) (*C, error)
• func RegionFromEnv(k string) (string, error)
• func SecretKeyFromEnv(k string) (string, error)
• type Config

Constants

const (
	DefaultAccessKeyEnvVar = "AWS_ACCESS_KEY_ID"
	DefaultSecretKeyEnvVar = "AWS_SECRET_ACCESS_KEY"
	DefaultRegionEnvVar    = "AWS_REGION"
)

Variables

var (
	ErrMissingAccessKey = errors.New("missing access key")
	ErrMissingSecretKey = errors.New("missing secret key")
	ErrMissingRegionKey = errors.New("missing region")
)

Functions

func AwsAccessKeyFromEnv

func AwsAccessKeyFromEnv(k string) (string, error)

func LoadAwsConfig

func LoadAwsConfig(access, secret, region string) (aws.Config, error)

func LoadFromData

func LoadFromData[C any](data []byte) (*C, error)

Loads the application config from a byte slice.

func LoadFromFile

func LoadFromFile[C any](path string) (*C, error)

Loads the application config from a file at the specified path.

func LoadFromS3

func LoadFromS3[C any](client *s3.Client, bucket, key string) (*C, error)

Loads the application config from an S3 bucket.

func RegionFromEnv

func RegionFromEnv(k string) (string, error)

func SecretKeyFromEnv

func SecretKeyFromEnv(k string) (string, error)

Types

type Config

type Config interface {
	Validate() error
}