Skip to main content
Sponsor @cloudposse

Module: mq-broker

Terraform module to provision AmazonMQ resources on AWS

Introduction​

This module provisions the following resources:

  • ActiveMQ broker
  • RabbitMQ broker
  • Security group rules to allow access to the broker

Admin and application users are created and credentials written to SSM if not passed in as variables.

Usage​

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

  module "mq_broker" {
    source = "cloudposse/mq-broker/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"

    namespace                  = "eg"
    stage                      = "test"
    name                       = "mq-broker"
    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
    vpc_id                     = var.vpc_id
    subnet_ids                 = var.subnet_ids
    security_groups            = var.security_groups
  }

Variables​

Required Variables​

subnet_ids (list(string)) required

List of VPC subnet IDs

vpc_id (string) required

The ID of the VPC to create the broker in

Optional Variables​

additional_security_group_rules (list(any)) optional

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



Default value: [ ]

allow_all_egress (bool) optional

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



Default value: true

allowed_cidr_blocks (list(string)) optional

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



Default value: [ ]

allowed_ingress_ports (list(number)) optional

List of TCP ports to allow access to in the created security group.
Default is to allow access to all ports. Set create_security_group to false to disable.
Note: List of ports must be known at "plan" time.



Default value: [ ]

allowed_ipv6_cidr_blocks (list(string)) optional

A list of IPv6 CIDRs to allow access to the security group created by this module.
The length of this list must be known at "plan" time.



Default value: [ ]

allowed_ipv6_prefix_list_ids (list(string)) optional

A list of IPv6 Prefix Lists IDs to allow access to the security group created by this module.
The length of this list must be known at "plan" time.



Default value: [ ]

allowed_security_group_ids (list(string)) optional

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



Default value: [ ]

allowed_security_groups (list(string)) optional

DEPRECATED: Use allowed_security_group_ids instead.
A list of Security Group IDs to 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

associated_security_group_ids (list(string)) optional

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



Default value: [ ]

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

configuration_data (string) optional

data value for configuration


Default value: null

create_security_group (bool) optional

Set true to create and configure a new security group. If false, associated_security_group_ids must be provided.


Default value: true

deployment_mode (string) optional

The deployment mode of the broker. Supported: SINGLE_INSTANCE and ACTIVE_STANDBY_MULTI_AZ, and CLUSTER_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.17.6"

existing_security_groups (list(string)) optional

DEPRECATED: Use associated_security_group_ids instead.
List of existing Security Group IDs to place the broker into.



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 (list(string)) optional

Admin password


Default value: [ ]

mq_admin_password_ssm_parameter_name (string) optional

SSM parameter name for Admin password


Default value: "mq_admin_password"

mq_admin_user (list(string)) optional

Admin username


Default value: [ ]

mq_admin_user_ssm_parameter_name (string) optional

SSM parameter name for Admin username


Default value: "mq_admin_username"

mq_application_password (list(string)) optional

Application password


Default value: [ ]

mq_application_password_ssm_parameter_name (string) optional

SSM parameter name for Application password


Default value: "mq_application_password"

mq_application_user (list(string)) optional

Application username


Default value: [ ]

mq_application_user_ssm_parameter_name (string) optional

SSM parameter name for Application username


Default value: "mq_application_username"

preserve_security_group_id (bool) optional

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



Default value: false

publicly_accessible (bool) optional

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


Default value: false

security_group_create_before_destroy (bool) optional

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



Default value: true

security_group_create_timeout (string) optional

How long to wait for the security group to be created.


Default value: "10m"

security_group_delete_timeout (string) optional

How long to retry on DependencyViolation errors during security group deletion from
lingering ENIs left by certain AWS services such as Elastic Load Balancing.



Default value: "15m"

security_group_description (string) optional

The description to assign to the created Security Group.
Warning: Changing the description causes the security group to be replaced.



Default value: "Managed by Terraform"

security_group_name (list(string)) optional

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



Default value: [ ]

ssm_parameter_name_format (string) optional

SSM parameter name format


Default value: "/%s/%s"

ssm_parameters_enabled (bool) optional

Whether to create SSM parameters for MQ users and passwords


Default value: true

ssm_path (string) optional

The first parameter to substitute in ssm_parameter_name_format


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

DEPRECATED: Use create_security_group instead.
Historical description: Set to true to disable Security Group creation



Default value: null

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_password

AmazonMQ application password

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

The ID of the created security group

security_group_name

The name of the created security group

Dependencies​

Requirements​

  • terraform, version: >= 1.0.0
  • aws, version: >= 3.0
  • random, version: >= 3.0

Providers​

  • aws, version: >= 3.0
  • random, version: >= 3.0

Modules​

NameVersionSourceDescription
security_group2.2.0cloudposse/security-group/awsn/a
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: