aws-events-rule-step-function - AWS Solutions Constructs

aws-events-rule-step-function

Language Package
Python aws_solutions_constructs.aws_events_rule_step_function
Typescript @aws-solutions-constructs/aws-events-rule-step-function
Java software.amazon.awsconstructs.services.eventsrulestepfunction

Overview

This AWS Solutions Construct implements an AWS Events rule and an AWS Step function.

Here is a minimal deployable pattern definition:

Typescript
// aws-events-rule-step-function has been deprecated for CDK V2 in favor of aws-eventbridge-stepfunctions. // This sample uses the CDK V1 syntax import * as cdk from '@aws-cdk/core'; import * as events from '@aws-cdk/aws-events'; import * as stepfunctions from '@aws-cdk/aws-stepfunctions'; import { EventsRuleToStepFunction, EventsRuleToStepFunctionProps } from '@aws-solutions-constructs/aws-events-rule-step-function'; const startState = new stepfunctions.Pass(this, 'StartState'); const constructProps: EventsRuleToStepFunctionProps = { stateMachineProps: { definition: startState }, eventRuleProps: { schedule: events.Schedule.rate(cdk.Duration.minutes(5)) } }; new EventsRuleToStepFunction(this, 'test-events-rules-step-function-stack', constructProps);
Python
# aws-events-rule-step-function has been deprecated for CDK V2 in favor of aws-eventbridge-stepfunctions. # This sample uses the CDK V1 syntax from aws_solutions_constructs.aws_events_rule_step_function import EventsRuleToStepFunction, EventsRuleToStepFunctionProps from aws_cdk import ( aws_stepfunctions as stepfunctions, aws_events as events, core ) startState = stepfunctions.Pass(self, 'StartState') EventsRuleToStepFunction(self, 'test', state_machine_props=stepfunctions.StateMachineProps( definition=startState ), event_rule_props=events.RuleProps( schedule=events.Schedule.rate( core.Duration.minutes(5)) ))
Java
// aws-events-rule-step-function has been deprecated for CDK V2 in favor of aws-eventbridge-stepfunctions. // This sample uses the CDK V1 syntax import software.constructs.Construct; import software.amazon.awscdk.core.*; import software.amazon.awscdk.services.events.*; import software.amazon.awscdk.services.stepfunctions.*; import software.amazon.awsconstructs.services.eventsrulestepfunction.*; final Pass startState = new Pass(this, "StartState"); new EventsRuleToStepFunction(this, "test-eventbridge-stepfunctions-stack", new EventsRuleToStepFunctionProps.Builder() .stateMachineProps(new StateMachineProps.Builder() .definition(startState) .build()) .eventRuleProps(new RuleProps.Builder() .schedule(Schedule.rate(Duration.minutes(5))) .build()) .build());

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

GitHub

To view the code for this pattern, create/view issues and pull requests, and more:
@aws-solutions-constructs/aws-events-rule-step-function