Package Exports
- @aws-solutions-constructs/aws-s3-step-function
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@aws-solutions-constructs/aws-s3-step-function) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
aws-s3-step-function 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_step_function |
 Typescript |
@aws-solutions-constructs/aws-s3-step-function |
 Java |
software.amazon.awsconstructs.services.s3stepfunction |
This AWS Solutions Construct implements an Amazon S3 bucket connected to an AWS Step Function.
Here is a minimal deployable pattern definition:
const { S3ToStepFunction, S3ToStepFunctionProps } = require('@aws-solutions-constructs/aws-s3-step-function');
const startState = new stepfunctions.Pass(stack, 'StartState');
const props: S3ToStepFunctionProps = {
stateMachineProps: {
definition: startState
}
};
new S3ToStepFunction(stack, 'test-s3-step-function-stack', props);Initializer
new S3ToStepFunction(scope: Construct, id: string, props: S3ToStepFunctionProps);Parameters
- scope
Construct - id
string - props
S3ToStepFunctionProps
Pattern Construct Props
| Name | Type | Description |
|---|---|---|
| existingBucketObj? | s3.Bucket |
Existing instance of S3 Bucket object, if this is set then the bucketProps is ignored. |
| bucketProps? | s3.BucketProps |
User provided props to override the default props for the S3 Bucket. |
| stateMachineProps | sfn.StateMachineProps |
Optional 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 |
Pattern Properties
| Name | Type | Description |
|---|---|---|
| stateMachine | sfn.StateMachine |
Returns an instance of sfn.StateMachine created by the construct |
| 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 |
| cloudtrail | cloudtrail.Trail |
Returns an instance of the cloudtrail.Trail 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
- Turn on the versioning for S3 Bucket
- Don't allow public access for S3 Bucket
- Retain the S3 Bucket when deleting the CloudFormation stack
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 Function
- Enable CloudWatch logging for API Gateway
- Deploy best practices CloudWatch Alarms for the Step Function
Architecture
© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.