Skip to main content

Defines an SQS queue with tweet stream from a search

Project description

Tweet Queue for AWS CDK

This is an AWS CDK construct library which allows you to get a feed of Twitter search results into an SQS queue. It works by periodically polling the freely available Twitter Standard Search API and sending all new tweets to an SQS queue.

Inspired by @jlhood's aws-serverless-twitter-event-source


  1. A CloudWatch Event Rule triggers the poller AWS Lambda function periodically
  2. The poller reads the last checkpoint from a DynamoDB table (if exists)
  3. The poller issues a Twitter search query for all new tweets
  4. The poller enqueues all tweets to an SQS queue
  5. The poller stores the ID of the last tweet into the DynamoDB checkpoint table.
  6. Rinse & repeat.

Twitter API Keys

To issue a Twitter search request, you will need to apply for a Twitter developer account, and obtain API keys through by defining a new application.

The Twitter API keys are read by the poller from an AWS Secrets Manager entry. The entry must contain the following attributes: consumer_key, consumer_secret, access_token_key and access_token_secret (exact names).

  1. Create a new AWS Secrets Manager entry for your API keys
  2. Fill in the key values as shown below:
  3. Store the key
  4. Obtain the ARN of the secret (you will need it soon).


Use npm to install the module in your CDK project. This will also add it to your package.json file.

$ npm install cdk-tweet-queue

Add a TweetQueue to your CDK stack:

# Example automatically generated without compilation. See
from cdk_tweet_queue import TweetQueue

queue = TweetQueue(self, "TweetStream",
    # this is the ARN of the secret you stored

    # twitter search query
    # see

    # optional properties
    interval_min=60, # optional: polling interval in minutes
    retention_period_sec=60, # optional: queue retention period

Now, queue is an sqs.Queue object and can be used anywhere a queue is accepted. For example, you could process the queue messages using an AWS Lambda function by setting up an SQS event source mapping.


This is a mono-repo which uses lerna. Here are some useful commands:

  • lerna run build - builds all code
  • lerna run watch --stream -- runs tsc -w in all modules (in parallel)
  • lerna run test - tests all code

There is also an integration test that can be executed from the cdk-tweet-queue package by running the following commands. You will need to set the TWEET_QUEUE_SECRET_ARN environment variable in order for the test to be able to use your Twitter API keys.

$ npm run integ deploy

Don't forget to destroy:

$ npm run integ destroy



Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for cdk-tweet-queue, version 1.0.3
Filename, size File type Python version Upload date Hashes
Filename, size cdk_tweet_queue-1.0.3-py3-none-any.whl (1.1 MB) File type Wheel Python version py3 Upload date Hashes View
Filename, size cdk-tweet-queue-1.0.3.tar.gz (1.1 MB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page