SqsSubscription

class aws_cdk.aws_sns_subscriptions.SqsSubscription(queue, *, raw_message_delivery=None, dead_letter_queue=None, filter_policy=None, filter_policy_with_message_body=None)

Bases: object

Use an SQS queue as a subscription target.

ExampleMetadata:

infused

Example:

# queue: sqs.Queue

my_topic = sns.Topic(self, "MyTopic")

my_topic.add_subscription(subscriptions.SqsSubscription(queue))
Parameters:

  • queue (IQueue) –

  • raw_message_delivery (Optional[bool]) – 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. Default: false

  • dead_letter_queue (Optional[IQueue]) – Queue to be used as dead letter queue. If not passed no dead letter queue is enabled. Default: - No dead letter queue enabled.

  • filter_policy (Optional[Mapping[str, SubscriptionFilter]]) – The filter policy. Default: - all messages are delivered

  • filter_policy_with_message_body (Optional[Mapping[str, FilterOrPolicy]]) – The filter policy that is applied on the message body. To apply a filter policy to the message attributes, use filterPolicy. A maximum of one of filterPolicyWithMessageBody and filterPolicy may be used. Default: - all messages are delivered

Methods

bind(topic)

Returns a configuration for an SQS queue to subscribe to an SNS topic.

Parameters:

topic (ITopic) –

Return type:

TopicSubscriptionConfig