CDK Constructs for deploying AWS Events Rule that invokes AWS Step Functions
Project description
aws-eventbridge-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_eventbridge_stepfunctions |
Typescript | @aws-solutions-constructs/aws-eventbridge-stepfunctions |
Java | software.amazon.awsconstructs.services.eventbridgestepfunctions |
This AWS Solutions Construct implements an AWS Events rule and an AWS Step Functions State Machine
Here is a minimal deployable pattern definition in Typescript:
const { EventbridgeToStepfunctions, EventbridgeToStepfunctionsProps } from '@aws-solutions-constructs/aws-eventbridge-stepfunctions';
const startState = new stepfunctions.Pass(this, 'StartState');
const props: EventbridgeToStepfunctionsProps = {
stateMachineProps: {
definition: startState
},
eventRuleProps: {
schedule: events.Schedule.rate(Duration.minutes(5))
}
};
new EventbridgeToStepfunctions(stack, 'test-eventbridge-stepfunctions-stack', props);
Initializer
new EventbridgeToStepfunctions(scope: Construct, id: string, props: EventbridgeToStepfunctionsProps);
Parameters
- scope
Construct
- id
string
- props
EventbridgeToStepfunctionsProps
Pattern Construct Props
Name | Type | Description |
---|---|---|
stateMachineProps | sfn.StateMachineProps |
Optional user provided props to override the default props for sfn.StateMachine |
existingEventBusInterface? | events.IEventBus |
Optional user-provided custom EventBus for construct to use. Providing both this and eventBusProps results an error. |
eventBusProps? | events.EventBusProps |
Optional user-provided properties to override the default properties when creating a custom EventBus. Setting this value to {} will create a custom EventBus using all default properties. If neither this nor existingEventBusInterface is provided the construct will use the default EventBus. Providing both this and existingEventBusInterface results an error. |
eventRuleProps | events.RuleProps |
User provided eventRuleProps to override the defaults |
createCloudWatchAlarms | boolean |
Whether to create recommended CloudWatch alarms |
logGroupProps? | logs.LogGroupProps |
User provided props to override the default props for for the CloudWatchLogs LogGroup. |
Pattern Properties
Name | Type | Description |
---|---|---|
eventBus? | events.IEventBus |
Returns the instance of events.IEventBus used by the construct |
eventsRule | events.Rule |
Returns an instance of events.Rule created by the construct |
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 |
Default settings
Out of the box implementation of the Construct without any override will set the following defaults:
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 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aws-solutions-constructs.aws-eventbridge-stepfunctions-1.124.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8616cb13d7891a09005d628ca57026b2ec15a920da3ef06dbc52e1644b6d2e54 |
|
MD5 | bb9a09d61538dbe31a4a077c71172861 |
|
BLAKE2b-256 | 953890a1df3031409b1410c1a0534ccafc665064593898312911fc7e6365c559 |
Hashes for aws_solutions_constructs.aws_eventbridge_stepfunctions-1.124.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 98df4de186d1319a003a1bd1feb5f4b8df0a62a580c14addbbd21e2b181f686b |
|
MD5 | f88608ec9ff8c7c07baea0bc60af851b |
|
BLAKE2b-256 | 369ffca4d853eb001e96c6a810c7c0769562ec7483f9aacc27d6e88a5b29776e |