config

Documentation

Index

• func Load(ctx context.Context, config interface{}, options Options) error
• type DataStore
• type DataType
• type Options

Functions

func Load

func Load(ctx context.Context, config interface{}, options Options) error

Load loads the config data based on the options parameter and parsed into the config parameter.

Types

type DataStore

type DataStore int

DataStore represents the different places where the data is stored.

const (
	DataStoreLocal DataStore = iota
	DataStoreSecretsManager
)

type DataType

type DataType int

DataType represents the different possible types of data that is stored.

const (
	DataTypeJSON DataType = iota
)

type Options

type Options struct {
	// DataStore represents the different places where the data is stored.
	DataStore DataStore
	// DataType represents the different possible types of data that is stored.
	DataType DataType
	// Location can represent the following depending on the DataStore property.
	//
	// * DataStoreLocal: The path to the locally stored file.
	// * DataStoreSecretsManager: The ARN of the SecretsManager secret.
	Location string
	// SecretsManagerClient is the AWS SDK client used to interact with SecretsManager.
	// This property is required when the DataStore property is set to DataStoreSecretsManager.
	SecretsManagerClient *secretsmanager.Client
}