Package: aws-solutions-constructs.aws-s3-sns
aws-s3-sns 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_snsTypescript@aws-solutions-constructs/aws-s3-snsJavasoftware.amazon.awsconstructs.services.s3snsOverviewThis AWS Solutions Construct implements an Amazon S3 Bucket that is configured to send S3 event messages to an Amazon SNS topic.Here is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps}from'aws-cdk-lib';import{S3ToSns}from"@aws-solutions-constructs/aws-s3-sns";newS3ToSns(this,'S3ToSNSPattern',{});Pythonfromaws_solutions_constructs.aws_s3_snsimportS3ToSnsfromaws_cdkimportStackfromconstructsimportConstructS3ToSns(self,'S3ToSNSPattern')Javaimportsoftware.constructs.Construct;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awsconstructs.services.s3sns.*;newS3ToSns(this,"S3ToSNSPattern",newS3ToSnsProps.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.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 - trueexistingTopicObj?sns.TopicAn optional, existing SNS topic to be used instead of the default topic. Providing both this andtopicPropswill cause an error. If the SNS Topic is encrypted with a Customer-Managed KMS Key, the key must be specified in theexistingTopicEncryptionKeyproperty.existingTopicEncryptionKey?kms.KeyIf an existing topic is provided in theexistingTopicObjproperty, and that topic is encrypted with a Customer-Managed KMS key, this property also needs to be set with same key.topicProps?sns.TopicPropsOptional user provided props to override the default props for the SNS topic.enableEncryptionWithCustomerManagedKey?booleanIf no key is provided, this flag determines whether the topic is encrypted with a new CMK or an AWS managed key. This flag is ignored if any of the following are defined: topicProps.encryptionMasterKey, encryptionKey or encryptionKeyProps.encryptionKey?kms.KeyAn optional, imported encryption key to encrypt the SNS Topic with.encryptionKeyProps?kms.KeyPropsOptional user provided properties to override the default properties for the KMS encryption key used to encrypt the SNS Topic with.Pattern PropertiesNameTypeDescriptionsnsTopicsns.TopicReturns an instance of the SNS Topic created by the pattern.encryptionKey?kms.KeyReturns an instance of the kms.Key associated with the SNS Topics3Bucket?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 the S3 BucketEnable server-side encryption for S3 Bucket using an AWS managed KMS KeyEnforce encryption of data in transitTurn on the versioning for the S3 BucketDon't allow public access for the S3 BucketRetain the S3 Bucket when deleting the CloudFormation stackApplies Lifecycle rule to move noncurrent object versions to Glacier storage after 90 daysAmazon SNS TopicConfigure least privilege SNS Topic access policy to allow the S3 Bucket to publish messages to itEnable server-side encryption for the SNS Topic using an AWS managed KMS KeyEnforce encryption of data in transitArchitecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.