dynamo

Documentation

Index

• type Dynamo
  • func New(opts ...Option) (*Dynamo, error)
  • func (d *Dynamo) Create(ctx context.Context, table *dynamodb.CreateTableInput) error
• type Option
  • func Credentials(accessKey, secretKey string) Option
  • func Endpoint(endpoint string) Option
  • func GeneralDelay(generalDelay time.Duration) Option
  • func HumanTableName(humanTableName string) Option
  • func MaxDynamoActionWait(max time.Duration) Option
  • func MaxDynamoResponseWait(max time.Duration) Option
  • func MaxWaitForDynamo(max time.Duration) Option
  • func Region(region string) Option
  • func Stdout(stdout io.Writer) Option
  • func Verbosity(verbosity int) Option

Types

type Dynamo

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

func New

func New(opts ...Option) (*Dynamo, error)

New creates a new ArgusDynamodb instance

func (*Dynamo) Create

func (d *Dynamo) Create(ctx context.Context, table *dynamodb.CreateTableInput) error

Create creates a new DynamoDB table, or replaces an existing table.

type Option

type Option interface {
	// contains filtered or unexported methods
}

func Credentials

func Credentials(accessKey, secretKey string) Option

Credentials sets the access and secret keys for the dynamo package.

func Endpoint

func Endpoint(endpoint string) Option

Endpoint sets the endpoint for the dynamo package.

func GeneralDelay

func GeneralDelay(generalDelay time.Duration) Option

GeneralDelay sets the general delay between actions.

The default is 10 milliseconds.

func HumanTableName

func HumanTableName(humanTableName string) Option

HumanTableName sets the human readable table name.

func MaxDynamoActionWait

func MaxDynamoActionWait(max time.Duration) Option

MaxDynamoActionWait sets the maximum time to wait for an action to complete.

The default is 5 seconds.

func MaxDynamoResponseWait

func MaxDynamoResponseWait(max time.Duration) Option

MaxDynamoResponseWait sets the maximum time to wait for a response from DynamoDB.

The default is 20 microseconds.

func MaxWaitForDynamo

func MaxWaitForDynamo(max time.Duration) Option

MaxWaitForDynamo sets the maximum time to wait for DynamoDB to be ready.

The default is 10 seconds.

func Region

func Region(region string) Option

Region sets the region for the dynamo package.

func Stdout

func Stdout(stdout io.Writer) Option

Stdout sets the writer for stdout.

func Verbosity

func Verbosity(verbosity int) Option

Verbosity sets the verbosity level for the dynamo package.