aws-events-rule-step-function module
---
Some of our early constructs don’t meet the naming standards that evolved for the library. We are releasing completely feature compatible versions with corrected names. The underlying implementation code is the same regardless of whether you deploy the construct using the old or new name. We will support both names for all 1.x releases, but in 2.x we will only publish the correctly named constructs. This construct is being replaced by the functionally identical aws-eventbridge-stepfunctions.
| 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 |
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
© Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
1 maintainer
Metadata
1 maintainer
Release files for aws-solutions-constructs.aws-events-rule-step-function 1.181.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aws-solutions-constructs.aws-events-rule-step-function-1.181.1.tar.gz | 91.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aws_solutions_constructs.aws_events_rule_step_function-1.181.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 181.9 kB
Release files / aws-solutions-constructs.aws-events-rule-step-function-1.181.1.tar.gz
| Download URL | aws-solutions-constructs.aws-events-rule-step-function-1.181.1.tar.gz |
|---|---|
| Size | 91.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
45689ac5e812d3e292bb18101c689d85c0e9f261a8ad4dfbf093c465fd73551b
|
|
BLAKE2b-256 checksum How to use checksums |
534100d9351cf519c667ba72179a3fef96e3d149ca76881ef72eadc6185e5dc1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.12
|
Release files / aws_solutions_constructs.aws_events_rule_step_function-1.181.1-py3-none-any.whl
| Download URL | aws_solutions_constructs.aws_events_rule_step_function-1.181.1-py3-none-any.whl |
|---|---|
| Size | 90.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e08672da6dd674d01c02b4f803b6808103439f1b91dec3c71ee6e348608539c4
|
|
BLAKE2b-256 checksum How to use checksums |
81dd8e92eed20cf09713b9513dbd4bac594a15a2e0a4c2104d272c62226fe396
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.12
|
