v2

Documentation

Overview

Package v2 provides a wrapper for publishing messages to AWS SNS. Implementations in this package also include distributed tracing capabilities by default.

Index

• type Publisher
  • func New(api snsiface.SNSAPI) (Publisher, error)
  • func (p Publisher) Publish(ctx context.Context, input *sns.PublishInput) (messageID string, err error)

Examples

• Publisher

Types

type Publisher

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

Publisher is an implementation of the Publisher interface with added distributed tracing capabilities.

Example

// Create the SNS API with the required config, credentials, etc.
sess, err := session.NewSession(
	aws.NewConfig().
		WithEndpoint("http://localhost:4575").
		WithRegion("eu-west-1").
		WithCredentials(
			credentials.NewStaticCredentials("aws-id", "aws-secret", "aws-token"),
		),
)
if err != nil {
	log.Fatal(err)
}

api := sns.New(sess)

// Create the publisher
pub, err := New(api)
if err != nil {
	log.Fatal(err)
}

input := &sns.PublishInput{
	Message:   aws.String("my message"),
	TargetArn: nil, TopicArn: aws.String("arn:aws:sns:eu-west-1:123456789012:MyTopic"),
}

// Publish it
msgID, err := pub.Publish(context.Background(), input)
if err != nil {
	log.Fatal(err)
}

fmt.Println(msgID)

func New

func New(api snsiface.SNSAPI) (Publisher, error)

New creates a new SNS publisher.

func (Publisher) Publish

func (p Publisher) Publish(ctx context.Context, input *sns.PublishInput) (messageID string, err error)

Publish tries to publish a new message to SNS. It also stores tracing information.