AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Kinesis::StreamConsumer

CfnStreamConsumer

Use the AWS CloudFormation `AWS::Kinesis::StreamConsumer` resource to register a consumer with a Kinesis data stream. The consumer you register can then call [SubscribeToShard](https://docs.aws.amazon.com/kinesis/latest/APIReference/API_SubscribeToShard.html) to receive data from the stream using enhanced fan-out, at a rate of up to 2 MiB per second for every shard you subscribe to. This rate is unaffected by the total number of consumers that read from the same stream. You can register up to 20 consumers per stream. However, you can request a limit increase using the [Kinesis Data Streams limits form](https://docs.aws.amazon.com/support/v1?#/) . A given consumer can only be registered with one stream at a time. For more information, see [Using Consumers with Enhanced Fan-Out](https://docs.aws.amazon.com/streams/latest/dev/introduction-to-enhanced-consumers.html) .

Import

import { CfnStreamConsumer } from 'aws-cdk-lib/aws-kinesis';

Or use the module namespace:

import * as kinesis from 'aws-cdk-lib/aws-kinesis';
// kinesis.CfnStreamConsumer

Properties

Configuration passed to the constructor as CfnStreamConsumerProps.

consumerNameRequired
string

The name of the consumer is something you choose when you register the consumer.

streamArnRequired
string

The ARN of the stream with which you registered the consumer.

tagsOptional
CfnTag[]

An array of tags to be added to a specified Kinesis resource. A tag consists of a required key and an optional value. You can specify up to 50 tag key-value pairs.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter