aws-solutions-constructs.aws-s3-stepfunctions 1.133.0

CDK Constructs for AWS S3 to AWS Step Functions integration

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 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_stepfunctions
Typescript	@aws-solutions-constructs/aws-s3-stepfunctions
Java	software.amazon.awsconstructs.services.s3stepfunctions

This AWS Solutions Construct implements an Amazon S3 bucket connected to an AWS Step Functions.

Note - This construct uses Amazon EventBridge (Amazon CloudWatch Events) to trigger AWS Step Functions State Machine executions. EventBridge is more flexible, but triggering executions with S3 Event Notifications has less latency and is more cost effective. If cost and/or latency is an issue, you should consider deploying aws-s3-lambda and aws-lambda-stepfunctions in place of this construct.

Here is a minimal deployable pattern definition in Typescript:

# Example automatically generated from non-compiling source. May contain errors.
import { S3ToStepfunctions, S3ToStepfunctionsProps } from '@aws-solutions-constructs/aws-s3-stepfunctions';
import * as stepfunctions from '@aws-cdk/aws-stepfunctions';

const startState = new stepfunctions.Pass(stack, 'StartState');

new S3ToStepfunctions(this, 'test-s3-stepfunctions-stack', {
    stateMachineProps: {
      definition: startState
    }
});

Initializer

new S3ToStepfunctions(scope: Construct, id: string, props: S3ToStepfunctionsProps);

Parameters

• scope Construct
• id string
• props S3ToStepfunctionsProps

Pattern Construct Props

Name	Type	Description
existingBucketObj?	s3.IBucket	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.
stateMachineProps	sfn.StateMachineProps	User provided props to override the default props for sfn.StateMachine.
eventRuleProps?	events.RuleProps	Optional user provided eventRuleProps to override the defaults.
deployCloudTrail?	boolean	Whether to deploy a Trail in AWS CloudTrail to log API events in Amazon S3. Defaults to true.
createCloudWatchAlarms	boolean	Whether to create recommended CloudWatch alarms.
logGroupProps?	logs.LogGroupProps	Optional user provided props to override the default props for for the CloudWatchLogs LogGroup.
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
stateMachine	sfn.StateMachine	Returns an instance of sfn.StateMachine created by the construct.
stateMachineLogGroup	logs.ILogGroup	Returns 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.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.
cloudtrail	cloudtrail.Trail	Returns an instance of the cloudtrail.Trail created by the construct.
cloudtrailBucket	s3.Bucket	Returns an instance of the s3.Bucket created by the construct for CloudTrail.
cloudtrailLoggingBucket	s3.Bucket	Returns an instance of s3.Bucket created by the construct as the logging bucket for the primary CloudTrail 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

AWS CloudTrail

• Configure a Trail in AWS CloudTrail to log API events in Amazon S3 related to the Bucket created by the Construct

Amazon CloudWatch Events Rule

• Grant least privilege permissions to CloudWatch Events to trigger the Lambda Function

AWS Step Functions

• Enable CloudWatch logging for API Gateway
• Deploy best practices CloudWatch Alarms for the Step Functions

Architecture

---

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