github.com/danp/terraform@v0.9.5-0.20170426144147-39d740081351/website/source/docs/providers/aws/d/kinesis_stream.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_kinesis_stream"
     4  sidebar_current: "docs-aws-datasource-kinesis-stream"
     5  description: |-
     6    Provides a Kinesis Stream data source.
     7  ---
     8  
     9  # aws\_kinesis\_stream
    10  
    11  Use this data source to get information about a Kinesis Stream for use in other
    12  resources.
    13  
    14  For more details, see the [Amazon Kinesis Documentation][1].
    15  
    16  ## Example Usage
    17  
    18  ```
    19  data "aws_kinesis_stream" "stream" {
    20    name = "stream-name"
    21  }
    22  ```
    23  
    24  ## Argument Reference
    25  
    26  * `name` - (Required) The name of the Kinesis Stream.
    27  
    28  ## Attributes Reference
    29  
    30  `id` is set to the Amazon Resource Name (ARN) of the Kinesis Stream. In addition, the following attributes
    31  are exported:
    32  
    33  * `arn` - The Amazon Resource Name (ARN) of the Kinesis Stream (same as id).
    34  * `name` - The name of the Kinesis Stream.
    35  * `creation_timestamp` - The approximate UNIX timestamp that the stream was created.
    36  * `status` - The current status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING.
    37  * `retention_period` - Length of time (in hours) data records are accessible after they are added to the stream.
    38  * `open_shards` - The list of shard ids in the OPEN state. See [Shard State][2] for more.
    39  * `closed_shards` - The list of shard ids in the CLOSED state. See [Shard State][2] for more.
    40  * `shard_level_metrics` - A list of shard-level CloudWatch metrics which are enabled for the stream. See [Monitoring with CloudWatch][3] for more.
    41  * `tags` - A mapping of tags to assigned to the stream.
    42  
    43  [1]: https://aws.amazon.com/documentation/kinesis/
    44  [2]: https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-after-resharding.html#kinesis-using-sdk-java-resharding-data-routing
    45  [3]: https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html