https://github.com/avidhara/terraform-aws-kinesis-stream
Terraform module for AWS Kinesis stream
https://github.com/avidhara/terraform-aws-kinesis-stream
aws kinesis terraform terraform-aws-module terraform-modules
Last synced: 10 months ago
JSON representation
Terraform module for AWS Kinesis stream
- Host: GitHub
- URL: https://github.com/avidhara/terraform-aws-kinesis-stream
- Owner: avidhara
- License: other
- Created: 2020-12-14T07:07:03.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-04T06:56:07.000Z (over 2 years ago)
- Last Synced: 2025-01-15T01:41:19.422Z (11 months ago)
- Topics: aws, kinesis, terraform, terraform-aws-module, terraform-modules
- Language: HCL
- Homepage:
- Size: 6.84 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Terraform module for AWS Kinesis Stream resource
To know how to use please refer to `examples` folder
## Requirements
| Name | Version |
|------|---------|
| terraform | >= 0.12.7, < 0.14 |
| aws | >= 2.68, < 4.0 |
## Providers
| Name | Version |
|------|---------|
| aws | >= 2.68, < 4.0 |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| encryption\_type | (Optional) The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE. | `string` | `"KMS"` | no |
| enforce\_consumer\_deletion | (Optional) A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false. | `bool` | `false` | no |
| kms\_key\_id | (Optional) The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis. | `string` | `null` | no |
| name | (Required) A name to identify the stream. This is unique to the AWS account and region the Stream is created in. | `string` | n/a | yes |
| 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. | `number` | `24` | no |
| shard\_count | (Required) The number of shards that the stream will use. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. | `number` | `1` | no |
| shard\_level\_metrics | (Optional) A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable. | `list(string)` | `[]` | no |
| tags | (Optional) A map of tags to assign to the resource. | `map(string)` | `{}` | no |
## Outputs
| Name | Description |
|------|-------------|
| arn | The Amazon Resource Name (ARN) specifying the Stream (same as id) |
| id | The unique Stream id |
| name | The unique Stream name |
| shard\_count | The count of Shards for this Stream |
## License
Apache 2 Licensed. See LICENSE for full details.