aws-solutions-constructs.aws-events-rule-step-function 1.76.0

CDK Constructs for deploying AWS Events Rule that invokes AWS Step Function

aws-events-rule-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_events_rule_step_function
Typescript	@aws-solutions-constructs/aws-events-rule-step-function
Java	software.amazon.awsconstructs.services.eventsrulestepfunction

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

Here is a minimal deployable pattern definition in Typescript:

const { EventsRuleToStepFunction, EventsRuleToStepFunctionProps } from '@aws-solutions-constructs/aws-events-rule-step-function';

const startState = new stepfunctions.Pass(this, 'StartState');

const props: EventsRuleToStepFunctionProps = {
    stateMachineProps: {
      definition: startState
    },
    eventRuleProps: {
      schedule: events.Schedule.rate(Duration.minutes(5))
    }
};

new EventsRuleToStepFunction(stack, 'test-events-rule-step-function-stack', props);

Initializer

new EventsRuleToStepFunction(scope: Construct, id: string, props: EventsRuleToStepFunctionProps);

Parameters

• scope Construct
• id string
• props EventsRuleToStepFunctionProps

Pattern Construct Props

Name	Type	Description
stateMachineProps	sfn.StateMachineProps	Optional user provided props to override the default props for sfn.StateMachine
eventRuleProps	events.RuleProps	User provided eventRuleProps to override the defaults
createCloudWatchAlarms	boolean	Whether to create recommended CloudWatch alarms

Pattern Properties

Name	Type	Description
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.LogGroup	Returns an instance of the LogGroup 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 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.