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	>= 0.15
aws	>= 3.25.0

Providers

Name	Version
aws	>= 3.25.0

Modules

No modules.

Resources

Name	Type
aws_kinesis_stream.stream	resource

Inputs

Name	Description	Type	Default	Required
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
name	The name to give to the new stream	string	n/a	yes
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
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-2021 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.