AWS CDK Reference

Appearance

v2.275.0

SqsSubscription Class ​

Use an SQS queue as a subscription target.

Source
aws-sns-subscriptions/lib/sqs.ts

Example ​

ts
declare const queue: sqs.Queue;
const myTopic = new sns.Topic(this, 'MyTopic');

myTopic.addSubscription(new subscriptions.SqsSubscription(queue));
python
# queue: sqs.Queue

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

my_topic.add_subscription(subscriptions.SqsSubscription(queue))
java
Queue queue;

Topic myTopic = new Topic(this, "MyTopic");

myTopic.addSubscription(new SqsSubscription(queue));
csharp
// Install: dotnet add package Amazon.CDK.Lib
Queue queue;

var myTopic = new Topic(this, "MyTopic");

myTopic.AddSubscription(new SqsSubscription(queue));
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var queue Queue

myTopic := sns.NewTopic(this, jsii.String("MyTopic"))

myTopic.AddSubscription(subscriptions.NewSqsSubscription(queue))

Initializer ​

ts
new SqsSubscription(queue: IQueue, props?: SqsSubscriptionProps)
python
SqsSubscription(queue: IQueue, props: typing.Optional[SqsSubscriptionProps] = None)
java
new SqsSubscription(IQueue queue, SqsSubscriptionProps props)
csharp
new SqsSubscription(IQueue queue, SqsSubscriptionProps? props = null)
go
NewSqsSubscription(Queue IQueue, Props SqsSubscriptionProps)

Methods ​

bind(topic: ITopic): TopicSubscriptionConfigdef bind(self, topic: ITopic) -> TopicSubscriptionConfigpublic TopicSubscriptionConfig bind(ITopic topic)public TopicSubscriptionConfig Bind(ITopic topic)func Bind(Topic ITopic) TopicSubscriptionConfig#
Returns a configuration for an SQS queue to subscribe to an SNS topic.