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 |
---|---|
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
Close
Hashes for aws-solutions-constructs.aws-eventbridge-stepfunctions-1.137.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b3e4fe2f8088043522020709f7219ee178a919f396e3ce0bc8c6c1388c81368 |
|
MD5 | ca752f5e129fa062c034d65610fd7e3a |
|
BLAKE2b-256 | 55e8e290df7eaf70aa84daaaa79f6872c8a48cd7a9201265feb89578364bb7bc |
Close
Hashes for aws_solutions_constructs.aws_eventbridge_stepfunctions-1.137.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3fa02de9d1c4134fd1bda520bfda8d9238dc36ac2bec78e9a202cc0a67febd6 |
|
MD5 | deed115984c2a442bb8da3d05787524f |
|
BLAKE2b-256 | 59cc6462ec2ccf6efff8e97f6a8480598489f5035a25f54561fbc13ca21237be |