Terraform module to provision AmazonMQ resources on AWS
Tip
Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.
Watch demo of using Atmos with Terraform
Example of running
atmos to manage infrastructure from our Quick Start tutorial.
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.
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
}Important
In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.
Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
| Name | Version |
|---|---|
| terraform | >= 1.0.0 |
| aws | >= 3.0 |
| random | >= 3.0 |
| Name | Version |
|---|---|
| aws | >= 3.0 |
| random | >= 3.0 |
| Name | Source | Version |
|---|---|---|
| security_group | cloudposse/security-group/aws | 2.2.0 |
| this | cloudposse/label/null | 0.25.0 |
| 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_pet.mq_admin_user | resource |
| random_pet.mq_application_user | resource |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| additional_security_group_rules | 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 falseand 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, exceptfor 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_map | 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. |
map(string) |
{} |
no |
| allow_all_egress | 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. |
bool |
true |
no |
| allowed_cidr_blocks | 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. |
list(string) |
[] |
no |
| allowed_ingress_ports | 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. |
list(number) |
[] |
no |
| allowed_ipv6_cidr_blocks | 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. |
list(string) |
[] |
no |
| allowed_ipv6_prefix_list_ids | 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. |
list(string) |
[] |
no |
| allowed_security_group_ids | 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. |
list(string) |
[] |
no |
| allowed_security_groups | DEPRECATED: Use allowed_security_group_ids instead.A list of Security Group IDs to to be allowed to connect to the broker instance. |
list(string) |
[] |
no |
| apply_immediately | Specifies whether any cluster modifications are applied immediately, or during the next maintenance window | bool |
false |
no |
| associated_security_group_ids | 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. |
list(string) |
[] |
no |
| attributes | 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 delimiterand treated as a single ID element. |
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 |
{ |
no |
| create_security_group | Set true to create and configure a new security group. If false, associated_security_group_ids must be provided. |
bool |
true |
no |
| delimiter | Delimiter to be used between ID elements. 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 |
| descriptor_formats | 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 beidentical to how they appear in id.Default is {} (descriptors output will be empty). |
any |
{} |
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.17.6" |
no |
| environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string |
null |
no |
| existing_security_groups | DEPRECATED: Use associated_security_group_ids instead.List of existing Security Group IDs to place the broker into. |
list(string) |
[] |
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 keep the existing setting, which defaults to 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 | 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. |
string |
null |
no |
| label_order | 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. |
list(string) |
null |
no |
| label_value_case | 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. |
string |
null |
no |
| labels_as_tags | 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 bechanged in later chained modules. Attempts to change it will be silently ignored. |
set(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 | list(string) |
[] |
no |
| mq_admin_password_ssm_parameter_name | SSM parameter name for Admin password | string |
"mq_admin_password" |
no |
| mq_admin_user | Admin username | list(string) |
[] |
no |
| mq_admin_user_ssm_parameter_name | SSM parameter name for Admin username | string |
"mq_admin_username" |
no |
| mq_application_password | Application password | list(string) |
[] |
no |
| mq_application_password_ssm_parameter_name | SSM parameter name for Application password | string |
"mq_application_password" |
no |
| mq_application_user | Application username | list(string) |
[] |
no |
| mq_application_user_ssm_parameter_name | SSM parameter name for Application username | string |
"mq_application_username" |
no |
| name | 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. |
string |
null |
no |
| namespace | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | string |
null |
no |
| preserve_security_group_id | When false and security_group_create_before_destroy is true, changes to security group rulescause 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. |
bool |
false |
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 | 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. |
string |
null |
no |
| security_group_create_before_destroy | 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 groupthat 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. |
bool |
true |
no |
| security_group_create_timeout | How long to wait for the security group to be created. | string |
"10m" |
no |
| security_group_delete_timeout | How long to retry on DependencyViolation errors during security group deletion fromlingering ENIs left by certain AWS services such as Elastic Load Balancing. |
string |
"15m" |
no |
| security_group_description | The 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_name | 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. |
list(string) |
[] |
no |
| ssm_parameter_name_format | SSM parameter name format | string |
"/%s/%s" |
no |
| ssm_path | The first parameter to substitute in ssm_parameter_name_format |
string |
"mq" |
no |
| stage | ID element. Usually used to indicate role, e.g. 'prod', 'staging', '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. {'BusinessUnit': 'XYZ'}).Neither the tag keys nor the tag values will be modified by this module. |
map(string) |
{} |
no |
| tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string |
null |
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 |
| use_existing_security_groups | DEPRECATED: Use create_security_group instead.Historical description: Set to true to disable Security Group creation |
bool |
null |
no |
| vpc_id | The ID of the VPC to create the broker in | string |
n/a | yes |
| 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 | 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 |
Check out these related projects.
- terraform-aws-codefresh-backing-services - Terraform module to provision CodeFresh Enterprise backing services
Tip
Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.
✅ We build it together with your team.
✅ Your team owns everything.
✅ 100% Open Source and backed by fanatical support.
📚 Learn More
Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.
Your team can operate like a pro today.
Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
- Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
- Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
- GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.
- Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
- Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
- Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
- Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
- Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
- Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
- Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.
This project is under active development, and we encourage contributions from our community.
Many thanks to our outstanding contributors:
For 🐛 bug reports & feature requests, please use the issue tracker.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- Review our Code of Conduct and Contributor Guidelines.
- 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!
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.
Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.
Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!
Preamble to the Apache License, Version 2.0
Complete license is available in the LICENSE file.
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.
All other trademarks referenced herein are the property of their respective owners.
Copyright © 2017-2024 Cloud Posse, LLC
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![renovate[bot] avatar](https://avatars.githubusercontent.com/in/2740?v=4 "renovate[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent