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

AWS::Kinesis::StreamConsumer

使用 AWS CloudFormation AWS::Kinesis::StreamConsumer 资源将使用者注册到 Kinesis 数据流。然后,您注册的使用者可以调用 SubscribeToShard 以使用增强型扇出从流中接收数据,订阅的每个分片的速率高达每秒 2 MiB。该速率不受从同一个流中读取数据的总使用者数的影响。

您最多可以为每个流注册 5 个使用者。不过,您可以使用 Kinesis Data Streams 限制表单请求提高限制。每次只能在一个流中注册给定的使用者。

有关更多信息,请参阅将使用者与增强型扇出一起使用

语法

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

JSON

{ "Type" : "AWS::Kinesis::StreamConsumer", "Properties" : { "ConsumerName" : String, "StreamARN" : String } }

YAML

Type: AWS::Kinesis::StreamConsumer Properties: ConsumerName: String StreamARN: String

属性

ConsumerName

使用者名称是您在注册使用者时选择的名称。

必需:是

类型:字符串

最低1

最高128

模式[a-zA-Z0-9_.-]+

Update requires: Replacement

StreamARN

将使用者注册到的流的 ARN。

必需:是

类型:字符串

最低1

最高2048

模式arn:aws.*:kinesis:.*:\d{12}:stream/.+

Update requires: Replacement

返回值

Ref

在将 AWS::Kinesis::StreamConsumer 资源的逻辑 ID 传递给内部 Ref 函数时,该函数返回使用者 ARN。有关示例 ARN 格式,请参阅示例 ARN

有关使用 Ref 函数的更多信息,请参阅 Ref

Fn::GetAtt

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

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

ConsumerARN

在注册使用者时,Kinesis Data Streams 为其生成一个 ARN。您需要使用该 ARN 才能调用 SubscribeToShard

如果您删除使用者,然后创建新的同名使用者,它不会具有相同的 ARN。这是因为,使用者 ARN 包含创建时间戳。如果 IAM 策略引用使用者 ARN,请务必记住这一点。

ConsumerCreationTimestamp

创建使用者的时间。

ConsumerName

在注册使用者时为使用者提供的名称。

ConsumerStatus

在处于 CREATINGDELETING 状态时,使用者无法读取数据。

StreamARN

将使用者注册到的数据流的 ARN。

示例

将使用者注册到 Kinesis 数据流

JSON

{ "Parameters": { "TestStreamARN": { "Type": "String" }, "TestConsumerName": { "Type": "String" } }, "Resources": { "StreamConsumer": { "Type": "AWS::Kinesis::StreamConsumer", "Properties": { "StreamARN": { "Ref" : TestStreamARN }, "ConsumerName": { "Ref" : TestConsumerName } } } } }

YAML

Parameters: TestStreamARN: Type: String TestConsumerName: Type: String Resources: StreamConsumer: Type: "AWS::Kinesis::StreamConsumer" Properties: StreamARN: !Ref TestStreamARN ConsumerName: !Ref TestConsumerName