Package: aws-solutions-constructs.aws-s3-stepfunctions
aws-s3-stepfunctions 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_stepfunctionsTypescript@aws-solutions-constructs/aws-s3-stepfunctionsJavasoftware.amazon.awsconstructs.services.s3stepfunctionsOverviewThis AWS Solutions Construct implements an Amazon S3 bucket connected to an AWS Step Functions.Note - This constructs sends S3 Event Notification to EventBridge, then triggers AWS Step Functions State Machine executions from EventBridge.An alternative architecture can be built that triggers a Lambda function from S3 Event notifications using aws-s3-lambda and aws-lambda-stepfunctions. Channelling the S3 events through Lambda is less flexible than EventBridge, but is more cost effective and has lower latency.Here is a minimal deployable pattern definition:Typescriptimport{Construct}from'constructs';import{Stack,StackProps}from'aws-cdk-lib';import{S3ToStepfunctions,S3ToStepfunctionsProps}from'@aws-solutions-constructs/aws-s3-stepfunctions';import*asstepfunctionsfrom'aws-cdk-lib/aws-stepfunctions';conststartState=newstepfunctions.Pass(this,'StartState');newS3ToStepfunctions(this,'test-s3-stepfunctions-stack',{stateMachineProps:{definition:startState}});Pythonfromaws_solutions_constructs.aws_s3_stepfunctionsimportS3ToStepfunctionsfromaws_cdkimport(aws_stepfunctionsasstepfunctions,Stack)fromconstructsimportConstructstart_state=stepfunctions.Pass(self,'start_state')S3ToStepfunctions(self,'test_s3_stepfunctions_stack',state_machine_props=stepfunctions.StateMachineProps(definition=start_state))Javaimportsoftware.constructs.Construct;importsoftware.amazon.awscdk.Stack;importsoftware.amazon.awscdk.StackProps;importsoftware.amazon.awscdk.services.stepfunctions.*;importsoftware.amazon.awsconstructs.services.s3stepfunctions.*;finalPassstartState=newPass(this,"StartState");newS3ToStepfunctions(this,"test_s3_stepfunctions_stack",newS3ToStepfunctionsProps.Builder().stateMachineProps(newStateMachineProps.Builder().definition(startState).build()).build());Pattern Construct PropsNameTypeDescriptionexistingBucketObj?s3.IBucketExisting instance of S3 Bucket object. If this is provided, then also providing bucketProps is an error.The existing bucket must haveEventBridge enabledfor this to work.bucketProps?s3.BucketPropsOptional user provided props to override the default props for the S3 Bucket.stateMachinePropssfn.StateMachinePropsUser provided props to override the default props for sfn.StateMachine.eventRuleProps?events.RulePropsOptional user provided eventRuleProps to override the defaults.deployCloudTrail?booleanWhether to deploy a Trail in AWS CloudTrail to log API events in Amazon S3. Defaults totrue.This is now deprecated and ignored because the construct no longer needs CloudTrail since it uses S3 Event Notifications.createCloudWatchAlarmsbooleanWhether to create recommended CloudWatch alarms.logGroupProps?logs.LogGroupPropsOptional user provided props to override the default props for for the CloudWatchLogs LogGroup.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 PropertiesNameTypeDescriptionstateMachinesfn.StateMachineReturns an instance of sfn.StateMachine created by the construct.stateMachineLogGrouplogs.ILogGroupReturns an instance of the ILogGroup created by the construct for StateMachine.cloudwatchAlarms?cloudwatch.Alarm[]Returns a list of cloudwatch.Alarm created by the construct.s3Bucket?s3.BucketReturns an instance of the s3.Bucket created by the construct.s3LoggingBucket?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.Note - with the release of Enable EventBridge for Amazon S3, AWS CloudTrail is no longer required to implement this construct. Because of this, the following properties have been removed:cloudtrailcloudtrailBucketcloudtrailLoggingBucketDefault settingsOut of the box implementation of the Construct without any override will set the following defaults:Amazon S3 BucketEnable EventBridge to send events from the 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 daysAWS S3 Event NotificationEnable S3 to send events to EventBridge when an object is created.Amazon CloudWatch Events RuleGrant least privilege permissions to CloudWatch Events to trigger the Lambda FunctionAWS Step FunctionsEnable CloudWatch logging for API GatewayDeploy best practices CloudWatch Alarms for the Step FunctionsArchitecture© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.