Skip to main content

Component: msk/cluster

This component is responsible for provisioning Amazon Managed Streaming clusters for Apache Kafka.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component.

components:
terraform:

msk:
metadata:
component: "msk"
vars:
enabled: true
name: "msk"
vpc_component_name: "vpc"
dns_delegated_component_name: "dns-delegated"
dns_delegated_environment_name: "gbl"
# https://docs.aws.amazon.com/msk/latest/developerguide/supported-kafka-versions.html
kafka_version: "3.4.0"
public_access_enabled: false
# https://aws.amazon.com/msk/pricing/
broker_instance_type: "kafka.m5.large"
# Number of brokers per AZ
broker_per_zone: 1
# `broker_dns_records_count` specifies how many DNS records to create for the broker endpoints in the DNS zone provided in the `zone_id` variable.
# This corresponds to the total number of broker endpoints created by the module.
# Calculate this number by multiplying the `broker_per_zone` variable by the subnet count.
broker_dns_records_count: 3
broker_volume_size: 500
client_broker: "TLS_PLAINTEXT"
encryption_in_cluster: true
encryption_at_rest_kms_key_arn: ""
enhanced_monitoring: "DEFAULT"
certificate_authority_arns: []

# Authentication methods
client_allow_unauthenticated: true
client_sasl_scram_enabled: false
client_sasl_scram_secret_association_enabled: false
client_sasl_scram_secret_association_arns: []
client_sasl_iam_enabled: false
client_tls_auth_enabled: false

jmx_exporter_enabled: false
node_exporter_enabled: false
cloudwatch_logs_enabled: false
firehose_logs_enabled: false
firehose_delivery_stream: ""
s3_logs_enabled: false
s3_logs_bucket: ""
s3_logs_prefix: ""
properties: {}
autoscaling_enabled: true
storage_autoscaling_target_value: 60
storage_autoscaling_max_capacity: null
storage_autoscaling_disable_scale_in: false
create_security_group: true
security_group_rule_description: "Allow inbound %s traffic"
# A list of IDs of Security Groups to allow access to the cluster security group
allowed_security_group_ids: []
# A list of IPv4 CIDRs to allow access to the cluster security group
allowed_cidr_blocks: []

Requirements

NameVersion
terraform>= 1.0.0
aws>= 4.9.0

Providers

No providers.

Modules

NameSourceVersion
dns_delegatedcloudposse/stack-config/yaml//modules/remote-state1.5.0
iam_roles../account-map/modules/iam-rolesn/a
kafkacloudposse/msk-apache-kafka-cluster/aws2.3.0
thiscloudposse/label/null0.25.0
vpccloudposse/stack-config/yaml//modules/remote-state1.5.0

Resources

No resources.

Inputs

NameDescriptionTypeDefaultRequired
additional_security_group_rulesA list of Security Group rule objects to add to the created security group, in addition to the ones
this module normally creates. (To suppress the module's rules, set create_security_group to false
and supply your own security group(s) via associated_security_group_ids.)
The keys and values of the objects are fully compatible with the aws_security_group_rule resource, except
for security_group_id which will be ignored, and the optional "key" which, if provided, must be unique and known at "plan" time.
For more info see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule
and https://github.com/cloudposse/terraform-aws-security-group.
list(any)[]no
additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.
map(string){}no
allow_all_egressIf true, the created security group will allow egress on all ports and protocols to all IP addresses.
If this is false and no egress rules are otherwise specified, then no egress will be allowed.
booltrueno
allowed_cidr_blocksA list of IPv4 CIDRs to allow access to the security group created by this module.
The length of this list must be known at "plan" time.
list(string)[]no
allowed_security_group_idsA list of IDs of Security Groups to allow access to the security group created by this module.
The length of this list must be known at "plan" time.
list(string)[]no
associated_security_group_idsA list of IDs of Security Groups to associate the created resource with, in addition to the created security group.
These security groups will not be modified and, if create_security_group is false, must have rules providing the desired access.
list(string)[]no
attributesID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.
list(string)[]no
autoscaling_enabledTo automatically expand your cluster's storage in response to increased usage, you can enable this. More infobooltrueno
broker_dns_records_countThis variable specifies how many DNS records to create for the broker endpoints in the DNS zone provided in the zone_id variable.
This corresponds to the total number of broker endpoints created by the module.
Calculate this number by multiplying the broker_per_zone variable by the subnet count.
This variable is necessary to prevent the Terraform error:
The "count" value depends on resource attributes that cannot be determined until apply, so Terraform cannot predict how many instances will be created.
number0no
broker_instance_typeThe instance type to use for the Kafka brokersstringn/ayes
broker_per_zoneNumber of Kafka brokers per zonenumber1no
broker_volume_sizeThe size in GiB of the EBS volume for the data drive on each broker nodenumber1000no
certificate_authority_arnsList of ACM Certificate Authority Amazon Resource Names (ARNs) to be used for TLS client authenticationlist(string)[]no
client_allow_unauthenticatedEnable unauthenticated accessboolfalseno
client_brokerEncryption setting for data in transit between clients and brokers. Valid values: TLS, TLS_PLAINTEXT, and PLAINTEXTstring"TLS"no
client_sasl_iam_enabledEnable client authentication via IAM policies. Cannot be set to true at the same time as client_tls_auth_enabledboolfalseno
client_sasl_scram_enabledEnable SCRAM client authentication via AWS Secrets Manager. Cannot be set to true at the same time as client_tls_auth_enabledboolfalseno
client_sasl_scram_secret_association_arnsList of AWS Secrets Manager secret ARNs for SCRAM authenticationlist(string)[]no
client_sasl_scram_secret_association_enabledEnable the list of AWS Secrets Manager secret ARNs for SCRAM authenticationbooltrueno
client_tls_auth_enabledSet true to enable the Client TLS Authenticationboolfalseno
cloudwatch_logs_enabledIndicates whether you want to enable or disable streaming broker logs to Cloudwatch Logsboolfalseno
cloudwatch_logs_log_groupName of the Cloudwatch Log Group to deliver logs tostringnullno
contextSingle object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.
any
{
"additional_tag_map": {},
"attributes": [],
"delimiter": null,
"descriptor_formats": {},
"enabled": true,
"environment": null,
"id_length_limit": null,
"label_key_case": null,
"label_order": [],
"label_value_case": null,
"labels_as_tags": [
"unset"
],
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
}
no
create_security_groupSet true to create and configure a new security group. If false, associated_security_group_ids must be provided.booltrueno
custom_broker_dns_nameCustom Route53 DNS hostname for MSK brokers. Use %%ID%% key to specify brokers index in the hostname. Example: kafka-broker%%ID%%.example.comstringnullno
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
stringnullno
descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br/> format = string<br/> labels = list(string)<br/>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).
any{}no
dns_delegated_component_nameThe component name of dns-delegatedstring"dns-delegated"no
dns_delegated_environment_nameThe environment name of dns-delegatedstring"gbl"no
enabledSet to false to prevent the module from creating any resourcesboolnullno
encryption_at_rest_kms_key_arnYou may specify a KMS key short ID or ARN (it will always output an ARN) to use for encrypting your data at reststring""no
encryption_in_clusterWhether data communication among broker nodes is encryptedbooltrueno
enhanced_monitoringSpecify the desired enhanced MSK CloudWatch monitoring level. Valid values: DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKERstring"DEFAULT"no
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
firehose_delivery_streamName of the Kinesis Data Firehose delivery stream to deliver logs tostring""no
firehose_logs_enabledIndicates whether you want to enable or disable streaming broker logs to Kinesis Data Firehoseboolfalseno
id_length_limitLimit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.
numbernullno
inline_rules_enabledNOT RECOMMENDED. Create rules "inline" instead of as separate aws_security_group_rule resources.
See #20046 for one of several issues with inline rules.
See this post for details on the difference between inline rules and rule resources.
boolfalseno
jmx_exporter_enabledSet true to enable the JMX Exporterboolfalseno
kafka_versionThe desired Kafka software version.
Refer to https://docs.aws.amazon.com/msk/latest/developerguide/supported-kafka-versions.html for more details
stringn/ayes
label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.
stringnullno
label_orderThe order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.
list(string)nullno
label_value_caseControls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.
stringnullno
labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.
set(string)
[
"default"
]
no
nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.
stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
node_exporter_enabledSet true to enable the Node Exporterboolfalseno
preserve_security_group_idWhen false and security_group_create_before_destroy is true, changes to security group rules
cause a new security group to be created with the new rules, and the existing security group is then
replaced with the new one, eliminating any service interruption.
When true or when changing the value (from false to true or from true to false),
existing security group rules will be deleted before new ones are created, resulting in a service interruption,
but preserving the security group itself.
NOTE: Setting this to true does not guarantee the security group will never be replaced,
it only keeps changes to the security group rules from triggering a replacement.
See the terraform-aws-security-group README for further discussion.
boolfalseno
propertiesContents of the server.properties file. Supported properties are documented in the MSK Developer Guidemap(string){}no
public_access_enabledEnable public access to MSK cluster (given that all of the requirements are met)boolfalseno
regex_replace_charsTerraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.
stringnullno
regionAWS regionstringn/ayes
s3_logs_bucketName of the S3 bucket to deliver logs tostring""no
s3_logs_enabledIndicates whether you want to enable or disable streaming broker logs to S3boolfalseno
s3_logs_prefixPrefix to append to the S3 folder name logs are delivered tostring""no
security_group_create_before_destroySet true to enable terraform create_before_destroy behavior on the created security group.
We only recommend setting this false if you are importing an existing security group
that you do not want replaced and therefore need full control over its name.
Note that changing this value will always cause the security group to be replaced.
booltrueno
security_group_create_timeoutHow long to wait for the security group to be created.string"10m"no
security_group_delete_timeoutHow long to retry on DependencyViolation errors during security group deletion from
lingering ENIs left by certain AWS services such as Elastic Load Balancing.
string"15m"no
security_group_descriptionThe description to assign to the created Security Group.
Warning: Changing the description causes the security group to be replaced.
string"Managed by Terraform"no
security_group_nameThe name to assign to the created security group. Must be unique within the VPC.
If not provided, will be derived from the null-label.context passed in.
If create_before_destroy is true, will be used as a name prefix.
list(string)[]no
security_group_rule_descriptionThe description to place on each security group rule. The %s will be replaced with the protocol namestring"Allow inbound %s traffic"no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
storage_autoscaling_disable_scale_inIf the value is true, scale in is disabled and the target tracking policy won't remove capacity from the scalable resourceboolfalseno
storage_autoscaling_max_capacityMaximum size the autoscaling policy can scale storage. Defaults to broker_volume_sizenumbernullno
storage_autoscaling_target_valuePercentage of storage used to trigger autoscaled storage increasenumber60no
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
vpc_component_nameThe name of the Atmos VPC componentstringn/ayes

Outputs

NameDescription
bootstrap_brokersComma separated list of one or more hostname:port pairs of Kafka brokers suitable to bootstrap connectivity to the Kafka cluster
bootstrap_brokers_public_sasl_iamComma separated list of one or more DNS names (or IP addresses) and SASL IAM port pairs for public access to the Kafka cluster using SASL/IAM
bootstrap_brokers_public_sasl_scramComma separated list of one or more DNS names (or IP addresses) and SASL SCRAM port pairs for public access to the Kafka cluster using SASL/SCRAM
bootstrap_brokers_public_tlsComma separated list of one or more DNS names (or IP addresses) and TLS port pairs for public access to the Kafka cluster using TLS
bootstrap_brokers_sasl_iamComma separated list of one or more DNS names (or IP addresses) and SASL IAM port pairs for access to the Kafka cluster using SASL/IAM
bootstrap_brokers_sasl_scramComma separated list of one or more DNS names (or IP addresses) and SASL SCRAM port pairs for access to the Kafka cluster using SASL/SCRAM
bootstrap_brokers_tlsComma separated list of one or more DNS names (or IP addresses) and TLS port pairs for access to the Kafka cluster using TLS
broker_endpointsList of broker endpoints
cluster_arnAmazon Resource Name (ARN) of the MSK cluster
cluster_nameThe cluster name of the MSK cluster
config_arnAmazon Resource Name (ARN) of the MSK configuration
current_versionCurrent version of the MSK Cluster
hostnamesList of MSK Cluster broker DNS hostnames
latest_revisionLatest revision of the MSK configuration
security_group_arnThe ARN of the created security group
security_group_idThe ID of the created security group
security_group_nameThe name of the created security group
storage_modeStorage mode for supported storage tiers
zookeeper_connect_stringComma separated list of one or more hostname:port pairs to connect to the Apache Zookeeper cluster
zookeeper_connect_string_tlsComma separated list of one or more hostname:port pairs to connect to the Apache Zookeeper cluster via TLS

References