cdk-tweet-queue/lib/tweet-queue.d.ts

Defines an SQS queue with tweet stream from a search

import * as sqs from 'aws-cdk-lib/aws-sqs';
import { Construct } from 'constructs';
export interface TweetQueueProps {
    /**
     * The SecretsManager secret that contains Twitter authentication credentials
     * from https://apps.twitter.com/ with the following attributes (exact names):
     *  - consumer_key
     *  - consumer_secret
     *  - access_token_key
     *  - access_token_secret
     */
    readonly secretArn: string;
    /**
     * The twitter query string to stream.
     */
    readonly query: string;
    /**
     * Polling interval in minutes.
     * Set to 0 to disable polling.
     * @default 1min
     */
    readonly intervalMin?: number;
    /**
     * Number of seconds for messages to wait in the queue for processing.
     * After this time, messages will be removed from the queue.
     * @default 60 seconds
     */
    readonly retentionPeriodSec?: number;
    /**
     * Number of seconds for messages to be invisible while they are processed.
     * Based on the amount of time it would require to process a single message.
     * @default 60 seconds
     */
    readonly visibilityTimeoutSec?: number;
}
export declare class TweetQueue extends sqs.Queue {
    constructor(parent: Construct, id: string, props: TweetQueueProps);
}