From e9aba09a356cf31397f06fe61c0a2658be474a7d Mon Sep 17 00:00:00 2001
From: "docs-sourcer[bot]"
<99042413+docs-sourcer[bot]@users.noreply.github.com>
Date: Tue, 15 Jul 2025 17:00:57 +0000
Subject: [PATCH] Updated with the [latest
changes](https://github.com/gruntwork-io/terraform-aws-messaging/releases/tag/v1.0.1)
from the `terraform-aws-messaging@v1.0.1` source branch.
---
.../kinesis-firehose/kinesis-firehose.md | 16 ++--
.../kinesis/kinesis.md | 16 ++--
.../terraform-aws-messaging/msk/msk.md | 79 ++++++++++++++++---
.../sns-sqs-connection/sns-sqs-connection.md | 16 ++--
.../terraform-aws-messaging/sns/sns.md | 16 ++--
.../sqs-lambda-connection.md | 16 ++--
.../terraform-aws-messaging/sqs/sqs.md | 16 ++--
7 files changed, 117 insertions(+), 58 deletions(-)
diff --git a/docs/reference/modules/terraform-aws-messaging/kinesis-firehose/kinesis-firehose.md b/docs/reference/modules/terraform-aws-messaging/kinesis-firehose/kinesis-firehose.md
index 3eec0977e..0e209d5d3 100644
--- a/docs/reference/modules/terraform-aws-messaging/kinesis-firehose/kinesis-firehose.md
+++ b/docs/reference/modules/terraform-aws-messaging/kinesis-firehose/kinesis-firehose.md
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
-
+
# Kinesis Firehose Delivery Stream Module
-View Source
+View Source
Release Notes
@@ -40,7 +40,7 @@ the `var.kinesis_stream_arn` to specify the kinesis data stream, we also have a
module "kinesis_firehose" {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/kinesis-firehose?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/kinesis-firehose?ref=v1.0.1"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
@@ -77,7 +77,7 @@ module "kinesis_firehose" {
# ------------------------------------------------------------------------------------------------------
terraform {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/kinesis-firehose?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/kinesis-firehose?ref=v1.0.1"
}
inputs = {
@@ -209,11 +209,11 @@ Name of the role for Kinesis Firehose
diff --git a/docs/reference/modules/terraform-aws-messaging/kinesis/kinesis.md b/docs/reference/modules/terraform-aws-messaging/kinesis/kinesis.md
index 1e51be0cb..95dc25ab2 100644
--- a/docs/reference/modules/terraform-aws-messaging/kinesis/kinesis.md
+++ b/docs/reference/modules/terraform-aws-messaging/kinesis/kinesis.md
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
-
+
# Kinesis Data Stream Module
-View Source
+View Source
Release Notes
@@ -152,7 +152,7 @@ regions: https://github.com/aws-samples/aws-kinesis-data-streams-replicator
module "kinesis" {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/kinesis?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/kinesis?ref=v1.0.1"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
@@ -223,7 +223,7 @@ module "kinesis" {
# ------------------------------------------------------------------------------------------------------
terraform {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/kinesis?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/kinesis?ref=v1.0.1"
}
inputs = {
@@ -458,11 +458,11 @@ A map of key value pairs to apply as tags to the Kinesis stream.
diff --git a/docs/reference/modules/terraform-aws-messaging/msk/msk.md b/docs/reference/modules/terraform-aws-messaging/msk/msk.md
index 4e9f6481d..4ccb7acdd 100644
--- a/docs/reference/modules/terraform-aws-messaging/msk/msk.md
+++ b/docs/reference/modules/terraform-aws-messaging/msk/msk.md
@@ -9,13 +9,13 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
-
+
# Amazon Managed Streaming for Apache Kafka (Amazon MSK) Module
-View Source
+View Source
-Release Notes
+Release Notes
This Terraform module configures and launches an [Amazon MSK](https://aws.amazon.com/msk/) cluster.
@@ -145,7 +145,7 @@ The MSK module supports the following authentication and authorization methods:
* [IAM access control](https://docs.aws.amazon.com/msk/latest/developerguide/iam-access-control.html)
using `var.enable_client_sasl_iam`. You can refer
- to the [msk-with-iam-auth example module](https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/examples/msk-with-iam-auth).
+ to the [msk-with-iam-auth example module](https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/examples/msk-with-iam-auth).
* [TLS](https://docs.aws.amazon.com/msk/latest/developerguide/msk-authentication.html) using `var.enable_client_tls`
and `var.client_tls_certificate_authority_arns`
* [Apache Kafka ACLs](https://docs.aws.amazon.com/msk/latest/developerguide/msk-acls.html)
@@ -165,6 +165,20 @@ cluster. You can deliver Apache Kafka broker logs to one or more of the followin
You can read more about MSK logging here: https://docs.aws.amazon.com/msk/latest/developerguide/msk-logging.html
+## Privatelink
+
+Privatelink (provided by multi vpc connectivity) provides a method for connecting to msk clusters from a seperate
+account in the same region.
+
+* TLS endpoints can be enabled by setting `var.enable_privatelink_tls` to `true`
+* SCRAM endpoints can be enabled by setting `var.enable_privatelink_scram` to `true`
+* IAM endpoints can be enabled by setting `var.enable_privatelink_iam` to `true`
+
+The associated authenticion type enabled for privatelink must also be enabled for the cluster itself.
+
+the default cluster policy will be present, you can manage that external to the module by utilizing the
+terraform resource [aws_msk_cluster_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/msk_cluster_policy)
+
## Connecting to Kafka brokers
Once you've used this module to deploy the Kafka brokers, you'll want to connect to them from Kafka clients (e.g.,
@@ -250,7 +264,7 @@ It's only supported for the provisioned cluster type (non-serverless mode).
module "msk" {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/msk?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/msk?ref=v1.0.1"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
@@ -331,6 +345,15 @@ module "msk" {
# Kinesis Data Firehose.
enable_firehose_logs = false
+ # Whether privatelink with IAM auth should be enabled
+ enable_privatelink_iam = null
+
+ # Whether privatelink with SCRAM auth should be enabled
+ enable_privatelink_scram = null
+
+ # Whether privatelink with TLS auth should be enabled
+ enable_privatelink_tls = null
+
# Indicates whether you want to enable or disable streaming broker logs to S3.
enable_s3_logs = false
@@ -421,7 +444,7 @@ module "msk" {
# ------------------------------------------------------------------------------------------------------
terraform {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/msk?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/msk?ref=v1.0.1"
}
inputs = {
@@ -505,6 +528,15 @@ inputs = {
# Kinesis Data Firehose.
enable_firehose_logs = false
+ # Whether privatelink with IAM auth should be enabled
+ enable_privatelink_iam = null
+
+ # Whether privatelink with SCRAM auth should be enabled
+ enable_privatelink_scram = null
+
+ # Whether privatelink with TLS auth should be enabled
+ enable_privatelink_tls = null
+
# Indicates whether you want to enable or disable streaming broker logs to S3.
enable_s3_logs = false
@@ -807,6 +839,33 @@ Indicates whether you want to enable or disable streaming broker logs to Kinesis
+
+
+
+Whether privatelink with IAM auth should be enabled
+
+
+
+
+
+
+
+
+Whether privatelink with SCRAM auth should be enabled
+
+
+
+
+
+
+
+
+Whether privatelink with TLS auth should be enabled
+
+
+
+
+
@@ -1121,11 +1180,11 @@ A comma separated list of one or more hostname:port pairs to use to connect to t
diff --git a/docs/reference/modules/terraform-aws-messaging/sns-sqs-connection/sns-sqs-connection.md b/docs/reference/modules/terraform-aws-messaging/sns-sqs-connection/sns-sqs-connection.md
index b9970430d..d0ae1b899 100644
--- a/docs/reference/modules/terraform-aws-messaging/sns-sqs-connection/sns-sqs-connection.md
+++ b/docs/reference/modules/terraform-aws-messaging/sns-sqs-connection/sns-sqs-connection.md
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
-
+
# Simple Notification Service (SNS) Topic to Simple Queuing Service (SQS) Connection Module
-View Source
+View Source
Release Notes
@@ -32,7 +32,7 @@ This module makes it easy to subscribe a SQS to a SNS topic after both have been
module "sns_sqs_connection" {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sns-sqs-connection?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sns-sqs-connection?ref=v1.0.1"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
@@ -81,7 +81,7 @@ module "sns_sqs_connection" {
# ------------------------------------------------------------------------------------------------------
terraform {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sns-sqs-connection?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sns-sqs-connection?ref=v1.0.1"
}
inputs = {
@@ -201,11 +201,11 @@ Whether to enable raw message delivery (the original message is directly passed,
diff --git a/docs/reference/modules/terraform-aws-messaging/sns/sns.md b/docs/reference/modules/terraform-aws-messaging/sns/sns.md
index 5c5cbb4aa..373568c0e 100644
--- a/docs/reference/modules/terraform-aws-messaging/sns/sns.md
+++ b/docs/reference/modules/terraform-aws-messaging/sns/sns.md
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
-
+
# Simple Notification Service (SNS) Topic Module
-View Source
+View Source
Release Notes
@@ -42,7 +42,7 @@ including:
module "sns" {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sns?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sns?ref=v1.0.1"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
@@ -126,7 +126,7 @@ module "sns" {
# ------------------------------------------------------------------------------------------------------
terraform {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sns?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sns?ref=v1.0.1"
}
inputs = {
@@ -395,11 +395,11 @@ A map of key value pairs to apply as tags to the SNS topic.
diff --git a/docs/reference/modules/terraform-aws-messaging/sqs-lambda-connection/sqs-lambda-connection.md b/docs/reference/modules/terraform-aws-messaging/sqs-lambda-connection/sqs-lambda-connection.md
index 291660760..84f3bbaa2 100644
--- a/docs/reference/modules/terraform-aws-messaging/sqs-lambda-connection/sqs-lambda-connection.md
+++ b/docs/reference/modules/terraform-aws-messaging/sqs-lambda-connection/sqs-lambda-connection.md
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
-
+
# Simple Queuing Service (SQS) To Lambda Connection Module
-View Source
+View Source
Release Notes
@@ -32,7 +32,7 @@ This module wraps the basics for using SQS to trigger a Lambda for processing
module "sqs_lambda_connection" {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sqs-lambda-connection?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sqs-lambda-connection?ref=v1.0.1"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
@@ -76,7 +76,7 @@ module "sqs_lambda_connection" {
# ------------------------------------------------------------------------------------------------------
terraform {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sqs-lambda-connection?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sqs-lambda-connection?ref=v1.0.1"
}
inputs = {
@@ -183,11 +183,11 @@ Limits the number of concurrent instances that the Amazon SQS event source can i
diff --git a/docs/reference/modules/terraform-aws-messaging/sqs/sqs.md b/docs/reference/modules/terraform-aws-messaging/sqs/sqs.md
index 9a4236bef..ad5d4601b 100644
--- a/docs/reference/modules/terraform-aws-messaging/sqs/sqs.md
+++ b/docs/reference/modules/terraform-aws-messaging/sqs/sqs.md
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
-
+
# Simple Queuing Service (SQS) Module
-View Source
+View Source
Release Notes
@@ -101,7 +101,7 @@ including:
module "sqs" {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sqs?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sqs?ref=v1.0.1"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
@@ -243,7 +243,7 @@ module "sqs" {
# ------------------------------------------------------------------------------------------------------
terraform {
- source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sqs?ref=v1.0.0"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-messaging.git//modules/sqs?ref=v1.0.1"
}
inputs = {
@@ -665,11 +665,11 @@ The visibility timeout for the queue. An integer from 0 to 43200 (12 hours).