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