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

module "amq" {
  source                     = "git::https://github.com/cloudposse/terraform-aws-mq-broker.git?ref=master"
  enabled                    = "${var.mq_enabled}"
  namespace                  = "${var.namespace}"
  stage                      = "${var.stage}"
  name                       = "${var.name}"
  apply_immediately          = "${var.mq_apply_immediately}"
  auto_minor_version_upgrade = "${var.mq_auto_minor_version_upgrade}"
  deployment_mode            = "${var.mq_deployment_mode}"
  engine_type                = "${var.mq_engine_type}"
  engine_version             = "${var.mq_engine_version}"
  configuration_name         = "${var.mq_configuration_name}"
  host_instance_type         = "${var.mq_host_instance_type}"
  publicly_accessible        = "${var.mq_publicly_accessible}"
  general_log                = "${var.mq_general_log}"
  audit_log                  = "${var.mq_audit_log}"
  maintenance_day_of_week    = "${var.mq_maintenance_day_of_week}"
  maintenance_time_of_day    = "${var.mq_maintenance_time_of_day}"
  maintenance_time_zone      = "${var.mq_maintenance_time_zone}"
  config_template_path       = "${var.mq_config_template_path}"
  vpc_id                     = "${var.vpc_id}"
  subnet_ids                 = ["${var.mq_subnet_ids}"]
  security_groups            = ["${var.node_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

Inputs

Name	Description	Type	Default	Required
apply_immediately	Specifies whether any cluster modifications are applied immediately, or during the next maintenance window	string	`false`	no
attributes	Additional attributes (e.g. `1`)	list	`<list>`	no
audit_log	Enables audit logging. User management action made using JMX or the ActiveMQ Web Console is logged	string	`true`	no
auto_minor_version_upgrade	Enables automatic upgrades to new minor versions for brokers, as Apache releases the versions	string	`false`	no
chamber_parameter_name	Format to store parameters in SSM, for consumption with chamber	string	`/%s/%s`	no
chamber_service	SSM parameter service name for use with chamber. This is used in chamber_format where /$chamber_service/$parameter would be the default.	string	``	no
delimiter	Delimiter to be used between `name`, `namespace`, `stage` and `attributes`	string	`-`	no
deployment_mode	The deployment mode of the broker. Supported: SINGLE_INSTANCE and ACTIVE_STANDBY_MULTI_AZ	string	`ACTIVE_STANDBY_MULTI_AZ`	no
engine_type	The type of broker engine. Currently, Amazon MQ supports only ActiveMQ	string	`ActiveMQ`	no
engine_version	The version of the broker engine. Currently, Amazon MQ supports only 5.15.0 or 5.15.6.	string	`5.15.0`	no
general_log	Enables general logging via CloudWatch	string	`true`	no
host_instance_type	The broker's instance type. e.g. mq.t2.micro or mq.m4.large	string	`mq.t2.micro`	no
kms_key_id	KMS key ID used to encrypt SSM parameters	string	``	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	``	no
mq_admin_user	Admin username	string	``	no
mq_application_password	Application password	string	``	no
mq_application_user	Application username	string	``	no
name	Name of the application	string	-	yes
namespace	Namespace (e.g. `eg` or `cp`)	string	-	yes
overwrite_ssm_parameter	Whether to overwrite an existing SSM parameter	string	`true`	no
publicly_accessible	Whether to enable connections from applications outside of the VPC that hosts the broker's subnets.	string	`false`	no
security_groups	List of security groups to be allowed to connect to the ActiveMQ instance	list	`<list>`	no
stage	Stage (e.g. `prod`, `dev`, `staging`)	string	-	yes
subnet_ids	List of VPC subnet IDs	list	-	yes
tags	Additional tags (e.g. map(`BusinessUnit`,`XYZ`)	map	`<map>`	no
vpc_id	VPC ID to create the cluster in (e.g. `vpc-a22222ee`)	string	-	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

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?

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

Commercial Support

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

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

Questions. We'll use a Shared Slack channel between your team and ours.
Troubleshooting. We'll help you triage why things aren't working.
Code Reviews. We'll review your Pull Requests and provide constructive feedback.
Bug Fixes. We'll rapidly work to fix any bugs in our projects.
Build New Terraform Modules. We'll develop original modules to provision infrastructure.
Cloud Architecture. We'll assist with your cloud strategy and design.
Implementation. We'll provide hands-on support to implement our reference architectures.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

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.

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

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

libertyy/terraform-aws-mq-broker