本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。 # aws-Api网关/动力流 ![\[alt text not found\]](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/experimental.png) 所有类都处于积极开发之中，并且在任何未来版本中都会受到非向后兼容的更改或删除。这些不受[语义版本控制](https://semver.org/)模型。这意味着，虽然您可以使用它们，但在升级到此软件包的较新版本时，您可能需要更新源代码。 **注意：** 为确保正确的功能，您项目中的 AWS 解决方案构造软件包和 AWS CDK 包必须是相同的版本。 | **语言** | **程序包** | | --- | --- | | ![\[alt text not found\]](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/python.png) Python | aws\$1solutions\$1constructs.aws\$1apigateway\$1kinesisstreams | | ![\[alt text not found\]](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/typescript.png) TypeScript | @aws-solutions-constructs/aws-apigateway-kinesisstreams | | ![\[alt text not found\]](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/java.png) Java | software.amazon.awsconstructs.services.apigatewaykinesisstreams | ## Overview 此模式实现了与亚马逊 Kinesis 数据流连接的 Amazon API Gateway REST API。 以下是 TypeScript 中的最小可部署模式定义： ``` import { ApiGatewayToKinesisStreams, ApiGatewayToKinesisStreamsProps } from '@aws-solutions-constructs/aws-apigateway-kinesisstreams'; new ApiGatewayToKinesisStreams(this, 'test-apigw-kinesis', {}); ``` ## Initializer ``` new ApiGatewayToKinesisStreams(scope: Construct, id: string, props: ApiGatewayToKinesisStreamsProps); ``` *参数* + 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[`ApiGatewayToKinesisStreamsProps`](#pattern-construct-props-29) ## 模式构建道具 | **名称** | **类型** | **描述** | | --- | --- | --- | | 养蜂网关道具？ | [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApiProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApiProps.html) | 用户提供的可选道具，用于覆盖 API Gateway REST API 的默认道具。 | | 是否记录请求模板？ | string | PutRecord tory 操作的 API Gateway 请求模板。如果未提供，将使用默认值。 | | 是否记录请求模型？ | [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.ModelOptions.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.ModelOptions.html) | PutRecord tory 操作的 API Gateway 请求模型。如果未提供，则将创建一个默认值。 | | 打破记录请求模板？ | string | PutRecords 操作的 API Gateway 请求模板。如果未提供，将使用默认值。 | | 是否记录请求模型？ | [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.ModelOptions.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.ModelOptions.html) | PutRecords 操作的 API Gateway 请求模型。如果未提供，则将创建一个默认值。 | | 现有的河流 J？ | [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kinesis.Stream.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kinesis.Stream.html) | 现有的 Kinesis 流实例，提供了这个和kinesisStreamProps会导致错误。 | | 运动流道具？ | [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kinesis.StreamProps.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kinesis.StreamProps.html) | 用户提供的可选道具，用于覆盖 Kinesis 流的默认道具。 | | 日志组道具？ | [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 日志组的默认道具。 | ## 模式属性 | **名称** | **类型** | **描述** | | --- | --- | --- | | APIGateway Gateway | [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApi.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApi.html) | 返回由模式创建的 API Gateway REST API 的实例。 | | 养蜂网关角色 | [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html) | 返回由 API Gateway REST API 模式创建的 IAM 角色的实例。 | | 网关云监视角色 | [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-iam.Role.html) | 返回由模式创建的 IAM 角色的实例，该模式允许从 API Gateway REST API 访问日志记录到 CloudWatch。 | | 网关日志组 | [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) | 返回由 API Gateway REST API 访问日志发送到的模式创建的日志组的实例。 | | KinesisStream | [https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kinesis.Stream.html](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kinesis.Stream.html) | 返回由模式创建的 Kinesis 流的实例。 | ## 示例 API 使用量 | **方法** | **请求路径** | **请求正文** | **队列操作** | **描述** | | --- | --- | --- | --- | --- | | POST | /record | 
{ 
  "data": "Hello World!", 
  "partitionKey": "pk001"
}
| kinesis:PutRecord | 将单个数据记录写入流。 | | POST | /records | 
{ 
    "records": [
      { "data": "abc", 
        "partitionKey": "pk001" 
      }, 
      { "data": "xyz", 
        "partitionKey": "pk001" 
      }
     ] 
}
| kinesis:PutRecords | 在一次调用中将多个数据记录写入流。 | ## 默认设置 没有任何覆盖的此模式的开箱即用实现将设置以下默认值： ### Amazon API Gateway + 部署边缘优化的 API 终端节点。 + 为 API Gateway 启用 CloudWatch 日志记录。 + 为 API Gateway 配置最低权限访问 IAM 角色。 + 将所有 API 方法的默认授权类型设置为 IAM。 + 启用 X-Ray 跟踪。 + 在将数据传递给 Kinesis 之前验证请求正文。 ### Amazon Kinesis Data Stream + 为 Kinesis 流配置最低权限访问 IAM 角色。 + 使用 AWS 托管 KMS 密钥为 Kinesis 流启用服务器端加密。 ## Architecture ![\[Diagram showing data flow between cloud search, code analysis, and network components.\]](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/aws-apigateway-kinesisstreams.png) ## GitHub | **要查看此模式的代码、创建/查看问题和拉取请求等，请执行以下操作：** | | --- | | ![\[Circular icon with a graduation cap symbol representing education or learning.\]](http://docs.aws.amazon.com/zh_cn/solutions/latest/constructs/images/GitHub-Mark-32px.png) | [@aws-解决方案结构/AWS-网关-动态流](https://github.com/awslabs/aws-solutions-constructs/tree/master/source/patterns/%40aws-solutions-constructs/aws-apigateway-kinesisstreams) |