メニュー
AWS CloudFormation
ユーザーガイド (API Version 2010-05-15)

AWS::Kinesis::Stream

データソースから出力されたデータレコードをキャプチャして転送する Kinesis ストリームを作成します。ストリームの作成については、Amazon Kinesis API Reference の「CreateStream」を参照してください。

構文

AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。

JSON

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

YAML

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

プロパティ

注記

各プロパティの制約と値の詳細については、『Amazon Kinesis API Reference』の「CreateStream」および『Amazon Kinesis Developer Guide』の「Amazon Kinesis Streams の制限」を参照してください。

Name

Kinesis ストリームの名前。名前を指定しないと、AWS CloudFormation は一意の物理 ID を生成し、その ID をストリーム名として使用します。詳細については、「Name タイプ」を参照してください。

重要

名前を指定すると、このリソースの置換が必要な更新はできません。中断が不要であるか、一定の中断が必要な更新であれば、行うことができます。リソースを置き換える必要がある場合は、新しい名前を指定します。

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 Resource Tags

更新に伴う要件: 中断はありません。

戻り値

参照番号

Ref 関数の引数として AWS::Kinesis::Stream リソースを指定すると、AWS CloudFormation からは、ストリーム名 (物理 ID) が返されます。

Ref 関数の使用方法の詳細については、「Ref」を参照してください。

Fn::GetAtt

Fn::GetAtt は、Arn 属性の値を返します。

Arn

Kinesis ストリームの Amazon リソース名 (ARN) (arn:aws:kinesis:us-east-2:123456789012:stream/mystream など)。

Fn::GetAtt の使用の詳細については、「Fn::GetAtt」を参照してください。

次の例では、3 つのシャードを使用し、7 日間の保存期間を設定する Stream リソースを作成します。

JSON

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

YAML

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

このページの内容: