AWS CloudFormation
User Guide (API Version 2010-05-15)
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

AWS::Kinesis::Stream

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

语法

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

JSON

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

YAML

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

属性

注意

有关每个属性的约束和值的更多信息,请参阅 Amazon Kinesis API Reference 中的 CreateStreamAmazon Kinesis Developer Guide 中的 Amazon Kinesis Streams 限制

Name

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

重要

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

Required: No

Type: String

更新要求替换

RetentionPeriodHours

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

Required: No

Type: Integer

更新要求无需中断

ShardCount

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

Required: Yes

Type: Integer

更新要求无需中断

Tags

要与 Kinesis 流关联的任意标签组(键/值对)。有关该属性的约束的更多信息,请参阅 Amazon Kinesis Developer Guide 中的标签限制

Required: No

Type: AWS CloudFormation 资源标签

更新要求无需中断

返回值

Ref

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

有关使用 Ref 功能的更多信息,请参阅参考

Fn::GetAtt

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

Arn

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

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

示例

下面的示例创建一个 Stream 资源,该资源使用三个分片并设置七天的保留期。

JSON

"MyStream": { "Type": "AWS::Kinesis::Stream", "Properties": { "Name": "MyKinesisStream", "RetentionPeriodHours" : 168, "ShardCount": 3, "Tags": [ { "Key": "Environment", "Value": "Production" } ] } }

YAML

MyStream: Type: 'AWS::Kinesis::Stream' Properties: Name: MyKinesisStream RetentionPeriodHours: 168 ShardCount: 3 Tags: - Key: Environment Value: Production

本页内容: