claws

Documentation

Overview

Package claws provides the official AWS SDK (v2)

Index

• func New(cfg Config, logs *zap.Logger, trp trace.TracerProvider, ...) (aws.Config, error)
• func Provide() fx.Option
• type Config
• type Logger
  • func NewLogger(logs *zap.Logger) *Logger
  • func (l Logger) Logf(classification logging.Classification, format string, v ...interface{})

Functions

func New

func New(
	cfg Config,
	logs *zap.Logger,
	trp trace.TracerProvider,
	txtp propagation.TextMapPropagator,
) (aws.Config, error)

New initialize an AWS config to be used to create clients for individual aws services. We would like run this during fx lifecycle phase to provide it with a context because it can block. But too many dependencies would have to wait for it.

func Provide

func Provide() fx.Option

Provide configures the DI for providng database connectivity.

Types

type Config

type Config struct {
	// LoadConfigTimeout bounds the time given to config loading
	LoadConfigTimeout time.Duration `env:"LOAD_CONFIG_TIMEOUT" envDefault:"100ms"`
	// OverwriteAccessKeyID can be set to overwrite regular credentials loading chain and just a static key/secret
	OverwriteAccessKeyID string `env:"OVERWRITE_ACCESS_KEY_ID"`
	// If OverwriteAccessKeyID this wil be used as the secret
	OverwriteSecretAccessKey string `env:"OVERWRITE_SECRET_ACCESS_KEY"`
	// If OverwriteAccessKeyID this wil be used as the session token
	OverwriteSessionToken string `env:"OVERWRITE_SESSION_TOKEN"`

	// enable logging of SDK retries
	LogRetries bool `env:"LOG_RETRIES" envDefault:"false"`
	// enable logging of SDK request
	LogRequest bool `env:"LOG_REQUEST" envDefault:"false"`
	// enable logging of SDK responses
	LogResponse bool `env:"LOG_RESPONSE" envDefault:"false"`
}

Config configures this package.

type Logger

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

logger implements AWS logging.Logger using zap.

func NewLogger

func NewLogger(logs *zap.Logger) *Logger

NewLogger creates a new logger for AWS SDK.

func (Logger) Logf

func (l Logger) Logf(classification logging.Classification, format string, v ...interface{})

Logf implements logging.Logger interface.