mq-broker

This component is responsible for provisioning an AmazonMQ broker and corresponding security group.

Usage

Stack Level: Regional

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

components:
  terraform:
    mq-broker:
      vars:
        enabled: true
        apply_immediately: true
        auto_minor_version_upgrade: true
        deployment_mode: "ACTIVE_STANDBY_MULTI_AZ"
        engine_type: "ActiveMQ"
        engine_version: "5.15.14"
        host_instance_type: "mq.t3.micro"
        publicly_accessible: false
        general_log_enabled: true
        audit_log_enabled: true
        encryption_enabled: true
        use_aws_owned_key: true

Variables

Required Variables

region (string) required

AWS Region

Optional Variables

allowed_cidr_blocks (list(string)) optional

List of CIDR blocks that are allowed ingress to the broker's Security Group created in the module

Default value: [ ]

allowed_security_groups (list(string)) optional

List of security groups to be allowed to connect to the broker instance

Default value: [ ]

apply_immediately (bool) optional

Specifies whether any cluster modifications are applied immediately, or during the next maintenance window

Default value: false

audit_log_enabled (bool) optional

Enables audit logging. User management action made using JMX or the ActiveMQ Web Console is logged

Default value: true

auto_minor_version_upgrade (bool) optional

Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions

Default value: false

deployment_mode (string) optional

The deployment mode of the broker. Supported: SINGLE_INSTANCE and ACTIVE_STANDBY_MULTI_AZ

Default value: "ACTIVE_STANDBY_MULTI_AZ"

encryption_enabled (bool) optional

Flag to enable/disable Amazon MQ encryption at rest

Default value: true

engine_type (string) optional

Type of broker engine, ActiveMQ or RabbitMQ

Default value: "ActiveMQ"

engine_version (string) optional

The version of the broker engine. See https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html for more details

Default value: "5.15.14"

existing_security_groups (list(string)) optional

List of existing Security Group IDs to place the broker into. Set use_existing_security_groups to true to enable using existing_security_groups as Security Groups for the broker

Default value: [ ]

general_log_enabled (bool) optional

Enables general logging via CloudWatch

Default value: true

host_instance_type (string) optional

The broker's instance type. e.g. mq.t2.micro or mq.m4.large

Default value: "mq.t3.micro"

kms_mq_key_arn (string) optional

ARN of the AWS KMS key used for Amazon MQ encryption

Default value: null

kms_ssm_key_arn (string) optional

ARN of the AWS KMS key used for SSM encryption

Default value: "alias/aws/ssm"

maintenance_day_of_week (string) optional

The maintenance day of the week. e.g. MONDAY, TUESDAY, or WEDNESDAY

Default value: "SUNDAY"

maintenance_time_of_day (string) optional

The maintenance time, in 24-hour format. e.g. 02:00

Default value: "03:00"

maintenance_time_zone (string) optional

The maintenance time zone, in either the Country/City format, or the UTC offset format. e.g. CET

Default value: "UTC"

mq_admin_password (string) optional

Admin password

Default value: null

mq_admin_password_ssm_parameter_name (string) optional

SSM parameter name for Admin password

Default value: "mq_admin_password"

mq_admin_user (string) optional

Admin username

Default value: null

mq_admin_user_ssm_parameter_name (string) optional

SSM parameter name for Admin username

Default value: "mq_admin_username"

mq_application_password (string) optional

Application password

Default value: null

mq_application_password_ssm_parameter_name (string) optional

SSM parameter name for Application password

Default value: "mq_application_password"

mq_application_user (string) optional

Application username

Default value: null

mq_application_user_ssm_parameter_name (string) optional

SSM parameter name for Application username

Default value: "mq_application_username"

overwrite_ssm_parameter (bool) optional

Whether to overwrite an existing SSM parameter

Default value: true

publicly_accessible (bool) optional

Whether to enable connections from applications outside of the VPC that hosts the broker's subnets

Default value: false

ssm_parameter_name_format (string) optional

SSM parameter name format

Default value: "/%s/%s"

ssm_path (string) optional

SSM path

Default value: "mq"

use_aws_owned_key (bool) optional

Boolean to enable an AWS owned Key Management Service (KMS) Customer Master Key (CMK) for Amazon MQ encryption that is not in your account

Default value: true

use_existing_security_groups (bool) optional

Flag to enable/disable creation of Security Group in the module. Set to true to disable Security Group creation and provide a list of existing security Group IDs in existing_security_groups to place the broker into

Default value: false

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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

Required: No

Default value: { }

attributes (list(string)) optional

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

Required: No

Default value: [ ]

context (any) optional

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

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe 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).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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

Required: No

Default value: null

label_key_case (string) optional

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

Required: No

Default value: null

label_order (list(string)) optional

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

Required: No

Default value: null

label_value_case (string) optional

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

Required: No

Default value: null

labels_as_tags (set(string)) optional

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

Required: No

Default value:

[
  "default"
]

name (string) optional

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

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

admin_username

AmazonMQ admin username

application_username

AmazonMQ application username

broker_arn

AmazonMQ broker ARN

broker_id

AmazonMQ broker ID

primary_amqp_ssl_endpoint

AmazonMQ primary AMQP+SSL endpoint

primary_console_url

AmazonMQ active web console URL

primary_ip_address

AmazonMQ primary IP address

primary_mqtt_ssl_endpoint

AmazonMQ primary MQTT+SSL endpoint

primary_ssl_endpoint

AmazonMQ primary SSL endpoint

primary_stomp_ssl_endpoint

AmazonMQ primary STOMP+SSL endpoint

primary_wss_endpoint

AmazonMQ primary WSS endpoint

secondary_amqp_ssl_endpoint

AmazonMQ secondary AMQP+SSL endpoint

secondary_console_url

AmazonMQ secondary web console URL

secondary_ip_address

AmazonMQ secondary IP address

secondary_mqtt_ssl_endpoint

AmazonMQ secondary MQTT+SSL endpoint

secondary_ssl_endpoint

AmazonMQ secondary SSL endpoint

secondary_stomp_ssl_endpoint

AmazonMQ secondary STOMP+SSL endpoint

secondary_wss_endpoint

AmazonMQ secondary WSS endpoint

security_group_arn

The ARN of the created security group

security_group_id

AmazonMQ security group id

security_group_name

The name of the created security group

Dependencies

Requirements

• terraform, version: >= 1.0.0
• aws, version: >= 4.0
• local, version: >= 2.4
• template, version: >= 2.2
• utils, version: >= 1.10.0

Modules

Name	Version	Source	Description
eks	1.5.0	cloudposse/stack-config/yaml//modules/remote-state	n/a
iam_roles	latest	../account-map/modules/iam-roles	n/a
mq_broker	3.5.0	cloudposse/mq-broker/aws	n/a
this	0.25.0	cloudposse/label/null	n/a
vpc	1.5.0	cloudposse/stack-config/yaml//modules/remote-state	n/a

References

• cloudposse/terraform-aws-components - Cloud Posse's upstream component