awssnssubscriptions

Documentation

Index

• func NewEmailSubscription_Override(e EmailSubscription, emailAddress *string, props *EmailSubscriptionProps)
• func NewLambdaSubscription_Override(l LambdaSubscription, fn awslambda.IFunction, props *LambdaSubscriptionProps)
• func NewSmsSubscription_Override(s SmsSubscription, phoneNumber *string, props *SmsSubscriptionProps)
• func NewSqsSubscription_Override(s SqsSubscription, queue awssqs.IQueue, props *SqsSubscriptionProps)
• func NewUrlSubscription_Override(u UrlSubscription, url *string, props *UrlSubscriptionProps)
• type EmailSubscription
  • func NewEmailSubscription(emailAddress *string, props *EmailSubscriptionProps) EmailSubscription
• type EmailSubscriptionProps
• type LambdaSubscription
  • func NewLambdaSubscription(fn awslambda.IFunction, props *LambdaSubscriptionProps) LambdaSubscription
• type LambdaSubscriptionProps
• type SmsSubscription
  • func NewSmsSubscription(phoneNumber *string, props *SmsSubscriptionProps) SmsSubscription
• type SmsSubscriptionProps
• type SqsSubscription
  • func NewSqsSubscription(queue awssqs.IQueue, props *SqsSubscriptionProps) SqsSubscription
• type SqsSubscriptionProps
• type SubscriptionProps
• type UrlSubscription
  • func NewUrlSubscription(url *string, props *UrlSubscriptionProps) UrlSubscription
• type UrlSubscriptionProps

Functions

func NewEmailSubscription_Override

func NewEmailSubscription_Override(e EmailSubscription, emailAddress *string, props *EmailSubscriptionProps)

Experimental.

func NewLambdaSubscription_Override

func NewLambdaSubscription_Override(l LambdaSubscription, fn awslambda.IFunction, props *LambdaSubscriptionProps)

Experimental.

func NewSmsSubscription_Override

func NewSmsSubscription_Override(s SmsSubscription, phoneNumber *string, props *SmsSubscriptionProps)

Experimental.

func NewSqsSubscription_Override

func NewSqsSubscription_Override(s SqsSubscription, queue awssqs.IQueue, props *SqsSubscriptionProps)

Experimental.

func NewUrlSubscription_Override

func NewUrlSubscription_Override(u UrlSubscription, url *string, props *UrlSubscriptionProps)

Experimental.

Types

type EmailSubscription

type EmailSubscription interface {
	awssns.ITopicSubscription
	Bind(_topic awssns.ITopic) *awssns.TopicSubscriptionConfig
}

Use an email address as a subscription target.

Email subscriptions require confirmation. Experimental.

func NewEmailSubscription

func NewEmailSubscription(emailAddress *string, props *EmailSubscriptionProps) EmailSubscription

Experimental.

type EmailSubscriptionProps

type EmailSubscriptionProps struct {
	// Queue to be used as dead letter queue.
	//
	// If not passed no dead letter queue is enabled.
	// Experimental.
	DeadLetterQueue awssqs.IQueue `json:"deadLetterQueue"`
	// The filter policy.
	// Experimental.
	FilterPolicy *map[string]awssns.SubscriptionFilter `json:"filterPolicy"`
	// Indicates if the full notification JSON should be sent to the email address or just the message text.
	// Experimental.
	Json *bool `json:"json"`
}

Options for email subscriptions. Experimental.

type LambdaSubscription

type LambdaSubscription interface {
	awssns.ITopicSubscription
	Bind(topic awssns.ITopic) *awssns.TopicSubscriptionConfig
}

Use a Lambda function as a subscription target. Experimental.

func NewLambdaSubscription

func NewLambdaSubscription(fn awslambda.IFunction, props *LambdaSubscriptionProps) LambdaSubscription

Experimental.

type LambdaSubscriptionProps

type LambdaSubscriptionProps struct {
	// Queue to be used as dead letter queue.
	//
	// If not passed no dead letter queue is enabled.
	// Experimental.
	DeadLetterQueue awssqs.IQueue `json:"deadLetterQueue"`
	// The filter policy.
	// Experimental.
	FilterPolicy *map[string]awssns.SubscriptionFilter `json:"filterPolicy"`
}

Properties for a Lambda subscription. Experimental.

type SmsSubscription

type SmsSubscription interface {
	awssns.ITopicSubscription
	Bind(_topic awssns.ITopic) *awssns.TopicSubscriptionConfig
}

Use an sms address as a subscription target. Experimental.

func NewSmsSubscription

func NewSmsSubscription(phoneNumber *string, props *SmsSubscriptionProps) SmsSubscription

Experimental.

type SmsSubscriptionProps

type SmsSubscriptionProps struct {
	// Queue to be used as dead letter queue.
	//
	// If not passed no dead letter queue is enabled.
	// Experimental.
	DeadLetterQueue awssqs.IQueue `json:"deadLetterQueue"`
	// The filter policy.
	// Experimental.
	FilterPolicy *map[string]awssns.SubscriptionFilter `json:"filterPolicy"`
}

Options for SMS subscriptions. Experimental.

type SqsSubscription

type SqsSubscription interface {
	awssns.ITopicSubscription
	Bind(topic awssns.ITopic) *awssns.TopicSubscriptionConfig
}

Use an SQS queue as a subscription target. Experimental.

func NewSqsSubscription

func NewSqsSubscription(queue awssqs.IQueue, props *SqsSubscriptionProps) SqsSubscription

Experimental.

type SqsSubscriptionProps

type SqsSubscriptionProps struct {
	// Queue to be used as dead letter queue.
	//
	// If not passed no dead letter queue is enabled.
	// Experimental.
	DeadLetterQueue awssqs.IQueue `json:"deadLetterQueue"`
	// The filter policy.
	// Experimental.
	FilterPolicy *map[string]awssns.SubscriptionFilter `json:"filterPolicy"`
	// The message to the queue is the same as it was sent to the topic.
	//
	// If false, the message will be wrapped in an SNS envelope.
	// Experimental.
	RawMessageDelivery *bool `json:"rawMessageDelivery"`
}

Properties for an SQS subscription. Experimental.

type SubscriptionProps

type SubscriptionProps struct {
	// Queue to be used as dead letter queue.
	//
	// If not passed no dead letter queue is enabled.
	// Experimental.
	DeadLetterQueue awssqs.IQueue `json:"deadLetterQueue"`
	// The filter policy.
	// Experimental.
	FilterPolicy *map[string]awssns.SubscriptionFilter `json:"filterPolicy"`
}

Options to subscribing to an SNS topic. Experimental.

type UrlSubscription

type UrlSubscription interface {
	awssns.ITopicSubscription
	Bind(_topic awssns.ITopic) *awssns.TopicSubscriptionConfig
}

Use a URL as a subscription target.

The message will be POSTed to the given URL. See: https://docs.aws.amazon.com/sns/latest/dg/sns-http-https-endpoint-as-subscriber.html

Experimental.

func NewUrlSubscription

func NewUrlSubscription(url *string, props *UrlSubscriptionProps) UrlSubscription

Experimental.

type UrlSubscriptionProps

type UrlSubscriptionProps struct {
	// Queue to be used as dead letter queue.
	//
	// If not passed no dead letter queue is enabled.
	// Experimental.
	DeadLetterQueue awssqs.IQueue `json:"deadLetterQueue"`
	// The filter policy.
	// Experimental.
	FilterPolicy *map[string]awssns.SubscriptionFilter `json:"filterPolicy"`
	// The subscription's protocol.
	// Experimental.
	Protocol awssns.SubscriptionProtocol `json:"protocol"`
	// The message to the queue is the same as it was sent to the topic.
	//
	// If false, the message will be wrapped in an SNS envelope.
	// Experimental.
	RawMessageDelivery *bool `json:"rawMessageDelivery"`
}

Options for URL subscriptions. Experimental.