sns

Documentation

Index

• Constants
• type Config
  • func NewConfig(jsonData json.RawMessage, decryptFn receivers.DecryptFunc) (Config, error)
• type Notifier
  • func New(cfg Config, meta receivers.Metadata, template *templates.Template, ...) *Notifier
  • func (s *Notifier) Notify(ctx context.Context, as ...*types.Alert) (bool, error)
  • func (s *Notifier) SendResolved() bool
• type SigV4Config

Constants

const FullValidConfigForTesting = `` /* 480-byte string literal not displayed */

FullValidConfigForTesting is a string representation of a JSON object that contains all fields supported by the notifier Config. It can be used without secrets.

const FullValidSecretsForTesting = `{
	"sigv4.access_key": "secret-access-key",
	"sigv4.secret_key": "secret-secret-key"
}`

FullValidSecretsForTesting is a string representation of JSON object that contains all fields that can be overridden from secrets

Types

type Config

type Config struct {
	APIUrl      string            `yaml:"api_url,omitempty" json:"api_url,omitempty"`
	Sigv4       SigV4Config       `yaml:"sigv4" json:"sigv4"`
	TopicARN    string            `yaml:"topic_arn,omitempty" json:"topic_arn,omitempty"`
	PhoneNumber string            `yaml:"phone_number,omitempty" json:"phone_number,omitempty"`
	TargetARN   string            `yaml:"target_arn,omitempty" json:"target_arn,omitempty"`
	Subject     string            `yaml:"subject,omitempty" json:"subject,omitempty"`
	Message     string            `yaml:"message,omitempty" json:"message,omitempty"`
	Attributes  map[string]string `yaml:"attributes,omitempty" json:"attributes,omitempty"`
}

func NewConfig

func NewConfig(jsonData json.RawMessage, decryptFn receivers.DecryptFunc) (Config, error)

type Notifier

type Notifier struct {
	*receivers.Base
	// contains filtered or unexported fields
}

Notifier is responsible for sending alert notifications to Amazon SNS.

func New

func New(cfg Config, meta receivers.Metadata, template *templates.Template, logger logging.Logger) *Notifier

func (*Notifier) Notify

func (s *Notifier) Notify(ctx context.Context, as ...*types.Alert) (bool, error)

Notify sends the alert notification to sns.

func (*Notifier) SendResolved

func (s *Notifier) SendResolved() bool

type SigV4Config

type SigV4Config struct {
	Region    string `json:"region,omitempty" yaml:"region,omitempty"`
	AccessKey string `json:"access_key,omitempty" yaml:"access_key,omitempty"`
	SecretKey string `json:"secret_key,omitempty" yaml:"secret_key,omitempty"`
	Profile   string `json:"profile,omitempty" yaml:"profile,omitempty"`
	RoleARN   string `json:"role_arn,omitempty" yaml:"role_arn,omitempty"`
}