CDK Constructs for deploying AWS Events Rule that invokes AWS Step Functions
Project description
aws-eventbridge-stepfunctions module
---Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
aws_solutions_constructs.aws_eventbridge_stepfunctions |
|
@aws-solutions-constructs/aws-eventbridge-stepfunctions |
|
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
Close
Hashes for aws-solutions-constructs.aws-eventbridge-stepfunctions-2.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 71113bf540cb4f18dc0fe2a293aebd485427d1f1b5a9407fd8e9c9d0c524a69f |
|
MD5 | 789be74fabc275093e466c3be9241e25 |
|
BLAKE2b-256 | 238eb5126ba431942086e1a159be08703660e932546901121f157ae2c88986b8 |
Close
Hashes for aws_solutions_constructs.aws_eventbridge_stepfunctions-2.5.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ce052413cd11f900a02cd46cc55acaee3b611b3e0e18c5e9e8df6a7ad3c9f2d0 |
|
MD5 | 8ced594344721a299e250756af3502d7 |
|
BLAKE2b-256 | 1e26bd1acf8b85328102586fc52c8213ba395249fa0ddd2145d449ec46330b89 |