interface CfnStreamConsumerProps

Language	Type name
.NET	`Amazon.CDK.AWS.Kinesis.CfnStreamConsumerProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskinesis#CfnStreamConsumerProps`
Java	`software.amazon.awscdk.services.kinesis.CfnStreamConsumerProps`
Python	`aws_cdk.aws_kinesis.CfnStreamConsumerProps`
TypeScript	`aws-cdk-lib` » `aws_kinesis` » `CfnStreamConsumerProps`

Properties for defining a CfnStreamConsumer.

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

Name	Type	Description
consumerName	`string`	The name of the consumer is something you choose when you register the consumer.
streamArn	`string`	The ARN of the stream with which you registered the consumer.
tags?	`CfnTag[]`	An array of tags to be added to a specified Kinesis resource.

consumerName

Type: string

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

streamArn

Type: string

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

tags?

Type: CfnTag[] (optional)

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.

AWS CDK