» Data Source: aws_kinesis_stream

Use this data source to get information about a Kinesis Stream for use in other resources.

For more details, see the Amazon Kinesis Documentation.

» Example Usage

data "aws_kinesis_stream" "stream" {
  name = "stream-name"
}

» Argument Reference

  • name - (Required) The name of the Kinesis Stream.

» Attributes Reference

id is set to the Amazon Resource Name (ARN) of the Kinesis Stream. In addition, the following attributes are exported:

  • arn - The Amazon Resource Name (ARN) of the Kinesis Stream (same as id).
  • name - The name of the Kinesis Stream.
  • creation_timestamp - The approximate UNIX timestamp that the stream was created.
  • status - The current status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING.
  • retention_period - Length of time (in hours) data records are accessible after they are added to the stream.
  • open_shards - The list of shard ids in the OPEN state. See Shard State for more.
  • closed_shards - The list of shard ids in the CLOSED state. See Shard State for more.
  • shard_level_metrics - A list of shard-level CloudWatch metrics which are enabled for the stream. See Monitoring with CloudWatch for more.
  • tags - A map of tags to assigned to the stream.