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-s3-sqs

v2.8.0

Published

CDK constructs for defining an interaction between an Amazon S3 bucket and an Amazon SQS queue.

Downloads

1,320

Readme

aws-s3-sqs module


Stability: Experimental

All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.


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

| Language | Package | |:-------------|-----------------| |Python Logo Python|aws_solutions_constructs.aws_s3_sqs| |Typescript Logo Typescript|@aws-solutions-constructs/aws-s3-sqs| |Java Logo Java|software.amazon.awsconstructs.services.s3sqs|

This AWS Solutions Construct implements an Amazon S3 Bucket that is configured to send notifications to an Amazon SQS queue.

Here is a minimal deployable pattern definition:

Typescript

import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { S3ToSqs } from "@aws-solutions-constructs/aws-s3-sqs";

new S3ToSqs(this, 'S3ToSQSPattern', {});

Python

from aws_solutions_constructs.aws_s3_sqs import S3ToSqs
from aws_cdk import Stack
from constructs import Construct

S3ToSqs(self, 'S3ToSQSPattern')

Java

import software.constructs.Construct;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awsconstructs.services.s3sqs.*;

new S3ToSqs(this, "S3ToSQSPattern", new S3ToSqsProps.Builder()
        .build());

Pattern Construct Props

| Name | Type | Description | |:-------------|:----------------|-----------------| |existingBucketObj?|s3.Bucket|Existing instance of S3 Bucket object. If this is provided, then also providing bucketProps is an error. | |bucketProps?|s3.BucketProps|Optional user provided props to override the default props for the S3 Bucket.| |s3EventTypes?|s3.EventType[]|The S3 event types that will trigger the notification. Defaults to s3.EventType.OBJECT_CREATED.| |s3EventFilters?|s3.NotificationKeyFilter[]|S3 object key filter rules to determine which objects trigger this event. If not specified no filter rules will be applied.| |existingQueueObj?|sqs.Queue|Existing SQS queue to be used instead of the default queue. Providing both this and queueProps will cause an error. If the SQS queue is encrypted, the KMS key utilized for encryption must be a customer managed CMK.| |queueProps?|sqs.QueueProps|Optional user provided props to override the default props for the SQS queue.| |deadLetterQueueProps?|sqs.QueueProps|Optional user provided props to override the default props for the dead letter SQS queue.| |deployDeadLetterQueue?|boolean|Whether to create a secondary queue to be used as a dead letter queue. Defaults 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|Optional imported encryption key to encrypt the SQS queue.| |encryptionKeyProps?|kms.KeyProps|Optional user provided properties to override the default properties for the KMS encryption key.| |loggingBucketProps?|s3.BucketProps|Optional user provided props to override the default props for the S3 Logging Bucket.| |logS3AccessLogs?| boolean|Whether to turn on Access Logging for the S3 bucket. Creates an S3 bucket with associated storage costs for the logs. Enabling Access Logging is a best practice. default - true|

Pattern Properties

| Name | Type | Description | |:-------------|:----------------|-----------------| |sqsQueue|sqs.Queue|Returns an instance of the SQS queue created by the pattern.| |deadLetterQueue?|sqs.Queue|Returns an instance of the dead-letter SQS queue created by the pattern.| |encryptionKey|kms.IKey|Returns an instance of kms.Key used for the SQS queue.| |s3Bucket?|s3.Bucket|Returns an instance of the s3.Bucket created by the construct| |s3LoggingBucket?|s3.Bucket|Returns an instance of s3.Bucket created by the construct as the logging bucket for the primary bucket.| |s3BucketInterface|s3.IBucket|Returns an instance of s3.IBucket created by the construct.|

Default settings

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

Amazon S3 Bucket

  • Configure Access logging for S3 Bucket
  • Enable server-side encryption for S3 Bucket using AWS managed KMS Key
  • Enforce encryption of data in transit
  • Turn on the versioning for S3 Bucket
  • Don't allow public access for S3 Bucket
  • Retain the S3 Bucket when deleting the CloudFormation stack
  • Applies Lifecycle rule to move noncurrent object versions to Glacier storage after 90 days

Amazon SQS Queue

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

Architecture

Architecture Diagram


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