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

# AWS 事件规则平方米
<a name="aws-events-rule-sqs"></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\_sqs  | 
|  ![](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/typescript.png) TypeScript  |  @aws-solutions-constructs/aws-events-rule-sqs  | 
|  ![](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/java.png) Java  |  software.amazon.awsconstructs.services.eventsrulesqs  | 

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

 此模式实现与 Amazon SQS 队列相连的 Amazon CloudWatch Events 规则。

 这是一个最小的可部署模式定义：

```
import { Duration } from '@aws-cdk/core';
import * as events from '@aws-cdk/aws-events';
import * as iam from '@aws-cdk/aws-iam';
import { EventsRuleToSqsProps, EventsRuleToSqs } from "@aws-solutions-constructs/aws-events-rule-sqs";

const props: EventsRuleToSqsProps = {
    eventRuleProps: {
      schedule: events.Schedule.rate(Duration.minutes(5))
    }
};

const constructStack = new EventsRuleToSqs(this, 'test-construct', props);

// Grant yourself permissions to use the Customer Managed KMS Key
const policyStatement = new iam.PolicyStatement({
    actions: ["kms:Encrypt", "kms:Decrypt"],
    effect: iam.Effect.ALLOW,
    principals: [ new iam.AccountRootPrincipal() ],
    resources: [ "*" ]
});

constructStack.encryptionKey?.addToResourcePolicy(policyStatement);
```

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

```
new EventsRuleToSqs(scope: Construct, id: string, props: EventsRuleToSqsProps);
```

 *参数* 
+  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[`EventsRuleToSqsProps`](#pattern-construct-props-31) 

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


|  **名称**  |  **类型**  |  **描述**  | 
| --- | --- | --- | 
|  事件道具  |  [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)  |  用户提供的属性，用于覆盖 CloudWatch 事件规则的默认属性。 | 
|  现有队列 OBJ？  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html)  |  要使用的可选现有 SQS 队列，而不是默认队列。同时提供此和queueProps会导致错误。 | 
|  队列道具？  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.QueueProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.QueueProps.html)  |  用户提供的可选属性，用于覆盖 SQS 队列的默认属性。忽略，如果existingQueueObj提供。 | 
|  是否启用队列清除？  |  boolean  |  是否向 Lambda 函数授予其他权限，使其能够清除 SQS 队列。默认值为 false。 | 
|  部署死信件队列？  |  boolean  |  是否创建要用作死信队列的辅助队列。默认值为 true。 | 
|  死书队列道具？  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.QueueProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.QueueProps.html)  |  用户提供的可选道具，用于覆盖死信队列的默认道具。仅当deployDeadLetterQueue属性设置为 true。 | 
|  maxReceiveCount？  |  number  |  消息在发送到死信队列之前可能会失败出队的次数。默认值为 15。 | 
|  是否启用用客户管理的密钥加密？  |  boolean  |  是否使用由此 CDK 应用程序管理或导入的客户管理的加密密钥。如果导入加密密钥，则必须在encryptionKey属性。 | 
|  encryptionKey？  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kms.Key.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kms.Key.html)  |  要使用的可选现有加密密钥，而不是默认加密密钥。 | 
|  加密钥匙道具？  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kms.KeyProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kms.KeyProps.html)  |  用户提供的可选属性，用于覆盖加密密钥的默认属性。 | 

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


|  **名称**  |  **类型**  |  **描述**  | 
| --- | --- | --- | 
|  事件规则  |  [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)  |  返回由模式创建的事件规则的实例。 | 
|  SQUUE  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html)  |  返回由模式创建的 SQS 队列的实例。 | 
|  encryptionKey  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kms.Key.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kms.Key.html)  |  返回由模式创建的加密密钥的实例。 | 
|  死信队列？  |  [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html)  |  返回由模式创建的死信队列的实例（如果已部署）。 | 

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

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

### Amazon CloudWatch Events 规则
<a name="amazon-events-rule-31"></a>
+  向 CloudWatch 事件授予最低权限以发布到 SQS 队列的权限。

### Amazon SQS 队列
<a name="amazon-sqs-31"></a>
+  为源队列部署死信队列。
+  使用客户托管的 AWS KMS 密钥为源队列启用服务器端加密。
+  强制对传输中数据加密。

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

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


## GitHub
<a name="github-31"></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-sqs) </td></tr>
</tbody>
</table>