Skip to content

Data Source: awsKinesisStreamConsumer

Provides details about a Kinesis Stream Consumer.

For more details, see the Amazon Kinesis Stream Consumer Documentation.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dataAwsKinesisStreamConsumer.DataAwsKinesisStreamConsumer(
  this,
  "example",
  {
    name: "example-consumer",
    streamArn: "${aws_kinesis_stream.example.arn}",
  }
);

Argument Reference

  • arn - (Optional) ARN of the stream consumer.
  • name - (Optional) Name of the stream consumer.
  • streamArn - (Required) ARN of the data stream the consumer is registered with.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • creationTimestamp - Approximate timestamp in RFC3339 format of when the stream consumer was created.
  • id - ARN of the stream consumer.
  • status - Current status of the stream consumer.