本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

# aws-事件-规则步进函数
<a name="aws-events-rule-step-function"></a>

![](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/experimental.png)


 所有类都处于积极开发之中，并且在任何未来版本中都会受到非向后兼容的更改或删除。这些不受[语义版本控制](https://semver.org/)模型。这意味着，虽然您可以使用它们，但在升级到此软件包的较新版本时，您可能需要更新源代码。

**注意：** 为确保正确的功能，您项目中的 AWS 解决方案构造软件包和 AWS CDK 包必须是相同的版本。


|  **语言**  |  **程序包**  | 
| --- | --- | 
|  ![](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/python.png) Python  |  aws\_solutions\_constructs.aws\_events\_rule\_step\_function  | 
|  ![](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/typescript.png) TypeScript  |  @aws-solutions-constructs/aws-events-rule-step-function  | 
|  ![](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/java.png) Java  |  software.amazon.awsconstructs.services.eventsrulestepfunction  | 

## Overview
<a name="overview-10"></a>

 此 AWS 解决方案构造实现了 AWS 事件规则和 AWS 步骤函数。

 以下是 TypeScript 中的最小可部署模式定义：

```
import { 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(this, 'test-events-rule-step-function-stack', props);
```

## Initializer
<a name="initializer-10"></a>

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

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

## 模式构建道具
<a name="pattern-construct-props-10"></a>


|  **名称**  |  **类型**  |  **描述**  | 
| --- | --- | --- | 
|  国家道具  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-stepfunctions.StateMachineProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-stepfunctions.StateMachineProps.html)  |  用户提供的可选道具来覆盖 SFN.Statemachine 的默认道具  | 
|  事件道具  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.RuleProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.RuleProps.html)  |  用户提供的事件道具来覆盖默认值  | 
|  创造云监视图  |  boolean  |  是否创建推荐的 CloudWatch 警报。 | 
|  日志组道具？  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroupProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroupProps.html)  |  用户提供的可选道具，用于覆盖 CloudWatch Logs 日志组的默认道具。 | 

## 模式属性
<a name="pattern-properties-10"></a>


|  **名称**  |  **类型**  |  **描述**  | 
| --- | --- | --- | 
|  CloudWatch  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-cloudwatch.Alarm.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-cloudwatch.Alarm.html)  |  返回模式创建的一个或多个 CloudWatch 警报的列表。 | 
|  事件规则  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.Rule.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-events.Rule.html)  |  返回由模式创建的事件规则的实例。 | 
|  StatataMachine  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-stepfunctions.StateMachine.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-stepfunctions.StateMachine.html)  |  返回由模式创建的状态机的实例。 | 
|  国家机械学组  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroup.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-logs.LogGroup.html)  |  返回由状态机模式创建的日志组的实例。 | 

## 默认设置
<a name="default-settings-10"></a>

 没有任何覆盖的此模式的开箱即用实现将设置以下默认值：

### Amazon CloudWatch Events 规则
<a name="amazon-cloudwatch-events-rule-1"></a>
+  向 CloudWatch 事件授予最低权限以触发 Lambda 函数 

### AWS Step Function
<a name="aws-step-function"></a>
+  启用 API Gateway 的 CloudWatch 日志 
+  针对步进功能部署最佳实践 CloudWatch 警报 

## Architecture
<a name="architecture-10"></a>

![](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/aws-events-rule-step-function.png)


## GitHub
<a name="github-10"></a>


<table>
<thead>
  <tr><th colspan="2"> 要查看此模式的代码、创建/查看问题和拉取请求等，请执行以下操作： </th></tr>
</thead>
<tbody>
  <tr><td> ![](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/GitHub-Mark-32px.png) </td><td> [@aws-解决方案结构/awS-事件-规则步进函数](https://github.com/awslabs/aws-solutions-constructs/tree/master/source/patterns/%40aws-solutions-constructs/aws-events-rule-step-function) </td></tr>
</tbody>
</table>