aws-cdk-lib.aws_kinesis.CfnStreamConsumerProps

CfnStreamConsumerProps Struct

Properties for defining a CfnStreamConsumer.

CfnStreamConsumerProps

used as props by

• CfnStreamConsumer

Source

Generated code

Type last changed

v2.205.0 · 15 Jul 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesis as kinesis } from 'aws-cdk-lib';
const cfnStreamConsumerProps: kinesis.CfnStreamConsumerProps = {
  consumerName: 'consumerName',
  streamArn: 'streamArn',

  // the properties below are optional
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

consumerNamestringconsumer_namestrconsumerNameStringConsumerNamestringConsumerName*stringrequired#

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

streamArnstringstream_arnstrstreamArnStringStreamArnstringStreamArn*stringrequired#

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

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]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.