SnsTopicQueueSubscriber

Reference doc for the `sst.aws.SnsTopicQueueSubscriber` component.

The SnsTopicQueueSubscriber component is internally used by the SnsTopic component to add subscriptions to your Amazon SNS Topic.

You’ll find this component returned by the subscribeQueue method of the SnsTopic component.

Constructor

new SnsTopicQueueSubscriber(name, args, opts?)

Parameters

name string
args Args
opts? ComponentResourceOptions

Properties

nodes

Type Object

policy
subscription

The underlying resources this component creates.

nodes.policy

Type QueuePolicy

The SQS Queue policy.

nodes.subscription

Type TopicSubscription

The SNS Topic subscription.

Args

filter?

Type Input<Record<string, any>>

Filter the messages that’ll be processed by the subscriber.

If any single property in the filter doesn’t match an attribute assigned to the message, then the policy rejects the message.

For example, if your SNS Topic message contains this in a JSON format.

{
  store: "example_corp",
  event: "order-placed",
  customer_interests: [
     "soccer",
     "rugby",
     "hockey"
  ],
  price_usd: 210.75
}

Then this filter policy accepts the message.

{
  filter: {
    store: ["example_corp"],
    event: [{"anything-but": "order_cancelled"}],
    customer_interests: [
       "rugby",
       "football",
       "baseball"
    ],
    price_usd: [{numeric: [">=", 100]}]
  }
}

queue

Type Input<string | Queue>

The ARN of the SQS Queue.

topic

Type Input<Object>

arn

The SNS Topic to use.

topic.arn

Type Input<string>

The ARN of the SNS Topic.

transform?

Type Object

subscription?

Transform how this subscription creates its underlying resources.

transform.subscription?

Type TopicSubscriptionArgs | (args: TopicSubscriptionArgs, opts: ComponentResourceOptions, name: string) => void

Transform the SNS Topic Subscription resource.