Documentation
¶
Overview ¶
Package aws is the AWS notification package
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Credentials ¶
type Credentials struct {
ID string `yaml:"id" json:"id" jsonschema:"required,title=AWS Access Key ID,description=AWS Access Key ID"`
Secret string `yaml:"key" json:"key" jsonschema:"required,title=AWS Access Key Secret,description=AWS Access Key Secret"`
}
Credentials is AWS access id and access token
type NotifyConfig ¶ added in v1.9.0
type NotifyConfig struct {
Options `yaml:",inline"`
Format report.Format `` /* 201-byte string literal not displayed */
TopicARN string `yaml:"arn" json:"arn" jsonschema:"title=Topic ARN,description=The ARN of the SNS topic"`
// contains filtered or unexported fields
}
NotifyConfig is the AWS SNS notification configuration
func (*NotifyConfig) Config ¶ added in v1.9.0
func (c *NotifyConfig) Config(gConf global.NotifySettings) error
Config configures the slack notification
func (*NotifyConfig) SendSNS ¶ added in v1.9.0
func (c *NotifyConfig) SendSNS(title, msg string) error
SendSNS is the warp function of SendSNSNotification
func (*NotifyConfig) SendSNSNotification ¶ added in v1.9.0
func (c *NotifyConfig) SendSNSNotification(msg string) error
SendSNSNotification sends the message to SNS
type Options ¶
type Options struct {
base.DefaultNotify `yaml:",inline"`
Region string `yaml:"region" json:"region" jsonschema:"required,title=AWS Region ID,description=AWS Region ID,example=\"us-west-2\""`
Endpoint string `` /* 145-byte string literal not displayed */
Credentials Credentials `yaml:"credential" json:"credential" jsonschema:"required,title=AWS Credential,description=AWS Credential"`
Profile string `yaml:"profile,omitempty" json:"profile,omitempty" jsonschema:"title=AWS Profile,description=AWS Profile"`
// contains filtered or unexported fields
}
Options is AWS Configuration
Click to show internal directories.
Click to hide internal directories.