# aws-s3-step-function module
<!--BEGIN STABILITY BANNER-->---
> Some of our early constructs don’t meet the naming standards that evolved for the library. We are releasing completely feature compatible versions with corrected names. The underlying implementation code is the same regardless of whether you deploy the construct using the old or new name. We will support both names for all 1.x releases, but in 2.x we will only publish the correctly named constructs. This construct is being replaced by the functionally identical aws-s3-stepfunctions.
---
<!--END STABILITY BANNER-->
| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
|:-------------|:-------------|
<div style="height:8px"></div>
| **Language** | **Package** |
|:-------------|-----------------|
| Python|`aws_solutions_constructs.aws_s3_step_function`|
| Typescript|`@aws-solutions-constructs/aws-s3-step-function`|
| Java|`software.amazon.awsconstructs.services.s3stepfunction`|
## Overview
This AWS Solutions Construct implements an Amazon S3 bucket connected to an AWS Step Function.
*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:
Typescript
```python
// aws-s3-step-function has been deprecated for CDK V2 in favor of aws-s3-stepfunctions.
// This sample uses the CDK V1 syntax
import * as cdk from '@aws-cdk/core';
import { S3ToStepFunction, S3ToStepFunctionProps } from '@aws-solutions-constructs/aws-s3-step-function';
import * as stepfunctions from '@aws-cdk/aws-stepfunctions';
const startState = new stepfunctions.Pass(this, 'StartState');
new S3ToStepFunction(this, 'test-s3-step-function-stack', {
stateMachineProps: {
definition: startState
}
});
```
Python
```python
# aws-s3-step-function has been deprecated for CDK V2 in favor of aws-s3-stepfunctions.
# This sample uses the CDK V1 syntax
from aws_solutions_constructs.aws_s3_step_function import S3ToStepFunction
from aws_cdk import (
aws_stepfunctions as stepfunctions,
core
)
start_state = stepfunctions.Pass(self, 'start_state')
S3ToStepFunction(
self, 'test_s3_step_function_stack',
state_machine_props=stepfunctions.StateMachineProps(
definition=start_state)
)
```
Java
```java
// aws-s3-step-function has been deprecated for CDK V2 in favor of aws-s3-stepfunctions.
// This sample uses the CDK V1 syntax
import software.constructs.Construct;
import software.amazon.awscdk.core.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awsconstructs.services.s3stepfunction.*;
final Pass startState = new Pass(this, "StartState");
new S3ToStepFunction(this, "test_s3_stepfunctions_stack",
new S3ToStepFunctionProps.Builder()
.stateMachineProps(new StateMachineProps.Builder()
.definition(startState)
.build())
.build());
```
## Pattern Construct Props
| **Name** | **Type** | **Description** |
|:-------------|:----------------|-----------------|
|existingBucketObj?|[`s3.IBucket`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.IBucket.html)|Existing instance of S3 Bucket object. The existing bucket must have [EventBridge enabled](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-event-notifications-eventbridge.html) for this to work. If this is provided, then also providing bucketProps is an error. |
|bucketProps?|[`s3.BucketProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.BucketProps.html)|Optional user provided props to override the default props for the S3 Bucket.|
|stateMachineProps|[`sfn.StateMachineProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-stepfunctions.StateMachineProps.html)|User provided props to override the default props for sfn.StateMachine|
|eventRuleProps?|[`events.RuleProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.RuleProps.html)|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`. <span style="color:red">**This is now deprecated and ignored because the construct no longer needs CloudTrail since it uses S3 Event Notifications**</span>.|
|createCloudWatchAlarms|`boolean`|Whether to create recommended CloudWatch alarms.|
|logGroupProps?|[`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroupProps.html)|User provided props to override the default props for for the CloudWatchLogs LogGroup.|
|loggingBucketProps?|[`s3.BucketProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.BucketProps.html)|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`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-stepfunctions.StateMachine.html)|Returns an instance of sfn.StateMachine created by the construct|
|stateMachineLogGroup|[`logs.ILogGroup`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.ILogGroup.html)|Returns an instance of the ILogGroup created by the construct for StateMachine|
|cloudwatchAlarms?|[`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-cloudwatch.Alarm.html)|Returns a list of cloudwatch.Alarm created by the construct.|
|s3Bucket?|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.Bucket.html)|Returns an instance of the s3.Bucket created by the construct|
|s3LoggingBucket?|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.Bucket.html)|Returns an instance of s3.Bucket created by the construct as the logging bucket for the primary bucket.|
|s3BucketInterface|[`s3.IBucket`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.IBucket.html)|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 Function
* Enable CloudWatch logging for API Gateway
* Deploy best practices CloudWatch Alarms for the Step Function
## Architecture
---
© Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Raw data
{
"_id": null,
"home_page": "https://github.com/awslabs/aws-solutions-constructs.git",
"name": "aws-solutions-constructs.aws-s3-step-function",
"maintainer": "",
"docs_url": null,
"requires_python": "~=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Amazon Web Services",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/9c/62/2ba952d96024b93abb0366d2b5e5d8d686886a8dd9841d7e713ec7c86455/aws-solutions-constructs.aws-s3-step-function-1.181.1.tar.gz",
"platform": null,
"description": "# aws-s3-step-function module\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n\n\n> Some of our early constructs don\u2019t meet the naming standards that evolved for the library. We are releasing completely feature compatible versions with corrected names. The underlying implementation code is the same regardless of whether you deploy the construct using the old or new name. We will support both names for all 1.x releases, but in 2.x we will only publish the correctly named constructs. This construct is being replaced by the functionally identical aws-s3-stepfunctions.\n\n---\n<!--END STABILITY BANNER-->\n\n| **Reference Documentation**:| <span style=\"font-weight: normal\">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|\n|:-------------|:-------------|\n\n<div style=\"height:8px\"></div>\n\n| **Language** | **Package** |\n|:-------------|-----------------|\n| Python|`aws_solutions_constructs.aws_s3_step_function`|\n| Typescript|`@aws-solutions-constructs/aws-s3-step-function`|\n| Java|`software.amazon.awsconstructs.services.s3stepfunction`|\n\n## Overview\n\nThis AWS Solutions Construct implements an Amazon S3 bucket connected to an AWS Step Function.\n\n*Note - This constructs sends S3 Event Notification to EventBridge, then triggers AWS Step Functions State Machine executions from EventBridge.*\n\n*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.*\n\nHere is a minimal deployable pattern definition:\n\nTypescript\n\n```python\n// aws-s3-step-function has been deprecated for CDK V2 in favor of aws-s3-stepfunctions.\n// This sample uses the CDK V1 syntax\nimport * as cdk from '@aws-cdk/core';\nimport { S3ToStepFunction, S3ToStepFunctionProps } from '@aws-solutions-constructs/aws-s3-step-function';\nimport * as stepfunctions from '@aws-cdk/aws-stepfunctions';\n\nconst startState = new stepfunctions.Pass(this, 'StartState');\n\nnew S3ToStepFunction(this, 'test-s3-step-function-stack', {\n stateMachineProps: {\n definition: startState\n }\n});\n```\n\nPython\n\n```python\n# aws-s3-step-function has been deprecated for CDK V2 in favor of aws-s3-stepfunctions.\n# This sample uses the CDK V1 syntax\nfrom aws_solutions_constructs.aws_s3_step_function import S3ToStepFunction\nfrom aws_cdk import (\n aws_stepfunctions as stepfunctions,\n core\n)\n\nstart_state = stepfunctions.Pass(self, 'start_state')\n\nS3ToStepFunction(\n self, 'test_s3_step_function_stack',\n state_machine_props=stepfunctions.StateMachineProps(\n definition=start_state)\n)\n```\n\nJava\n\n```java\n// aws-s3-step-function has been deprecated for CDK V2 in favor of aws-s3-stepfunctions.\n// This sample uses the CDK V1 syntax\nimport software.constructs.Construct;\n\nimport software.amazon.awscdk.core.*;\nimport software.amazon.awscdk.services.stepfunctions.*;\nimport software.amazon.awsconstructs.services.s3stepfunction.*;\n\nfinal Pass startState = new Pass(this, \"StartState\");\n\nnew S3ToStepFunction(this, \"test_s3_stepfunctions_stack\",\n new S3ToStepFunctionProps.Builder()\n .stateMachineProps(new StateMachineProps.Builder()\n .definition(startState)\n .build())\n .build());\n```\n\n## Pattern Construct Props\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|existingBucketObj?|[`s3.IBucket`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.IBucket.html)|Existing instance of S3 Bucket object. The existing bucket must have [EventBridge enabled](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enable-event-notifications-eventbridge.html) for this to work. If this is provided, then also providing bucketProps is an error. |\n|bucketProps?|[`s3.BucketProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.BucketProps.html)|Optional user provided props to override the default props for the S3 Bucket.|\n|stateMachineProps|[`sfn.StateMachineProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-stepfunctions.StateMachineProps.html)|User provided props to override the default props for sfn.StateMachine|\n|eventRuleProps?|[`events.RuleProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.RuleProps.html)|Optional user provided eventRuleProps to override the defaults|\n|deployCloudTrail?|`boolean`|Whether to deploy a Trail in AWS CloudTrail to log API events in Amazon S3. Defaults to `true`. <span style=\"color:red\">**This is now deprecated and ignored because the construct no longer needs CloudTrail since it uses S3 Event Notifications**</span>.|\n|createCloudWatchAlarms|`boolean`|Whether to create recommended CloudWatch alarms.|\n|logGroupProps?|[`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroupProps.html)|User provided props to override the default props for for the CloudWatchLogs LogGroup.|\n|loggingBucketProps?|[`s3.BucketProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.BucketProps.html)|Optional user provided props to override the default props for the S3 Logging Bucket.|\n|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|\n\n## Pattern Properties\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|stateMachine|[`sfn.StateMachine`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-stepfunctions.StateMachine.html)|Returns an instance of sfn.StateMachine created by the construct|\n|stateMachineLogGroup|[`logs.ILogGroup`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.ILogGroup.html)|Returns an instance of the ILogGroup created by the construct for StateMachine|\n|cloudwatchAlarms?|[`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-cloudwatch.Alarm.html)|Returns a list of cloudwatch.Alarm created by the construct.|\n|s3Bucket?|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.Bucket.html)|Returns an instance of the s3.Bucket created by the construct|\n|s3LoggingBucket?|[`s3.Bucket`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.Bucket.html)|Returns an instance of s3.Bucket created by the construct as the logging bucket for the primary bucket.|\n|s3BucketInterface|[`s3.IBucket`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-s3.IBucket.html)|Returns an instance of s3.IBucket created by the construct.|\n\n*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:*\n\n* cloudtrail\n* cloudtrailBucket\n* cloudtrailLoggingBucket\n\n## Default settings\n\nOut of the box implementation of the Construct without any override will set the following defaults:\n\n### Amazon S3 Bucket\n\n* Enable EventBridge to send events from the S3 Bucket\n* Configure Access logging for S3 Bucket\n* Enable server-side encryption for S3 Bucket using AWS managed KMS Key\n* Enforce encryption of data in transit\n* Turn on the versioning for S3 Bucket\n* Don't allow public access for S3 Bucket\n* Retain the S3 Bucket when deleting the CloudFormation stack\n* Applies Lifecycle rule to move noncurrent object versions to Glacier storage after 90 days\n\n### AWS S3 Event Notification\n\n* Enable S3 to send events to EventBridge when an object is created.\n\n### Amazon CloudWatch Events Rule\n\n* Grant least privilege permissions to CloudWatch Events to trigger the Lambda Function\n\n### AWS Step Function\n\n* Enable CloudWatch logging for API Gateway\n* Deploy best practices CloudWatch Alarms for the Step Function\n\n## Architecture\n\n\n\n---\n\n\n\u00a9 Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.\n\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "CDK Constructs for AWS S3 to AWS Step Function integration",
"version": "1.181.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "a1fd8927a8f185a0bf18b780e0a328a4",
"sha256": "92fb475e4c456aff27b9409fb975fc780500cf5fa8d72cfb2da500fc1e7e6b00"
},
"downloads": -1,
"filename": "aws_solutions_constructs.aws_s3_step_function-1.181.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a1fd8927a8f185a0bf18b780e0a328a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.7",
"size": 209617,
"upload_time": "2022-12-02T03:32:33",
"upload_time_iso_8601": "2022-12-02T03:32:33.665802Z",
"url": "https://files.pythonhosted.org/packages/96/2e/1a70f0d03819779db56ef75843cda28cb48e53d92e76cce9c8f93669a620/aws_solutions_constructs.aws_s3_step_function-1.181.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "44ac743cb7d359eee8fce7c06a6c01e6",
"sha256": "baf2ad80f4f413f3410185b26aad559c6297cc868883083d9ae531ef54d5e9ff"
},
"downloads": -1,
"filename": "aws-solutions-constructs.aws-s3-step-function-1.181.1.tar.gz",
"has_sig": false,
"md5_digest": "44ac743cb7d359eee8fce7c06a6c01e6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.7",
"size": 211028,
"upload_time": "2022-12-02T03:34:39",
"upload_time_iso_8601": "2022-12-02T03:34:39.611222Z",
"url": "https://files.pythonhosted.org/packages/9c/62/2ba952d96024b93abb0366d2b5e5d8d686886a8dd9841d7e713ec7c86455/aws-solutions-constructs.aws-s3-step-function-1.181.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-02 03:34:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "awslabs",
"github_project": "aws-solutions-constructs.git",
"lcname": "aws-solutions-constructs.aws-s3-step-function"
}
JSON
