terraform-aws-mq-broker

Terraform module to provision AmazonMQ resources on AWS

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

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.

Security & Compliance

Security scanning is graciously provided by Bridgecrew. Bridgecrew is the leading fully hosted, cloud-native solution providing continuous Terraform security and compliance.

Benchmark	Description
	Infrastructure Security Compliance
	Center for Internet Security, KUBERNETES Compliance
	Center for Internet Security, AWS Compliance
	Center for Internet Security, AZURE Compliance
	Payment Card Industry Data Security Standards Compliance
	National Institute of Standards and Technology Compliance
	Information Security Management System, ISO/IEC 27001 Compliance
	Service Organization Control 2 Compliance
	Center for Internet Security, GCP Compliance
	Health Insurance Portability and Accountability Compliance

Usage

IMPORTANT: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.

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
  }

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Requirements

Name	Version
terraform	>= 0.13.0
aws	>= 2.0
null	>= 2.0
random	>= 2.2.0
template	>= 2.0

Providers

Name	Version
aws	>= 2.0
random	>= 2.2.0

Modules

Name	Source	Version
security_group	cloudposse/security-group/aws	0.3.1
this	cloudposse/label/null	0.24.1

Resources

Name	Type
aws_mq_broker.default	resource
aws_ssm_parameter.mq_application_password	resource
aws_ssm_parameter.mq_application_username	resource
aws_ssm_parameter.mq_master_password	resource
aws_ssm_parameter.mq_master_username	resource
random_password.mq_admin_password	resource
random_password.mq_application_password	resource
random_string.mq_admin_user	resource
random_string.mq_application_user	resource

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional tags for appending to tags_as_list_of_maps. Not added to `tags`.	`map(string)`	`{}`	no
apply_immediately	Specifies whether any cluster modifications are applied immediately, or during the next maintenance window	`bool`	`false`	no
attributes	Additional attributes (e.g. `1`)	`list(string)`	`[]`	no
audit_log_enabled	Enables audit logging. User management action made using JMX or the ActiveMQ Web Console is logged	`bool`	`true`	no
auto_minor_version_upgrade	Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions	`bool`	`false`	no
context	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.	`any`	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {} }	no
delimiter	Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes`. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
deployment_mode	The deployment mode of the broker. Supported: SINGLE_INSTANCE and ACTIVE_STANDBY_MULTI_AZ	`string`	`"ACTIVE_STANDBY_MULTI_AZ"`	no
enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
encryption_enabled	Flag to enable/disable Amazon MQ encryption at rest	`bool`	`true`	no
engine_type	Type of broker engine, `ActiveMQ` or `RabbitMQ`	`string`	`"ActiveMQ"`	no
engine_version	The version of the broker engine. See https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html for more details	`string`	`"5.15.14"`	no
environment	Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
general_log_enabled	Enables general logging via CloudWatch	`bool`	`true`	no
host_instance_type	The broker's instance type. e.g. mq.t2.micro or mq.m4.large	`string`	`"mq.t3.micro"`	no
id_length_limit	Limit `id` to this many characters (minimum 6). Set to `0` for unlimited length. Set to `null` for default, which is `0`. Does not affect `id_full`.	`number`	`null`	no
kms_mq_key_arn	ARN of the AWS KMS key used for Amazon MQ encryption	`string`	`null`	no
kms_ssm_key_arn	ARN of the AWS KMS key used for SSM encryption	`string`	`"alias/aws/ssm"`	no
label_key_case	The letter case of label keys (`tag` names) (i.e. `name`, `namespace`, `environment`, `stage`, `attributes`) to use in `tags`. Possible values: `lower`, `title`, `upper`. Default value: `title`.	`string`	`null`	no
label_order	The naming order of the id output and Name tag. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 5 elements, but at least one must be present.	`list(string)`	`null`	no
label_value_case	The letter case of output label values (also used in `tags` and `id`). Possible values: `lower`, `title`, `upper` and `none` (no transformation). Default value: `lower`.	`string`	`null`	no
maintenance_day_of_week	The maintenance day of the week. e.g. MONDAY, TUESDAY, or WEDNESDAY	`string`	`"SUNDAY"`	no
maintenance_time_of_day	The maintenance time, in 24-hour format. e.g. 02:00	`string`	`"03:00"`	no
maintenance_time_zone	The maintenance time zone, in either the Country/City format, or the UTC offset format. e.g. CET	`string`	`"UTC"`	no
mq_admin_password	Admin password	`string`	`null`	no
mq_admin_user	Admin username	`string`	`null`	no
mq_application_password	Application password	`string`	`null`	no
mq_application_user	Application username	`string`	`null`	no
name	Solution name, e.g. 'app' or 'jenkins'	`string`	`null`	no
namespace	Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'	`string`	`null`	no
overwrite_ssm_parameter	Whether to overwrite an existing SSM parameter	`bool`	`true`	no
publicly_accessible	Whether to enable connections from applications outside of the VPC that hosts the broker's subnets	`bool`	`false`	no
regex_replace_chars	Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`. If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
security_group_description	The Security Group description.	`string`	`"AmazonMQ Security Group"`	no
security_group_enabled	Whether to create Security Group.	`bool`	`true`	no
security_group_rules	A list of maps of Security Group rules. The values of map is fully complated with `aws_security_group_rule` resource. To get more info see https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule .	`list(any)`	[ { "cidr_blocks": [ "0.0.0.0/0" ], "description": "Allow all outbound traffic", "from_port": 0, "protocol": "-1", "to_port": 65535, "type": "egress" } ]	no
security_group_use_name_prefix	Whether to create a default Security Group with unique name beginning with the normalized prefix.	`bool`	`false`	no
security_groups	A list of Security Group IDs to associate with AmazonMQ.	`list(string)`	`[]`	no
ssm_parameter_name_format	SSM parameter name format	`string`	`"/%s/%s"`	no
ssm_path	SSM path	`string`	`"mq"`	no
stage	Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
subnet_ids	List of VPC subnet IDs	`list(string)`	n/a	yes
tags	Additional tags (e.g. `map('BusinessUnit','XYZ')`	`map(string)`	`{}`	no
use_aws_owned_key	Boolean to enable an AWS owned Key Management Service (KMS) Customer Master Key (CMK) for Amazon MQ encryption that is not in your account	`bool`	`true`	no
vpc_id	VPC ID to create the broker in	`string`	n/a	yes

Outputs

Name	Description
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	AmazonMQ Security Group ARN
security_group_id	AmazonMQ Security Group ID
security_group_name	AmazonMQ Security Group name

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

terraform-aws-codefresh-backing-services - Terraform module to provision CodeFresh Enterprise backing services

Help

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
Site Reliability Engineering. You'll have total visibility into your apps and microservices.
Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
GitOps. You'll be able to operate your infrastructure via Pull Requests.
Training. You'll receive hands-on training so your team can operate what we build.
Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
Troubleshooting. You'll get help to triage when things aren't working.
Code Reviews. You'll receive constructive feedback on Pull Requests.
Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Newsletter

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Josh Myers	Erik Osterman	Andriy Knysh	Vladimir Syromyatnikov

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

terraform-aws-mq-broker

Introduction

Security & Compliance

Usage

Makefile Targets

Requirements

Providers

Modules

Resources

Inputs

Outputs

Share the Love

Related Projects

Help

DevOps Accelerator for Startups

Slack Community

Discourse Forums

Newsletter

Office Hours

Contributing

Bug Reports & Feature Requests

Developing

Copyright

License

Trademarks

About

Contributors

Files

README.md

Latest commit

History

README.md

File metadata and controls

terraform-aws-mq-broker

Introduction

Security & Compliance

Usage

Makefile Targets

Requirements

Providers

Modules

Resources

Inputs

Outputs

Share the Love

Related Projects

Help

DevOps Accelerator for Startups

Slack Community

Discourse Forums

Newsletter

Office Hours

Contributing

Bug Reports & Feature Requests

Developing

Copyright

License

Trademarks

About

Contributors