github.com/jrasell/terraform@v0.6.17-0.20160523115548-2652f5232949/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  ```
    19  resource "aws_kinesis_stream" "test_stream" {
    20  	name = "terraform-kinesis-test"
    21  	shard_count = 1
    22  	retention_period = 48
    23  	tags {
    24  		Environment = "test"
    25  	}
    26  }
    27  ```
    28  
    29  ## Argument Reference
    30  
    31  The following arguments are supported:
    32  
    33  * `name` - (Required) A name to identify the stream. This is unique to the 
    34  AWS account and region the Stream is created in.
    35  * `shard_count` – (Required) The number of shards that the stream will use.
    36  Amazon has guidlines for specifying the Stream size that should be referenced 
    37  when creating a Kinesis stream. See [Amazon Kinesis Streams][2] for more.
    38  * `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.
    39  * `tags` - (Optional) A mapping of tags to assign to the resource.
    40  
    41  ## Attributes Reference
    42  
    43  * `id` - The unique Stream id
    44  * `name` - The unique Stream name (same as `id`)
    45  * `shard_count` - The count of Shards for this Stream
    46  * `arn` - The Amazon Resource Name (ARN) specifying the Stream
    47  
    48  
    49  [1]: https://aws.amazon.com/documentation/kinesis/
    50  [2]: https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html