npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2022 – Pkg Stats / Ryan Hefner

@aws-solutions-constructs/aws-s3-stepfunctions

v2.1.0

Published

CDK Constructs for AWS S3 to AWS Step Functions integration

Downloads

2,644

Readme

aws-s3-stepfunctions module


Stability: Experimental

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

This 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 in Typescript:

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

Pattern Construct Props

| Name | Type | Description | |:-------------|:----------------|-----------------| |existingBucketObj?|s3.IBucket|Existing instance of S3 Bucket object. The existing bucket must have EventBridge enabled for this to work. 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. This is now deprecated and ignored because the construct no longer needs CloudTrail since it uses S3 Event Notifications.| |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.| |s3BucketInterface|s3.IBucket|Returns 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:

  • cloudtrail
  • cloudtrailBucket
  • cloudtrailLoggingBucket

Default settings

Out of the box implementation of the Construct without any override will set the following defaults:

Amazon S3 Bucket

  • Enable EventBridge to send events from the 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 S3 Event Notification

  • Enable S3 to send events to EventBridge when an object is created.

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

Architecture Diagram


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