AWS CLI または API を使用して拡張ファンアウトコンシューマーを管理する
Amazon Kinesis Data Streams で拡張ファンアウトを使用するコンシューマーは、シャードあたり 1 秒間に最大 2 MB のデータの専用スループットで、データストリームからレコードを受け取ることができます。詳細については、専用スループットを備えた拡張ファンアウトを開発するを参照してください。
Kinesis Data Streams では、拡張ファンアウトを使用するコンシューマーを登録、説明、一覧表示、登録解除するために、AWS CLI または Kinesis Data Streams API を使用できます。
AWS CLI を使用してコンシューマーを管理する
AWS CLI を使用して、拡張ファンアウトコンシューマーを登録、説明、一覧表示、および登録解除できます。例については、次のドキュメントを参照してください。
- register-stream-consumer
-
Kinesis データストリームにコンシューマーを登録します。コンシューマーの登録時にタグを適用できます。
- describe-stream-consumer
-
登録済みコンシューマーの詳細情報を、コンシューマー ARN またはコンシューマー名とストリーム ARN の組み合わせを指定して取得します。
- list-stream-consumers
-
拡張ファンアウトを使用してストリームからデータを受け取るように登録されているコンシューマーを一覧表示します。
- deregister-stream-consumer
-
コンシューマー ARN、またはコンシューマー名とストリーム ARN の組み合わせのいずれかを指定して、コンシューマーを登録解除します。
Kinesis Data Streams API を使用してコンシューマーを管理する
Kinesis Data Streams API を使用して、拡張ファンアウトコンシューマーを登録、説明、一覧表示、および登録解除できます。例については、次のドキュメントを参照してください。
- RegisterStreamConsumer
-
タグを使用して Kinesis データストリームにコンシューマーを登録します。コンシューマーの登録時にタグを適用できます。
- DescribeStreamConsumer
-
登録済みコンシューマーの詳細情報を、コンシューマー ARN またはコンシューマー名とストリーム ARN の組み合わせを指定して取得します。
- ListStreamConsumers
-
拡張ファンアウトを使用してストリームからデータを受け取るように登録されているコンシューマーを一覧表示します。
- DeregisterStreamConsumer
-
コンシューマー ARN、またはコンシューマー名とストリーム ARN の組み合わせのいずれかを指定して、コンシューマーを登録解除します。
コンシューマーのタグ付け
Kinesis Data Streams で作成したストリームおよび拡張ファンアウトコンシューマーに、独自のメタデータをタグ形式で割り当てることができます。タグを使用して、コンシューマーのコストを分類して追跡できます。属性ベースのアクセス制御 (ABAC) では、タグを使用してコンシューマー関数へのアクセスも制御できます。詳細については、Amazon Kinesis Data Streams リソースにタグを付けるを参照してください。
