Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit 0ba95e7

Browse files
committed
add example usage
1 parent 2dd5287 commit 0ba95e7

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
1-
# terraform-aws-firehose
2-
Terraform AWS Kinesis Firehose module
1+
# Terraform AWS module for AWS Kinesis Firehose
2+
3+
## Introduction
4+
5+
This module create a Kinesis Firehose and all the resources related to it to log to S3.
6+
7+
## Usage
8+
9+
```hcl
10+
module "my_firehose" {
11+
source = "github.com/comtravo/terraform-aws-firehose"
12+
13+
enable = 1
14+
15+
name = "test-firehose"
16+
destination = "s3"
17+
18+
s3_configuration {
19+
bucket_arn = "my_s3_bucket_arn"
20+
buffer_interval = 60
21+
prefix = "some-prefix/"
22+
}
23+
24+
account_id = "0123456789012"
25+
}
26+
```
27+
28+
## Authors
29+
30+
Module managed by [Comtravo](https://github.com/comtravo).
31+
32+
## License
33+
34+
MIT Licensed. See LICENSE for full details.

0 commit comments

Comments
 (0)