# @aws-solutions-constructs/aws-events-rule-step-function

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

Latest version **1.146.0** (published 2022-03-02) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @aws-solutions-constructs/aws-events-rule-step-function
pnpm add @aws-solutions-constructs/aws-events-rule-step-function
yarn add @aws-solutions-constructs/aws-events-rule-step-function
bun add @aws-solutions-constructs/aws-events-rule-step-function
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.146.0 |
| Published | 2022-03-02 |
| First published | 2020-06-22 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 257.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1358 |
| Author | Amazon Web Services |
| Maintainers | aws-solutions-constructs-team |
| Keywords | aws, cdk, awscdk, AWS Solutions Constructs, Amazon EventBridge, AWS Step Functions |

## Links

- npm: https://www.npmjs.com/package/@aws-solutions-constructs/aws-events-rule-step-function
- Repository: https://github.com/awslabs/aws-solutions-constructs
- Homepage: https://github.com/awslabs/aws-solutions-constructs#readme
- Issues: https://github.com/awslabs/aws-solutions-constructs/issues
- npm.io page: https://npm.io/package/@aws-solutions-constructs/aws-events-rule-step-function

## Dependencies (11)

- [constructs](https://npm.io/package/constructs.md) ^3.2.0
- [@aws-cdk/core](https://npm.io/package/@aws-cdk/core.md) 1.146.0
- [@aws-cdk/aws-iam](https://npm.io/package/@aws-cdk/aws-iam.md) 1.146.0
- [@aws-cdk/aws-logs](https://npm.io/package/@aws-cdk/aws-logs.md) 1.146.0
- [@aws-cdk/aws-events](https://npm.io/package/@aws-cdk/aws-events.md) 1.146.0
- [@aws-cdk/aws-lambda](https://npm.io/package/@aws-cdk/aws-lambda.md) 1.146.0
- [@aws-cdk/aws-cloudwatch](https://npm.io/package/@aws-cdk/aws-cloudwatch.md) 1.146.0
- [@aws-cdk/aws-stepfunctions](https://npm.io/package/@aws-cdk/aws-stepfunctions.md) 1.146.0
- [@aws-solutions-constructs/core](https://npm.io/package/@aws-solutions-constructs/core.md) 1.146.0
- [@aws-cdk/aws-stepfunctions-tasks](https://npm.io/package/@aws-cdk/aws-stepfunctions-tasks.md) 1.146.0
- [@aws-solutions-constructs/aws-eventbridge-stepfunctions](https://npm.io/package/@aws-solutions-constructs/aws-eventbridge-stepfunctions.md) 1.146.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.146.0 (latest) — 2022-03-02
- 1.181.1 (v1-latest) — 2022-12-02
- 1.181.0 — 2022-12-02
- 1.180.0 — 2022-12-02
- 1.179.0 — 2022-12-02
- 1.178.0 — 2022-12-02
- 1.177.0 — 2022-12-01
- 1.176.0 — 2022-12-01
- 1.175.0 — 2022-12-01
- 1.174.0 — 2022-12-01
- 1.173.0 — 2022-09-18
- 1.172.0 — 2022-09-18
- 1.171.0 — 2022-09-18
- 1.170.1 — 2022-09-18
- 1.170.0 — 2022-09-14
- … 139 more at https://npm.io/package/@aws-solutions-constructs/aws-events-rule-step-function/versions

## README

# aws-events-rule-step-function module
<!--BEGIN STABILITY BANNER-->

---

![Stability: Deprecated](https://img.shields.io/badge/STABILITY-DEPRECATED-red?style=for-the-badge)

> 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.

---
<!--END STABILITY BANNER-->

| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
|:-------------|:-------------|
<div style="height:8px"></div>

| **Language**     | **Package**        |
|:-------------|-----------------|
|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_events_rule_step_function`|
|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-events-rule-step-function`|
|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) 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:

``` javascript
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

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

_Parameters_

* scope [`Construct`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html)
* id `string`
* props [`EventsRuleToStepFunctionProps`](#pattern-construct-props)

## Pattern Construct Props

| **Name**     | **Type**        | **Description** |
|:-------------|:----------------|-----------------|
|stateMachineProps|[`sfn.StateMachineProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-stepfunctions.StateMachineProps.html)|Optional user provided props to override the default props for sfn.StateMachine|
|existingEventBusInterface?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.IEventBus.html)| Optional user-provided custom EventBus for construct to use. Providing both this and `eventBusProps` results an error.|
|eventBusProps?|[`events.EventBusProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.EventBusProps.html)|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`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.RuleProps.html)|User provided eventRuleProps to override the defaults|
|createCloudWatchAlarms|`boolean`|Whether to create recommended CloudWatch alarms|
|logGroupProps?|[`logs.LogGroupProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroupProps.html)|User provided props to override the default props for for the CloudWatchLogs LogGroup.|

## Pattern Properties

| **Name**     | **Type**        | **Description** |
|:-------------|:----------------|-----------------|
|eventBus?|[`events.IEventBus`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.IEventBus.html)|Returns the instance of events.IEventBus used by the construct|
|eventsRule|[`events.Rule`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.Rule.html)|Returns an instance of events.Rule created by the construct|
|stateMachine|[`sfn.StateMachine`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-stepfunctions.StateMachine.html)|Returns an instance of sfn.StateMachine created by the construct|
|stateMachineLogGroup|[`logs.ILogGroup`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.ILogGroup.html)|Returns an instance of the ILogGroup created by the construct for StateMachine|
|cloudwatchAlarms?|[`cloudwatch.Alarm[]`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-cloudwatch.Alarm.html)|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
![Architecture Diagram](architecture.png)

***
&copy; Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

---
_Source: https://npm.io/package/@aws-solutions-constructs/aws-events-rule-step-function · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._