Resource: awsKinesisStreamConsumer
Provides a resource to manage a Kinesis Stream Consumer.
-> Note: You can register up to 20 consumers per stream. A given consumer can only be registered with one stream at a time.
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";
const awsKinesisStreamExample = new aws.kinesisStream.KinesisStream(
this,
"example",
{
name: "example-stream",
shardCount: 1,
}
);
const awsKinesisStreamConsumerExample =
new aws.kinesisStreamConsumer.KinesisStreamConsumer(this, "example_1", {
name: "example-consumer",
streamArn: awsKinesisStreamExample.arn,
});
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
awsKinesisStreamConsumerExample.overrideLogicalId("example");
Argument Reference
The following arguments are supported:
name- (Required, Forces new resource) Name of the stream consumer.streamArn– (Required, Forces new resource) Amazon Resource Name (ARN) of the data stream the consumer is registered with.
Attributes Reference
In addition to all arguments above, the following attributes are exported:
arn- Amazon Resource Name (ARN) of the stream consumer.creationTimestamp- Approximate timestamp in RFC3339 format of when the stream consumer was created.id- Amazon Resource Name (ARN) of the stream consumer.
Import
Kinesis Stream Consumers can be imported using the Amazon Resource Name (ARN) e.g.,