Terraform AWS ARC kinesis-stream Module Usage Guide¶

Introduction¶

Purpose of the Document¶

This document provides guidelines and instructions for users looking to create and manage Amazon Kinesis Data Streams using the ARC Kinesis Stream module.

Module Overview¶

The terraform-aws-arc-kinesis-stream module can be used to create and manage Kinesis streams and their consumers.

Prerequisites¶

Before using this module, ensure you have the following: - AWS credentials configured. - Terraform installed. - A working knowledge of AWS Kinesis Data Streams and its consumers.

Getting Started¶

Module Source¶

To use the module in your Terraform configuration, include the following source block:

module "kinesis-streams" {
  source         = "sourcefuse/arc-kinesis-stream/aws"
  version        = "0.0.1"
  # insert the required variables here
}

Refer to the Terraform Registry for the latest version.

Integration with Existing Terraform Configurations¶

Integrate the module with your existing Terraform mono repo configuration, follow the steps below:

Create a new folder in terraform/ named ec2.
Create the required files, see the examples to base off of.
Configure with your backend
- Create the environment backend configuration file: config.<environment>.hcl
  - region: Where the backend resides
  - key: <working_directory>/terraform.tfstate
  - bucket: Bucket name where the terraform state will reside
  - dynamodb_table: Lock table so there are not duplicate tfplans in the mix
  - encrypt: Encrypt all traffic to and from the backend

Required AWS Permissions¶

Ensure that the AWS credentials used to execute Terraform have the necessary permissions to create and manage Kinesis streams and consumers on AWS.

Module Configuration¶

Input Variables¶

For a list of input variables, see the README Inputs section.

Output Values¶

For a list of outputs, see the README Outputs section.

Module Usage¶

Basic Usage¶

For basic usage, see the example folder.

This example will create:

Amazon Kinesis Data Stream: Configured with the specified shard count, retention period, shard level metrics, encryption, and tags.

Amazon Kinesis Stream Consumers: Created based on the specified number of consumers and attached to the Kinesis stream.

Troubleshooting¶

Reporting Issues¶

If you encounter a bug or issue, please report it on the GitHub repository.

ec2 Considerations¶

Contributing and Community Support¶

Contributing Guidelines¶

Contribute to the module by following the guidelines outlined in the CONTRIBUTING.md file.

Reporting Bugs and Issues¶

If you find a bug or issue, report it on the GitHub repository.

License¶

License Information¶

This module is licensed under the Apache 2.0 license. Refer to the LICENSE file for more details.

Open Source Contribution¶

Contribute to open source by using and enhancing this module. Your contributions are welcome!