AWS::QLDB::Stream - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::QLDB::Stream

AWS::QLDB::Stream 资源为给定的 Amazon Quantum Ledger Database (Amazon QLDB) 分类账创建日志流。流捕获提交到分类账的日志的每个文档修订版本,并将数据传送到指定的 Amazon Kinesis Data Streams 资源。

有关更多信息,请参阅 Amazon QLDB API 参考 中的 StreamJournalToKinesis

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::QLDB::Stream", "Properties" : { "ExclusiveEndTime" : String, "InclusiveStartTime" : String, "KinesisConfiguration" : KinesisConfiguration, "LedgerName" : String, "RoleArn" : String, "StreamName" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::QLDB::Stream Properties: ExclusiveEndTime: String InclusiveStartTime: String KinesisConfiguration: KinesisConfiguration LedgerName: String RoleArn: String StreamName: String Tags: - Tag

属性

ExclusiveEndTime

指定流结束时间的日期和时间(不内含)。如果不定义此参数,则流将无限期运行,直到您取消它。

ExclusiveEndTime 必须采用 ISO 8601 日期和时间格式以及通用协调时间 (UTC)。例如:2019-06-13T21:36:34Z

必需:否

类型:字符串

Update requires: Replacement

InclusiveStartTime

开始流式传输日志数据的开始日期和时间(内含)。此参数必须采用 ISO 8601 日期和时间格式以及通用协调时间 (UTC)。例如:2019-06-13T21:36:34Z

InclusiveStartTime 不能是未来时间,必须在 ExclusiveEndTime 之前。

如果您提供的 InclusiveStartTime 是在分类账的 CreationDateTime 之前,则 QLDB 有效地将其默认视为分类账的 CreationDateTime

必需:是

类型:字符串

Update requires: Replacement

KinesisConfiguration

流请求的 Kinesis 数据流目标的配置设置。

必需:是

类型KinesisConfiguration

Update requires: Replacement

LedgerName

分类账的名称。

必需:是

类型:字符串

最低1

最高32

模式(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Update requires: Replacement

RoleArn

IAM 角色的 Amazon 资源名称 (ARN),该名称授予日志流将数据记录写入 Kinesis 数据流资源的 QLDB 权限。

必需:是

类型:字符串

最低20

最高1600

Update requires: Replacement

StreamName

要分配给 QLDB 日志流的名称。用户定义的名称有助于识别和指示流的用途。

您的流名称在给定分类账的其他活动的 流中必须是唯一的。流名称与分类账名称具有相同的命名限制,如在 Amazon QLDB 开发人员指南Amazon QLDB 中的配额 中定义。

必需:是

类型:字符串

最低1

最高32

模式(?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Update requires: Replacement

Tags

要应用于此资源的键值对的数组。

有关更多信息,请参阅标签

必需:否

类型Tag 的列表

Update requires: No interruption

返回值

Ref

在将此资源的逻辑 ID 传递给内部 Ref 函数时,Ref 返回资源 ID 或 ARN。例如:

{ "Ref": "myQLDBStream" }

对于具有逻辑 ID myQLDBStream 的资源,Ref 返回 Amazon QLDB 日志流的 ID 或 ARN。

For more information about using the Ref function, see Ref.

Fn::GetAtt

Fn::GetAtt 内部函数返回此类型的一个指定属性的值。以下为可用属性和示例返回值。

有关使用 Fn::GetAtt 内部函数的更多信息,请参阅 Fn::GetAtt

Arn

QLDB 日志流的 Amazon 资源名称 (ARN)。例如:arn:aws:qldb:us-east-1:123456789012:stream/exampleLedger/IiPT4brpZCqCq3f4MTHbYy

Id

QLDB 分配给每个 QLDB 日志流的唯一 ID。例如:IiPT4brpZCqCq3f4MTHbYy

示例

Amazon QLDB 流

以下示例描述名为 exampleLedger 的分类账的 Amazon QLDB 日志流,以及具有 ARN arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb 的 Kinesis 数据流目标。

JSON

{ "AWSTemplateFormatVersion" : "2010-09-09", "Resources" : { "myQLDBStream": { "Type": "AWS::QLDB::Stream", "Properties": { "ExclusiveEndTime" : "2020-05-29T22:59:59Z", "InclusiveStartTime" : "2020-05-29T00:00:00Z", "KinesisConfiguration" : { "AggregationEnabled": true, "StreamArn": "arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb" }, "LedgerName" : "exampleLedger", "RoleArn" : "arn:aws:iam::123456789012:role/my-kinesis-stream-role", "StreamName" : "exampleLedger-stream", "Tags": [ { "Key": "Domain", "Value": "Test" } ] } } } }

YAML

AWSTemplateFormatVersion: "2010-09-09" Resources: myQLDBStream: Type: "AWS::QLDB::Stream" Properties: ExclusiveEndTime: "2020-05-29T22:59:59Z" InclusiveStartTime: "2020-05-29T00:00:00Z" KinesisConfiguration: AggregationEnabled: true StreamArn: "arn:aws:kinesis:us-east-1:123456789012:stream/stream-for-qldb" LedgerName: "exampleLedger" RoleArn: "arn:aws:iam::123456789012:role/my-kinesis-stream-role" StreamName: "exampleLedger-stream" Tags: - Key: Domain Value: Test

另请参阅