parameterstore

Documentation

Overview

Package parameterstore implements a koanf.Provider for AWS parameterstore and provides it to koanf to be parsed by a koanf.Parser.

Index

• type Config
• type PSConfig
  • func Provider(cfg Config, cb func(s string) string) *PSConfig
  • func ProviderWithClient(cfg Config, cb func(s string) string, client *ssm.Client) *PSConfig
  • func (ps *PSConfig) Read() (map[string]interface{}, error)
  • func (ps *PSConfig) ReadBytes() ([]byte, error)
  • func (ps *PSConfig) Watch(cb func(event interface{}, err error)) error

Types

type Config

type Config struct {
	// The AWS parameterstore Delim that might be used
	// delim string
	Delim string

	// The parameterstore name  to fetch
	// name of the parameter.
	Name string

	// The type of values secre value set, it can only be string or map.
	// if the value is type of app, each key is unfallten to create new
	// single var like: parent: {"child": "value"} -> parent.child = value
	Type string

	// The ParameterStore Configuration Version to fetch. Specifying a VersionId
	// ensures that the configuration is only fetched if it is updated. If not specified,
	// the latest available configuration is fetched always.
	// Setting this to the latest configuration version will return an empty slice of bytes.
	VersionId string

	// The AWS Access Key ID to use. This value is fetched from the environment
	// if not specified.
	AWSAccessKeyID string

	// The AWS Secret Access Key to use. This value is fetched from the environment
	// if not specified.
	AWSSecretAccessKey string

	// The AWS IAM Role ARN to use. Useful for access requiring IAM AssumeRole.
	AWSRoleARN string

	// The AWS Region to use. This value is fetched from teh environment if not specified.
	AWSRegion string

	// Time interval at which the watcher will refresh the configuration.
	// Defaults to 600 seconds.
	WatchInterval time.Duration
}

Config holds the AWS parameterstore Configuration.

type PSConfig

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

PSConfig implements an AWS ParameterStore provider.

func Provider

func Provider(cfg Config, cb func(s string) string) *PSConfig

Provider returns an AWS ParameterStore provider.

func ProviderWithClient

func ProviderWithClient(cfg Config, cb func(s string) string, client *ssm.Client) *PSConfig

ProviderWithClient returns an AWS ParameterStore provider using an existing AWS parameterstore client.

func (*PSConfig) Read

func (ps *PSConfig) Read() (map[string]interface{}, error)

Read is not supported by the ParameterStore provider.

func (*PSConfig) ReadBytes

func (ps *PSConfig) ReadBytes() ([]byte, error)

ReadBytes returns the raw bytes for parsing.

func (*PSConfig) Watch

func (ps *PSConfig) Watch(cb func(event interface{}, err error)) error

Watch polls AWS AppConfig for configuration updates.