appconfig

Documentation

Overview

Package appconfig loads configuration from AWS AppConfig.

It requires following permissions to access AWS AppConfig:

• appconfig:StartConfigurationSession
• appconfig:GetLatestConfiguration

If change notification is enabled, it also requires following permissions:

• appconfig:GetApplication
• appconfig:GetEnvironment

Change notification

By default, it periodically polls the configuration only. It also listens to change events by register it to SNS notifier with one of following extensions:

• EventBridge extension With SNS target
• SNS extension

Only ON_DEPLOYMENT_ROLLED_BACK events trigger polling the configuration and other type of events are ignored.

Index

• type AppConfig
  • func New(application, environment, profile string, opts ...Option) *AppConfig
  • func (a *AppConfig) Load() (map[string]any, error)
  • func (a *AppConfig) OnEvent(msg []byte) error
  • func (a *AppConfig) Status(onStatus func(bool, error))
  • func (a *AppConfig) String() string
  • func (a *AppConfig) Watch(ctx context.Context, onChange func(map[string]any)) error
• type Option
  • func WithAWSConfig(config aws.Config) Option
  • func WithPollInterval(interval time.Duration) Option
  • func WithUnmarshal(unmarshal func([]byte, any) error) Option

Types

type AppConfig

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

AppConfig is a Provider that loads configuration from AWS AppConfig.

To create a new AppConfig, call New.

func New

func New(application, environment, profile string, opts ...Option) *AppConfig

New creates an AppConfig with the given application (ID or Name), environment (ID or Name), profile (ID or Name) and Option(s).

func (*AppConfig) Load

func (a *AppConfig) Load() (map[string]any, error)

func (*AppConfig) OnEvent

func (a *AppConfig) OnEvent(msg []byte) error

func (*AppConfig) Status

func (a *AppConfig) Status(onStatus func(bool, error))

func (*AppConfig) String

func (a *AppConfig) String() string

func (*AppConfig) Watch

func (a *AppConfig) Watch(ctx context.Context, onChange func(map[string]any)) error

type Option

type Option func(options *options)

Option configures the a AppConfig with specific options.

func WithAWSConfig

func WithAWSConfig(config aws.Config) Option

WithAWSConfig provides the AWS Config for the AWS SDK.

By default, it loads the default AWS Config.

func WithPollInterval

func WithPollInterval(interval time.Duration) Option

WithPollInterval provides the interval for polling the configuration. The minimum interval required by AWS AppConfig SDK is 15 seconds.

The default interval is 1 minute.

func WithUnmarshal

func WithUnmarshal(unmarshal func([]byte, any) error) Option

WithUnmarshal provides the function used to parses the configuration. The unmarshal function must be able to unmarshal the configuration into a map[string]any.

The default function is json.Unmarshal.