dynamodb

Documentation

Overview

SPDX-FileCopyrightText: 2021 Comcast Cable Communications Management, LLC SPDX-License-Identifier: Apache-2.0

SPDX-FileCopyrightText: 2021 Comcast Cable Communications Management, LLC SPDX-License-Identifier: Apache-2.0

Index

• Constants
• func NewDynamoDB(config Config, measures metric.Measures) (store.S, error)
• type Config

Constants

const DynamoDB = "dynamo"

DynamoDB is the path to the configuration structure needed to connect to a dynamo DB instance.

Functions

func NewDynamoDB

func NewDynamoDB(config Config, measures metric.Measures) (store.S, error)

Types

type Config

type Config struct {
	// Table is the name of the target DB table.
	// (Optional) Defaults to 'gifnoc'
	Table string

	// Endpoint is the HTTP(S) URL to the DB.
	// (Optional) Defaults to endpoint generated by the aws sdk.
	Endpoint string

	// Region is the AWS region of the running DB.
	Region string `validate:"required"`

	// MaxRetries is the number of times DB operations will be retried on error.
	// (Optional) Defaults to 3.
	MaxRetries int

	// GetAllLimit is the maximum number of items to get at a time.
	// (Optional) defaults to no limit
	GetAllLimit int

	// AccessKey is the AWS AccessKey credential.
	AccessKey string

	// SecretKey is the AWS SecretKey credential.
	SecretKey string

	// DisableDualStack indicates whether the connection to the DB should be
	// dual stack (IPv4 and IPv6).
	// (Optional) Defaults to False.
	DisableDualStack bool

	// If roleBasedAccess is enabled, accessKey and secretKey will be fetched using IAM temporary credentials
	RoleBasedAccess bool
}

Config contains all fields needed to establish a connection with a dynamoDB instance.