aws-solutions-constructs.aws-s3-sqs 1.79.0

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

aws-s3-sqs module

---

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	aws_solutions_constructs.aws_s3_sqs
Typescript	@aws-solutions-constructs/aws-s3-sqs
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 in Typescript:

# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
from aws_solutions_constructs.aws_s3_sqs import S3ToSqs

S3ToSqs(stack, "S3ToSQSPattern")

Initializer

new S3ToSqs(scope: Construct, id: string, props: S3ToSqsProps);

Parameters

• scope Construct
• id string
• props S3ToSqsProps

Pattern Construct Props

Name	Type	Description
existingBucketObj?	s3.Bucket	Existing instance of S3 Bucket object, if this is set then the bucketProps is ignored.
bucketProps?	s3.BucketProps	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	An optional, existing SQS queue to be used instead of the default queue. If an existing queue is provided, the queueProps property will be ignored. 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	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
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.

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

---

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