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

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_kinesis_stream"
     4  sidebar_current: "docs-aws-resource-kinesis-stream"
     5  description: |-
     6    Provides a AWS Kinesis Stream
     7  ---
     8  
     9  # aws\_kinesis\_stream
    10  
    11  Provides a Kinesis Stream resource. Amazon Kinesis is a managed service that
    12  scales elastically for real-time processing of streaming big data.
    13  
    14  For more details, see the [Amazon Kinesis Documentation][1].
    15  
    16  ## Example Usage
    17  
    18  ```hcl
    19  resource "aws_kinesis_stream" "test_stream" {
    20    name             = "terraform-kinesis-test"
    21    shard_count      = 1
    22    retention_period = 48
    23  
    24    shard_level_metrics = [
    25      "IncomingBytes",
    26      "OutgoingBytes",
    27    ]
    28  
    29    tags {
    30      Environment = "test"
    31    }
    32  }
    33  ```
    34  
    35  ## Argument Reference
    36  
    37  The following arguments are supported:
    38  
    39  * `name` - (Required) A name to identify the stream. This is unique to the
    40  AWS account and region the Stream is created in.
    41  * `shard_count` – (Required) The number of shards that the stream will use.
    42  Amazon has guidlines for specifying the Stream size that should be referenced
    43  when creating a Kinesis stream. See [Amazon Kinesis Streams][2] for more.
    44  * `retention_period` - (Optional) Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours. Minimum value is 24. Default is 24.
    45  * `shard_level_metrics` - (Optional) A list of shard-level CloudWatch metrics which can be enabled for the stream. See [Monitoring with CloudWatch][3] for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.
    46  * `tags` - (Optional) A mapping of tags to assign to the resource.
    47  
    48  ## Attributes Reference
    49  
    50  * `id` - The unique Stream id
    51  * `name` - The unique Stream name (same as `id`)
    52  * `shard_count` - The count of Shards for this Stream
    53  * `arn` - The Amazon Resource Name (ARN) specifying the Stream
    54  
    55  
    56  [1]: https://aws.amazon.com/documentation/kinesis/
    57  [2]: https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html
    58  [3]: https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html