sns

Documentation

Overview

Package sns is for messaging with AWS SNS.

Index

• type SNS
  • func New() (SNS, error)
  • func NewWithMaxRetries(maxRetries int) (SNS, error)
  • func (s *SNS) CheckTopic(topicArn string) error
  • func (s *SNS) CreateTopic(topicName string, topicAttributes map[string]string) (string, error)
  • func (s *SNS) DeleteTopic(topicArn string) error
  • func (s *SNS) Publish(topicArn string, message []byte) error
  • func (s *SNS) Ready() bool
  • func (s *SNS) SubscribeQueue(topicArn string, queueArn string) (string, error)

Types

type SNS

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

func New

func New() (SNS, error)

New returns an SNS struct which wraps an SNS client using the default AWS credentials chain. This consults (in order) environment vars, config files, ec2 and ecs roles. Requests with recoverable errors will be retried with the default retrier. It is an error if the AWS_REGION environment variable is not set.

func NewWithMaxRetries

func NewWithMaxRetries(maxRetries int) (SNS, error)

NewWithMaxRetries returns the same as New(), but with the back off set to up to maxRetries times.

func (*SNS) CheckTopic

func (s *SNS) CheckTopic(topicArn string) error

CheckTopic checks if an SNS topic exists and is accessible given its ARN.

func (*SNS) CreateTopic

func (s *SNS) CreateTopic(topicName string, topicAttributes map[string]string) (string, error)

CreateTopic creates an SNS topic with the specified name. You can provide a map of topic attributes if needed (can be set to nil if not). Returns the ARN of the created topic.

func (*SNS) DeleteTopic

func (s *SNS) DeleteTopic(topicArn string) error

DeleteTopic delete an SNS topic.

func (*SNS) Publish

func (s *SNS) Publish(topicArn string, message []byte) error

Publish publishes message to topicArn.

func (*SNS) Ready

func (s *SNS) Ready() bool

Ready returns whether the SNS client has been initialised.

func (*SNS) SubscribeQueue

func (s *SNS) SubscribeQueue(topicArn string, queueArn string) (string, error)

SubscribeQueue subscribes an SQS queue to an SNS topic.