# StreamConsumerProps

Properties for a Kinesis Stream Consumer.

Extends: StreamConsumerProps
Used as props by: StreamConsumer

- Source: [`aws-kinesis/lib/stream-consumer.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-kinesis/lib/stream-consumer.ts#L158)
- Type last changed: v2.180.0 · 21 Feb 2025

## Example

```ts
const lambdaRole = new iam.Role(this, 'Role', {
  assumedBy: new iam.ServicePrincipal('lambda.amazonaws.com'),
  description: 'Example role...',
});

const stream = new kinesis.Stream(this, 'MyEncryptedStream', {
  encryption: kinesis.StreamEncryption.KMS,
});
const streamConsumer = new kinesis.StreamConsumer(this, 'MyStreamConsumer', {
  streamConsumerName: 'MyStreamConsumer',
  stream,
});

// give lambda permissions to read stream via the stream consumer
streamConsumer.grantRead(lambdaRole);
```

## Properties

- `stream`: [IStream](/cdk/api/v2/docs/aws-cdk-lib.aws_kinesis.IStream.html) (required) — The Kinesis data stream to associate this consumer with.

- `streamConsumerName`: string (required) — The name of the stream consumer.