Skip to content

Commit 7ccd711

Browse files
docs-sourcer[bot]docs-sourcer[bot]
authored
Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com>
1 parent c41b855 commit 7ccd711

File tree

7 files changed

+117
-58
lines changed

7 files changed

+117
-58
lines changed

‎docs/reference/modules/terraform-aws-messaging/kinesis-firehose/kinesis-firehose.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="AWS Messaging" version="1.0.0" lastModifiedVersion="0.13.0"/>
12+
<VersionBadge repoTitle="AWS Messaging" version="1.0.1" lastModifiedVersion="0.13.0"/>
1313

1414
# Kinesis Firehose Delivery Stream Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis-firehose" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis-firehose" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/releases/tag/v0.13.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -40,7 +40,7 @@ the `var.kinesis_stream_arn` to specify the kinesis data stream, we also have a
4040
4141
module "kinesis_firehose" {
4242
43-
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis-firehose?ref=v1.0.0"
43+
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis-firehose?ref=v1.0.1"
4444
4545
# ----------------------------------------------------------------------------------------------------
4646
# REQUIRED VARIABLES
@@ -77,7 +77,7 @@ module "kinesis_firehose" {
7777
# ------------------------------------------------------------------------------------------------------
7878
7979
terraform {
80-
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis-firehose?ref=v1.0.0"
80+
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis-firehose?ref=v1.0.1"
8181
}
8282
8383
inputs = {
@@ -209,11 +209,11 @@ Name of the role for Kinesis Firehose
209209
<!-- ##DOCS-SOURCER-START
210210
{
211211
"originalSources": [
212-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis-firehose/readme.md",
213-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis-firehose/variables.tf",
214-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis-firehose/outputs.tf"
212+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis-firehose/readme.md",
213+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis-firehose/variables.tf",
214+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis-firehose/outputs.tf"
215215
],
216216
"sourcePlugin": "module-catalog-api",
217-
"hash": "330e2064a58c419a940c3a29367c2e60"
217+
"hash": "31500f62adfe383b84f3ef7e5bd7a8ed"
218218
}
219219
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-messaging/kinesis/kinesis.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="AWS Messaging" version="1.0.0" lastModifiedVersion="0.13.0"/>
12+
<VersionBadge repoTitle="AWS Messaging" version="1.0.1" lastModifiedVersion="0.13.0"/>
1313

1414
# Kinesis Data Stream Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/releases/tag/v0.13.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -152,7 +152,7 @@ regions: https://github.com/aws-samples/aws-kinesis-data-streams-replicator
152152
153153
module "kinesis" {
154154
155-
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis?ref=v1.0.0"
155+
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis?ref=v1.0.1"
156156
157157
# ----------------------------------------------------------------------------------------------------
158158
# REQUIRED VARIABLES
@@ -223,7 +223,7 @@ module "kinesis" {
223223
# ------------------------------------------------------------------------------------------------------
224224
225225
terraform {
226-
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis?ref=v1.0.0"
226+
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis?ref=v1.0.1"
227227
}
228228
229229
inputs = {
@@ -458,11 +458,11 @@ A map of key value pairs to apply as tags to the Kinesis stream.
458458
<!-- ##DOCS-SOURCER-START
459459
{
460460
"originalSources": [
461-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis/readme.md",
462-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis/variables.tf",
463-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis/outputs.tf"
461+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis/readme.md",
462+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis/variables.tf",
463+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis/outputs.tf"
464464
],
465465
"sourcePlugin": "module-catalog-api",
466-
"hash": "099c905587c72be13e1286e7f82eac70"
466+
"hash": "77cd10e9e108ce202359b20cbd8d3d68"
467467
}
468468
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-messaging/msk/msk.md

Lines changed: 69 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="AWS Messaging" version="1.0.0" lastModifiedVersion="0.13.1"/>
12+
<VersionBadge repoTitle="AWS Messaging" version="1.0.1" lastModifiedVersion="1.0.1"/>
1313

1414
# Amazon Managed Streaming for Apache Kafka (Amazon MSK) Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/msk" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/msk" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

18-
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/releases/tag/v0.13.1" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
18+
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/releases/tag/v1.0.1" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

2020
This Terraform module configures and launches an [Amazon MSK](https://aws.amazon.com/msk/) cluster.
2121

@@ -145,7 +145,7 @@ The MSK module supports the following authentication and authorization methods:
145145

146146
* [IAM access control](https://docs.aws.amazon.com/msk/latest/developerguide/iam-access-control.html)
147147
using `var.enable_client_sasl_iam`. You can refer
148-
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).
148+
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).
149149
* [TLS](https://docs.aws.amazon.com/msk/latest/developerguide/msk-authentication.html) using `var.enable_client_tls`
150150
and `var.client_tls_certificate_authority_arns`
151151
* [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
165165

166166
You can read more about MSK logging here: https://docs.aws.amazon.com/msk/latest/developerguide/msk-logging.html
167167

168+
## Privatelink
169+
170+
Privatelink (provided by multi vpc connectivity) provides a method for connecting to msk clusters from a seperate
171+
account in the same region.
172+
173+
* TLS endpoints can be enabled by setting `var.enable_privatelink_tls` to `true`
174+
* SCRAM endpoints can be enabled by setting `var.enable_privatelink_scram` to `true`
175+
* IAM endpoints can be enabled by setting `var.enable_privatelink_iam` to `true`
176+
177+
The associated authenticion type enabled for privatelink must also be enabled for the cluster itself.
178+
179+
the default cluster policy will be present, you can manage that external to the module by utilizing the
180+
terraform resource [aws_msk_cluster_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/msk_cluster_policy)
181+
168182
## Connecting to Kafka brokers
169183

170184
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).
250264
251265
module "msk" {
252266
253-
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/msk?ref=v1.0.0"
267+
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/msk?ref=v1.0.1"
254268
255269
# ----------------------------------------------------------------------------------------------------
256270
# REQUIRED VARIABLES
@@ -331,6 +345,15 @@ module "msk" {
331345
# Kinesis Data Firehose.
332346
enable_firehose_logs = false
333347
348+
# Whether privatelink with IAM auth should be enabled
349+
enable_privatelink_iam = null
350+
351+
# Whether privatelink with SCRAM auth should be enabled
352+
enable_privatelink_scram = null
353+
354+
# Whether privatelink with TLS auth should be enabled
355+
enable_privatelink_tls = null
356+
334357
# Indicates whether you want to enable or disable streaming broker logs to S3.
335358
enable_s3_logs = false
336359
@@ -421,7 +444,7 @@ module "msk" {
421444
# ------------------------------------------------------------------------------------------------------
422445
423446
terraform {
424-
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/msk?ref=v1.0.0"
447+
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/msk?ref=v1.0.1"
425448
}
426449
427450
inputs = {
@@ -505,6 +528,15 @@ inputs = {
505528
# Kinesis Data Firehose.
506529
enable_firehose_logs = false
507530
531+
# Whether privatelink with IAM auth should be enabled
532+
enable_privatelink_iam = null
533+
534+
# Whether privatelink with SCRAM auth should be enabled
535+
enable_privatelink_scram = null
536+
537+
# Whether privatelink with TLS auth should be enabled
538+
enable_privatelink_tls = null
539+
508540
# Indicates whether you want to enable or disable streaming broker logs to S3.
509541
enable_s3_logs = false
510542
@@ -807,6 +839,33 @@ Indicates whether you want to enable or disable streaming broker logs to Kinesis
807839
<HclListItemDefaultValue defaultValue="false"/>
808840
</HclListItem>
809841

842+
<HclListItem name="enable_privatelink_iam" requirement="optional" type="bool">
843+
<HclListItemDescription>
844+
845+
Whether privatelink with IAM auth should be enabled
846+
847+
</HclListItemDescription>
848+
<HclListItemDefaultValue defaultValue="null"/>
849+
</HclListItem>
850+
851+
<HclListItem name="enable_privatelink_scram" requirement="optional" type="bool">
852+
<HclListItemDescription>
853+
854+
Whether privatelink with SCRAM auth should be enabled
855+
856+
</HclListItemDescription>
857+
<HclListItemDefaultValue defaultValue="null"/>
858+
</HclListItem>
859+
860+
<HclListItem name="enable_privatelink_tls" requirement="optional" type="bool">
861+
<HclListItemDescription>
862+
863+
Whether privatelink with TLS auth should be enabled
864+
865+
</HclListItemDescription>
866+
<HclListItemDefaultValue defaultValue="null"/>
867+
</HclListItem>
868+
810869
<HclListItem name="enable_s3_logs" requirement="optional" type="bool">
811870
<HclListItemDescription>
812871

@@ -1121,11 +1180,11 @@ A comma separated list of one or more hostname:port pairs to use to connect to t
11211180
<!-- ##DOCS-SOURCER-START
11221181
{
11231182
"originalSources": [
1124-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/msk/readme.md",
1125-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/msk/variables.tf",
1126-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/msk/outputs.tf"
1183+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/msk/readme.md",
1184+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/msk/variables.tf",
1185+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/msk/outputs.tf"
11271186
],
11281187
"sourcePlugin": "module-catalog-api",
1129-
"hash": "89365a88471796de31fa1baa9c860a8a"
1188+
"hash": "cf346e484f206c0460a646da0491f710"
11301189
}
11311190
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-messaging/sns-sqs-connection/sns-sqs-connection.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="AWS Messaging" version="1.0.0" lastModifiedVersion="0.13.0"/>
12+
<VersionBadge repoTitle="AWS Messaging" version="1.0.1" lastModifiedVersion="0.13.0"/>
1313

1414
# Simple Notification Service (SNS) Topic to Simple Queuing Service (SQS) Connection Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns-sqs-connection" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns-sqs-connection" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/releases/tag/v0.13.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -32,7 +32,7 @@ This module makes it easy to subscribe a SQS to a SNS topic after both have been
3232
3333
module "sns_sqs_connection" {
3434
35-
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns-sqs-connection?ref=v1.0.0"
35+
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns-sqs-connection?ref=v1.0.1"
3636
3737
# ----------------------------------------------------------------------------------------------------
3838
# REQUIRED VARIABLES
@@ -81,7 +81,7 @@ module "sns_sqs_connection" {
8181
# ------------------------------------------------------------------------------------------------------
8282
8383
terraform {
84-
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns-sqs-connection?ref=v1.0.0"
84+
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns-sqs-connection?ref=v1.0.1"
8585
}
8686
8787
inputs = {
@@ -201,11 +201,11 @@ Whether to enable raw message delivery (the original message is directly passed,
201201
<!-- ##DOCS-SOURCER-START
202202
{
203203
"originalSources": [
204-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns-sqs-connection/readme.md",
205-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns-sqs-connection/variables.tf",
206-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns-sqs-connection/outputs.tf"
204+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns-sqs-connection/readme.md",
205+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns-sqs-connection/variables.tf",
206+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns-sqs-connection/outputs.tf"
207207
],
208208
"sourcePlugin": "module-catalog-api",
209-
"hash": "dce075a223506b7a560fd8138b8cfc04"
209+
"hash": "738fbc883bc118ac9f2629f22d45fe47"
210210
}
211211
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-messaging/sns/sns.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="AWS Messaging" version="1.0.0" lastModifiedVersion="0.13.0"/>
12+
<VersionBadge repoTitle="AWS Messaging" version="1.0.1" lastModifiedVersion="0.13.0"/>
1313

1414
# Simple Notification Service (SNS) Topic Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-messaging/releases/tag/v0.13.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -42,7 +42,7 @@ including:
4242
4343
module "sns" {
4444
45-
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns?ref=v1.0.0"
45+
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns?ref=v1.0.1"
4646
4747
# ----------------------------------------------------------------------------------------------------
4848
# REQUIRED VARIABLES
@@ -126,7 +126,7 @@ module "sns" {
126126
# ------------------------------------------------------------------------------------------------------
127127
128128
terraform {
129-
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns?ref=v1.0.0"
129+
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns?ref=v1.0.1"
130130
}
131131
132132
inputs = {
@@ -395,11 +395,11 @@ A map of key value pairs to apply as tags to the SNS topic.
395395
<!-- ##DOCS-SOURCER-START
396396
{
397397
"originalSources": [
398-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns/readme.md",
399-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns/variables.tf",
400-
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns/outputs.tf"
398+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns/readme.md",
399+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns/variables.tf",
400+
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns/outputs.tf"
401401
],
402402
"sourcePlugin": "module-catalog-api",
403-
"hash": "fdd973187f1f09d7c60733e9009ae109"
403+
"hash": "c72c3a1b4417491504c5d4a1cb577e3e"
404404
}
405405
##DOCS-SOURCER-END -->

0 commit comments

Comments
 (0)