snowplow-devops / terraform-aws-kinesis-stream

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Release CI License Registry

terraform-aws-kinesis-stream

A Terraform module for creating a simple stream with healthy defaults for encryption enabled out of the box.

Usage

module "stream" {
  source = "snowplow-devops/kinesis-stream/aws"

  name = "stream"
}

Requirements

Name Version
terraform >= 1.0.0
aws >= 3.71.0

Providers

Name Version
aws >= 3.71.0

Modules

No modules.

Resources

Name Type
aws_kinesis_stream.stream resource

Inputs

Name Description Type Default Required
name The name to give to the new stream string n/a yes
encryption_type The encryption type to use for data at rest string "KMS" no
enforce_consumer_deletion A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error bool true no
kms_key_id The KMS Key ID to use for encryption of data at rest string "alias/aws/kinesis" no
retention_period The number of hours that a shard should retain data for number 24 no
shard_count The number of shards to create the stream with number 1 no
shard_level_metrics A list of shard-level CloudWatch metrics which can be enabled for the stream list(string) [] no
stream_mode_details Capacity mode of the stream, either ON_DEMAND or PROVISIONED (note: ON_DEMAND comes with a much higher base cost for lower throughput - https://aws.amazon.com/kinesis/data-streams/pricing/) string "PROVISIONED" no
tags The tags to append to this resource map(string) {} no

Outputs

Name Description
arn This is the ARN of the stream
id This is the id of the stream
name This is the name of the stream

Copyright and license

The Terraform AWS Kinesis Stream project is Copyright 2021-2022 Snowplow Analytics Ltd.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

License:Apache License 2.0


Languages

Language:HCL 100.0%