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

AWS::Kinesis::Stream

创建捕获和传输从数据源发出的数据记录的 Kinesis 流。有关创建流的信息,请参阅《Amazon Kinesis API 参考》中的 CreateStream

语法

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

JSON

{ "Type" : "AWS::Kinesis::Stream", "Properties" : { "Name" : String, "RetentionPeriodHours" : Integer, "ShardCount" : Integer, "StreamEncryption" : StreamEncryption, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::Kinesis::Stream Properties: Name: String RetentionPeriodHours: Integer ShardCount: Integer StreamEncryption: StreamEncryption Tags: - Tag

属性

Name

Kinesis 流的名称。如果不指定名称,则 AWS CloudFormation 会生成一个唯一的物理 ID 并将该 ID 用于流名称。有关更多信息,请参阅名称类型

如果指定一个名称,您将无法执行需要替换该资源的更新。您可以执行不需要或者只需要部分中断的更新。如果必须替换资源,请指定新名称。

必需:否

类型:字符串

最低1

最高128

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

Update requires: Replacement

RetentionPeriodHours

存储在分片中的数据记录保持可访问状态的时长 (小时)。默认值是 24。有关流的保留期的更多信息,请参阅《Amazon Kinesis 开发人员指南》中的更改数据保留期

必需:否

类型:整数

Update requires: No interruption

ShardCount

流使用的分片数。要获得更大的配置吞吐量,请增加分片数。

必需:是

类型:整数

最低1

Update requires: No interruption

StreamEncryption

在指定此项时,为指定流启用或更新使用 AWS KMS 密钥的服务器端加密。从堆栈模板中删除此属性并更新堆栈时,将禁用加密。

必需:否

类型StreamEncryption

Update requires: No interruption

Tags

要与 Kinesis 流关联的任意标签组(键/值对)。有关该属性的约束的信息,请参阅 Amazon Kinesis 开发人员指南 中的标签限制

必需:否

类型Tag 的列表

Update requires: No interruption

返回值

Ref

在指定 AWS::Kinesis::Stream 资源作为 Ref 函数的参数时,AWS CloudFormation 返回流名称(物理 ID)。

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

Fn::GetAtt

Fn::GetAtt 返回 Arn 属性的值。

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

Arn

Kinesis 流的 Amazon 资源名称 (ARN),例如 arn:aws:kinesis:us-east-2:123456789012:stream/mystream

示例

创建流

以下示例创建一个 Stream 资源,该资源使用三个分片,设置 7 天的保留期,并指定 KMS 密钥用于服务器端加密。

JSON

"MyStream": { "Type": "AWS::Kinesis::Stream", "Properties": { "Name": "MyKinesisStream", "RetentionPeriodHours" : 168, "ShardCount": 3, "StreamEncryption": { "EncryptionType": "KMS", "KeyId": "!Ref myKey" }, "Tags": [ { "Key": "Environment", "Value": "Production" } ] } }

YAML

MyStream: Type: AWS::Kinesis::Stream Properties: Name: MyKinesisStream RetentionPeriodHours: 168 ShardCount: 3 StreamEncryption: EncryptionType: KMS KeyId: !Ref myKey Tags: - Key: Environment Value: Production