github.com/jmbataller/terraform@v0.6.8-0.20151125192640-b7a12e3a580c/website/source/docs/providers/aws/r/kinesis_firehose_delivery_stream.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_kinesis_firehose_delivery_stream"
     4  sidebar_current: "docs-aws-resource-kinesis-firehose-delivery-stream"
     5  description: |-
     6    Provides a AWS Kinesis Firehose Delivery Stream
     7  ---
     8  
     9  # aws\_kinesis\_stream
    10  
    11  Provides a Kinesis Firehose Delivery Stream resource. Amazon Kinesis Firehose is a fully managed, elastic service to easily deliver real-time data streams to destinations such as Amazon S3 and Amazon Redshift.
    12  
    13  For more details, see the [Amazon Kinesis Firehose Documentation][1].
    14  
    15  ## Example Usage
    16  
    17  ```
    18  resource "aws_s3_bucket" "bucket" {
    19  	bucket = "tf-test-bucket"
    20  	acl = "private"
    21  }
    22  
    23  esource "aws_iam_role" "firehose_role" {
    24     name = "firehose_test_role"
    25     assume_role_policy = <<EOF
    26  {
    27    "Version": "2012-10-17",
    28    "Statement": [
    29      {
    30        "Action": "sts:AssumeRole",
    31        "Principal": {
    32          "Service": "firehose.amazonaws.com"
    33        },
    34        "Effect": "Allow",
    35        "Sid": ""
    36      }
    37    ]
    38  }
    39  EOF
    40  }
    41  
    42  resource "aws_kinesis_firehose_delivery_stream" "test_stream" {
    43  	name = "terraform-kinesis-firehose-test-stream"
    44  	destination = "s3"
    45  	role_arn = "${aws_iam_role.firehose_role.arn}"
    46  	s3_bucket_arn = "${aws_s3_bucket.bucket.arn}"
    47  }
    48  ```
    49  
    50  ~> **NOTE:** Kinesis Firehose is currently only supported in us-east-1, us-west-2 and eu-west-1. This implementation of Kinesis Firehose only supports the s3 destination type as Terraform doesn't support Redshift yet.
    51  
    52  ## Argument Reference
    53  
    54  The following arguments are supported:
    55  
    56  * `name` - (Required) A name to identify the stream. This is unique to the 
    57  AWS account and region the Stream is created in.
    58  * `destination` – (Required) This is the destination to where the data is delivered. The only options are `s3` & `redshift`
    59  * `role_arn` - (Required) The ARN of the AWS credentials.
    60  * `s3_bucket_arn` - (Required) The ARN of the S3 bucket
    61  * `s3_prefix` - (Optional) The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered S3 files. You can specify an extra prefix to be added in front of the time format prefix. Note that if the prefix ends with a slash, it appears as a folder in the S3 bucket
    62  * `s3_buffer_size` - (Optional) Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
    63                                  We recommend setting SizeInMBs to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec set SizeInMBs to be 10 MB or highe
    64  * `s3_buffer_interval` - (Optional) Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300
    65  * `s3_data_compression` - (Optional) The compression format. If no value is specified, the default is NOCOMPRESSION. Other supported values are GZIP, ZIP & Snappy 
    66  
    67  
    68  ## Attributes Reference
    69  
    70  * `arn` - The Amazon Resource Name (ARN) specifying the Stream
    71  
    72  [1]: http://aws.amazon.com/documentation/firehose/