dynamodb

Documentation

Overview

Package dynamodb provides utilities for working with DynamoDB tables, such as creating and deleting tables.

Index

• Constants
• func CreateDynamoDBClient(config *awshelper.AwsSessionConfig, ...) (*dynamodb.DynamoDB, error)
• func CreateLockTable(tableName string, tags map[string]string, client *dynamodb.DynamoDB, ...) error
• func CreateLockTableIfNecessary(tableName string, tags map[string]string, client *dynamodb.DynamoDB, ...) error
• func DeleteTable(tableName string, dbClient *dynamodb.DynamoDB) error
• func LockTableCheckSSEncryptionIsOn(tableName string, client *dynamodb.DynamoDB) (bool, error)
• func LockTableExistsAndIsActive(tableName string, client *dynamodb.DynamoDB) (bool, error)
• func UpdateLockTableSetSSEncryptionOnIfNecessary(tableName string, client *dynamodb.DynamoDB, ...) error
• func WaitForTableToBeActiveWithRandomSleep(tableName string, client *dynamodb.DynamoDB, maxRetries int, ...) error
• type CountingSemaphore
  • func NewCountingSemaphore(size int) CountingSemaphore
  • func (semaphore CountingSemaphore) Acquire()
  • func (semaphore CountingSemaphore) Release()
• type DeleteTableRetryer
  • func (retryer DeleteTableRetryer) ShouldRetry(req *request.Request) bool
• type TableActiveRetriesExceeded
  • func (err TableActiveRetriesExceeded) Error() string
• type TableDoesNotExist
  • func (err TableDoesNotExist) Error() string
• type TableEncryptedRetriesExceeded
  • func (err TableEncryptedRetriesExceeded) Error() string

Constants

const AttrLockID = "LockID"

AttrLockID is the name of the primary key for the lock table in DynamoDB. OpenTofu/Terraform requires the DynamoDB table to have a primary key with this name

const DynamodbPayPerRequestBillingMode = "PAY_PER_REQUEST"

DynamodbPayPerRequestBillingMode is the billing mode for DynamoDB tables that allows for pay-per-request billing instead of provisioned capacity.

const MaxRetriesWaitingForTableToBeActive = 30

MaxRetriesWaitingForTableToBeActive is the maximum number of times we will retry waiting for a table to be active.

Default is to retry for up to 5 minutes

const SleepBetweenTableStatusChecks = 10 * time.Second

SleepBetweenTableStatusChecks is the amount of time we will sleep between checks to see if a table is active.

Functions

func CreateDynamoDBClient

func CreateDynamoDBClient(config *awshelper.AwsSessionConfig, terragruntOptions *options.TerragruntOptions) (*dynamodb.DynamoDB, error)

CreateDynamoDBClient creates an authenticated client for DynamoDB.

func CreateLockTable

func CreateLockTable(tableName string, tags map[string]string, client *dynamodb.DynamoDB, terragruntOptions *options.TerragruntOptions) error

CreateLockTable creates a lock table in DynamoDB and wait until it is in "active" state. If the table already exists, merely wait until it is in "active" state.

func CreateLockTableIfNecessary

func CreateLockTableIfNecessary(tableName string, tags map[string]string, client *dynamodb.DynamoDB, terragruntOptions *options.TerragruntOptions) error

CreateLockTableIfNecessary creates the lock table in DynamoDB if it doesn't already exist.

func DeleteTable

func DeleteTable(tableName string, dbClient *dynamodb.DynamoDB) error

DeleteTable deletes the given table in DynamoDB.

func LockTableCheckSSEncryptionIsOn

func LockTableCheckSSEncryptionIsOn(tableName string, client *dynamodb.DynamoDB) (bool, error)

LockTableCheckSSEncryptionIsOn returns true if the lock table's SSEncryption is turned on

func LockTableExistsAndIsActive

func LockTableExistsAndIsActive(tableName string, client *dynamodb.DynamoDB) (bool, error)

LockTableExistsAndIsActive returns true if the lock table exists in DynamoDB and is in "active" state.

func UpdateLockTableSetSSEncryptionOnIfNecessary

func UpdateLockTableSetSSEncryptionOnIfNecessary(tableName string, client *dynamodb.DynamoDB, terragruntOptions *options.TerragruntOptions) error

UpdateLockTableSetSSEncryptionOnIfNecessary encrypts the TFState Lock table - If Necessary

func WaitForTableToBeActiveWithRandomSleep

func WaitForTableToBeActiveWithRandomSleep(tableName string, client *dynamodb.DynamoDB, maxRetries int, sleepBetweenRetriesMin time.Duration, sleepBetweenRetriesMax time.Duration, terragruntOptions *options.TerragruntOptions) error

WaitForTableToBeActiveWithRandomSleep waits for the given table as described above, but sleeps a random amount of time greater than sleepBetweenRetriesMin and less than sleepBetweenRetriesMax between tries. This is to avoid an AWS issue where all waiting requests fire at the same time, which continually triggered AWS's "subscriber limit exceeded" API error.

Types

type CountingSemaphore

type CountingSemaphore chan empty

func NewCountingSemaphore

func NewCountingSemaphore(size int) CountingSemaphore

NewCountingSemaphore is a bare-bones counting semaphore implementation based on: http://www.golangpatterns.info/concurrency/semaphores

func (CountingSemaphore) Acquire

func (semaphore CountingSemaphore) Acquire()

func (CountingSemaphore) Release

func (semaphore CountingSemaphore) Release()

type DeleteTableRetryer

type DeleteTableRetryer struct {
	client.DefaultRetryer
}

func (DeleteTableRetryer) ShouldRetry

func (retryer DeleteTableRetryer) ShouldRetry(req *request.Request) bool

type TableActiveRetriesExceeded

type TableActiveRetriesExceeded struct {
	TableName string
	Retries   int
}

func (TableActiveRetriesExceeded) Error

func (err TableActiveRetriesExceeded) Error() string

type TableDoesNotExist

type TableDoesNotExist struct {
	TableName  string
	Underlying error
}

func (TableDoesNotExist) Error

func (err TableDoesNotExist) Error() string

type TableEncryptedRetriesExceeded

type TableEncryptedRetriesExceeded struct {
	TableName string
	Retries   int
}

func (TableEncryptedRetriesExceeded) Error

func (err TableEncryptedRetriesExceeded) Error() string