npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2022 – Pkg Stats / Ryan Hefner

@aws-solutions-constructs/aws-eventbridge-sqs

v2.1.0

Published

CDK Constructs for deploying AWS Eventbridge that invokes AWS SQS

Downloads

3,675

Readme

aws-eventbridge-sqs module


Stability: Stable


| Reference Documentation:| https://docs.aws.amazon.com/solutions/latest/constructs/| |:-------------|:-------------|

| Language | Package | |:-------------|-----------------| |Python Logo Python|aws_solutions_constructs.aws_eventbridge_sqs| |Typescript Logo Typescript|@aws-solutions-constructs/aws-eventbridge-sqs| |Java Logo Java|software.amazon.awsconstructs.services.eventbridgesqs|

This AWS Solutions Construct implements an Amazon EventBridge rule and an AWS SQS Queue.

Here is a minimal deployable pattern definition in Typescript:

import { Duration } from '@aws-cdk/core';
import * as events from '@aws-cdk/aws-events';
import * as iam from '@aws-cdk/aws-iam';
import { EventbridgeToSqsProps, EventbridgeToSqs } from "@aws-solutions-constructs/aws-eventbridge-sqs";

const props: EventbridgeToSqsProps = {
  eventRuleProps: {
    schedule: events.Schedule.rate(Duration.minutes(5))
  }
};

const constructStack = new EventbridgeToSqs(this, 'test-construct', props);

// Grant yourself permissions to use the Customer Managed KMS Key
const policyStatement = new iam.PolicyStatement({
  actions: ["kms:Encrypt", "kms:Decrypt"],
  effect: iam.Effect.ALLOW,
  principals: [ new iam.AccountRootPrincipal() ],
  resources: [ "*" ]
});

constructStack.encryptionKey?.addToResourcePolicy(policyStatement);

Initializer

new EventbridgeToSqs(scope: Construct, id: string, props: EventbridgeToSqsProps);

Parameters

Pattern Construct Props

| Name | Type | Description | |:-------------|:----------------|-----------------| |existingEventBusInterface?|events.IEventBus| Optional user-provided custom EventBus for construct to use. Providing both this and eventBusProps results an error.| |eventBusProps?|events.EventBusProps|Optional user-provided properties to override the default properties when creating a custom EventBus. Setting this value to {} will create a custom EventBus using all default properties. If neither this nor existingEventBusInterface is provided the construct will use the default EventBus. Providing both this and existingEventBusInterface results an error.| |eventRuleProps|events.RuleProps|User provided eventRuleProps to override the defaults. | |existingQueueObj?|sqs.Queue|An optional, existing SQS queue to be used instead of the default queue. Providing both this and queueProps will cause an error.| |queueProps?|sqs.QueueProps|User provided props to override the default props for the SQS Queue. | |enableQueuePurging?|boolean|Whether to grant additional permissions to the Lambda function enabling it to purge the SQS queue. Defaults to false.| |deployDeadLetterQueue?|boolean|Whether to create a secondary queue to be used as a dead letter queue. Defaults to true.| |deadLetterQueueProps?|sqs.QueueProps|Optional user-provided props to override the default props for the dead letter queue. Only used if the deployDeadLetterQueue property is set to true.| |maxReceiveCount?|number|The number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to 15.| |enableEncryptionWithCustomerManagedKey?|boolean|Use a KMS Key, either managed by this CDK app, or imported. If importing an encryption key, it must be specified in the encryptionKey property for this construct.| |encryptionKey?|kms.Key|An optional, imported encryption key to encrypt the SQS queue.| |encryptionKeyProps?|kms.KeyProps|An optional, user provided properties to override the default properties for the KMS encryption key.|

Pattern Properties

| Name | Type | Description | |:-------------|:----------------|-----------------| |eventBus?|events.IEventBus|Returns the instance of events.IEventBus used by the construct| |eventsRule|events.Rule|Returns an instance of events.Rule created by the construct| |sqsQueue|sqs.Queue|Returns an instance of sqs.Queue created by the construct| |encryptionKey?|kms.Key|Returns an instance of kms Key used for the SQS queue.| |deadLetterQueue?|sqs.Queue|Returns an instance of the dead-letter SQS queue created by the pattern.|

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

Amazon EventBridge Rule

  • Grant least privilege permissions to EventBridge rule to publish to the SQS Queue.

Amazon SQS Queue

  • Deploy SQS dead-letter queue for the source SQS Queue.
  • Enable server-side encryption for source SQS Queue using Customer managed KMS Key.
  • Enforce encryption of data in transit.

Architecture

Architecture Diagram


© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.