Package: aws-solutions-constructs.aws-s3-sqs
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 theSemantic Versioningmodel.
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/LanguagePackagePythonaws_solutions_constructs.aws_s3_sqsTypescript@aws-solutions-constructs/aws-s3-sqsJavasoftware.amazon.awsconstructs.services.s3sqsOverviewThis 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:Typescriptimport{Construct}from'constructs';import{Stack,StackProps}from'aws-cdk-lib';import{S3ToSqs}from"@aws-solutions-constructs/aws-s3-sqs";newS3ToSqs(this,'S3ToSQSPattern',{});Pythonfromaws_solutions_constructs.aws_s3_sqsimportS3ToSqsfromaws_cdkimportStackfromconstructsimportConstructS3ToSqs(self,'S3ToSQSPattern')Javaimportsoftware.constructs.Construct;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awsconstructs.services.s3sqs.*;newS3ToSqs(this,"S3ToSQSPattern",newS3ToSqsProps.Builder().build());Pattern Construct PropsNameTypeDescriptionexistingBucketObj?s3.BucketExisting instance of S3 Bucket object. If this is provided, then also providing bucketProps is an error.bucketProps?s3.BucketPropsOptional 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.QueueExisting SQS queue to be used instead of the default queue. Providing both this andqueuePropswill cause an error. If the SQS queue is encrypted, the KMS key utilized for encryption must be a customer managed CMK.queueProps?sqs.QueuePropsOptional user provided props to override the default props for the SQS queue.deadLetterQueueProps?sqs.QueuePropsOptional user provided props to override the default props for the dead letter SQS queue.deployDeadLetterQueue?booleanWhether to create a secondary queue to be used as a dead letter queue. Defaults to true.maxReceiveCount?numberThe number of times a message can be unsuccessfully dequeued before being moved to the dead letter queue. Defaults to 15.enableEncryptionWithCustomerManagedKey?booleanIf no key is provided, this flag determines whether the queue is encrypted with a new CMK or an AWS managed key. This flag is ignored if any of the following are defined: queueProps.encryptionMasterKey, encryptionKey or encryptionKeyProps.encryptionKey?kms.KeyAn optional, imported encryption key to encrypt the SQS Queue with.encryptionKeyProps?kms.KeyPropsOptional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.loggingBucketProps?s3.BucketPropsOptional user provided props to override the default props for the S3 Logging Bucket.logS3AccessLogs?booleanWhether 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 - truePattern PropertiesNameTypeDescriptionsqsQueuesqs.QueueReturns an instance of the SQS queue created by the pattern.deadLetterQueue?sqs.QueueReturns an instance of the dead-letter SQS queue created by the pattern.encryptionKeykms.IKeyReturns an instance of kms.Key used for the SQS queue.s3Bucket?s3.BucketReturns an instance of the s3.Bucket created by the constructs3LoggingBucket?s3.BucketReturns an instance of s3.Bucket created by the construct as the logging bucket for the primary bucket.s3BucketInterfaces3.IBucketReturns an instance of s3.IBucket created by the construct.Default settingsOut of the box implementation of the Construct without any override will set the following defaults:Amazon S3 BucketConfigure Access logging for S3 BucketEnable server-side encryption for S3 Bucket using AWS managed KMS KeyEnforce encryption of data in transitTurn on the versioning for S3 BucketDon't allow public access for S3 BucketRetain the S3 Bucket when deleting the CloudFormation stackApplies Lifecycle rule to move noncurrent object versions to Glacier storage after 90 daysAmazon SQS QueueConfigure least privilege access permissions for SQS QueueDeploy SQS dead-letter queue for the source SQS QueueEnable server-side encryption for SQS Queue using Customer managed KMS KeyEnforce encryption of data in transitArchitecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.