Skip to content

[Automated Update][terraform-aws-messaging] v1.0.1 release #2661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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";

<VersionBadge repoTitle="AWS Messaging" version="1.0.0" lastModifiedVersion="0.13.0"/>
<VersionBadge repoTitle="AWS Messaging" version="1.0.1" lastModifiedVersion="0.13.0"/>

# Kinesis Firehose Delivery Stream Module

<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>
<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>

<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>

Expand All @@ -40,7 +40,7 @@ the `var.kinesis_stream_arn` to specify the kinesis data stream, we also have a

module "kinesis_firehose" {

source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis-firehose?ref=v1.0.0"
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis-firehose?ref=v1.0.1"

# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -77,7 +77,7 @@ module "kinesis_firehose" {
# ------------------------------------------------------------------------------------------------------

terraform {
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis-firehose?ref=v1.0.0"
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis-firehose?ref=v1.0.1"
}

inputs = {
Expand Down Expand Up @@ -209,11 +209,11 @@ Name of the role for Kinesis Firehose
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis-firehose/readme.md",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis-firehose/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis-firehose/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis-firehose/readme.md",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis-firehose/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis-firehose/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "330e2064a58c419a940c3a29367c2e60"
"hash": "31500f62adfe383b84f3ef7e5bd7a8ed"
}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -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";

<VersionBadge repoTitle="AWS Messaging" version="1.0.0" lastModifiedVersion="0.13.0"/>
<VersionBadge repoTitle="AWS Messaging" version="1.0.1" lastModifiedVersion="0.13.0"/>

# Kinesis Data Stream Module

<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>
<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>

<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>

Expand Down Expand Up @@ -152,7 +152,7 @@ regions: https://github.com/aws-samples/aws-kinesis-data-streams-replicator

module "kinesis" {

source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis?ref=v1.0.0"
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis?ref=v1.0.1"

# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -223,7 +223,7 @@ module "kinesis" {
# ------------------------------------------------------------------------------------------------------

terraform {
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis?ref=v1.0.0"
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/kinesis?ref=v1.0.1"
}

inputs = {
Expand Down Expand Up @@ -458,11 +458,11 @@ A map of key value pairs to apply as tags to the Kinesis stream.
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis/readme.md",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/kinesis/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis/readme.md",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/kinesis/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "099c905587c72be13e1286e7f82eac70"
"hash": "77cd10e9e108ce202359b20cbd8d3d68"
}
##DOCS-SOURCER-END -->
79 changes: 69 additions & 10 deletions docs/reference/modules/terraform-aws-messaging/msk/msk.md
Original file line number Diff line number Diff line change
Expand Up @@ -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";

<VersionBadge repoTitle="AWS Messaging" version="1.0.0" lastModifiedVersion="0.13.1"/>
<VersionBadge repoTitle="AWS Messaging" version="1.0.1" lastModifiedVersion="1.0.1"/>

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

<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>
<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>

<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>
<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>

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

Expand Down Expand Up @@ -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)
Expand All @@ -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.,
Expand Down Expand Up @@ -250,7 +264,7 @@ It's only supported for the provisioned cluster type (non-serverless mode).

module "msk" {

source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/msk?ref=v1.0.0"
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/msk?ref=v1.0.1"

# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -421,7 +444,7 @@ module "msk" {
# ------------------------------------------------------------------------------------------------------

terraform {
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/msk?ref=v1.0.0"
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/msk?ref=v1.0.1"
}

inputs = {
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -807,6 +839,33 @@ Indicates whether you want to enable or disable streaming broker logs to Kinesis
<HclListItemDefaultValue defaultValue="false"/>
</HclListItem>

<HclListItem name="enable_privatelink_iam" requirement="optional" type="bool">
<HclListItemDescription>

Whether privatelink with IAM auth should be enabled

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="enable_privatelink_scram" requirement="optional" type="bool">
<HclListItemDescription>

Whether privatelink with SCRAM auth should be enabled

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="enable_privatelink_tls" requirement="optional" type="bool">
<HclListItemDescription>

Whether privatelink with TLS auth should be enabled

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="enable_s3_logs" requirement="optional" type="bool">
<HclListItemDescription>

Expand Down Expand Up @@ -1121,11 +1180,11 @@ A comma separated list of one or more hostname:port pairs to use to connect to t
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/msk/readme.md",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/msk/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/msk/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/msk/readme.md",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/msk/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/msk/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "89365a88471796de31fa1baa9c860a8a"
"hash": "cf346e484f206c0460a646da0491f710"
}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -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";

<VersionBadge repoTitle="AWS Messaging" version="1.0.0" lastModifiedVersion="0.13.0"/>
<VersionBadge repoTitle="AWS Messaging" version="1.0.1" lastModifiedVersion="0.13.0"/>

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

<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>
<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>

<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>

Expand All @@ -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::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns-sqs-connection?ref=v1.0.0"
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns-sqs-connection?ref=v1.0.1"

# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -81,7 +81,7 @@ module "sns_sqs_connection" {
# ------------------------------------------------------------------------------------------------------

terraform {
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns-sqs-connection?ref=v1.0.0"
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns-sqs-connection?ref=v1.0.1"
}

inputs = {
Expand Down Expand Up @@ -201,11 +201,11 @@ Whether to enable raw message delivery (the original message is directly passed,
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns-sqs-connection/readme.md",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns-sqs-connection/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns-sqs-connection/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns-sqs-connection/readme.md",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns-sqs-connection/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns-sqs-connection/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "dce075a223506b7a560fd8138b8cfc04"
"hash": "738fbc883bc118ac9f2629f22d45fe47"
}
##DOCS-SOURCER-END -->
16 changes: 8 additions & 8 deletions docs/reference/modules/terraform-aws-messaging/sns/sns.md
Original file line number Diff line number Diff line change
Expand Up @@ -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";

<VersionBadge repoTitle="AWS Messaging" version="1.0.0" lastModifiedVersion="0.13.0"/>
<VersionBadge repoTitle="AWS Messaging" version="1.0.1" lastModifiedVersion="0.13.0"/>

# Simple Notification Service (SNS) Topic Module

<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>
<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>

<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>

Expand Down Expand Up @@ -42,7 +42,7 @@ including:

module "sns" {

source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns?ref=v1.0.0"
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns?ref=v1.0.1"

# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -126,7 +126,7 @@ module "sns" {
# ------------------------------------------------------------------------------------------------------

terraform {
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns?ref=v1.0.0"
source = "git::[email protected]:gruntwork-io/terraform-aws-messaging.git//modules/sns?ref=v1.0.1"
}

inputs = {
Expand Down Expand Up @@ -395,11 +395,11 @@ A map of key value pairs to apply as tags to the SNS topic.
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns/readme.md",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.0/modules/sns/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns/readme.md",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-messaging/tree/v1.0.1/modules/sns/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "fdd973187f1f09d7c60733e9009ae109"
"hash": "c72c3a1b4417491504c5d4a1cb577e3e"
}
##DOCS-SOURCER-END -->
Loading