Home

Awesome

<!-- markdownlint-disable -->

<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse-terraform-components/aws-mq-broker/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse-terraform-components/aws-mq-broker/releases/latest"><img src="https://img.shields.io/github/release/cloudposse-terraform-components/aws-mq-broker.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>

<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->

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
<!-- prettier-ignore-start --> <!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

Requirements

NameVersion
<a name="requirement_terraform"></a> terraform>= 1.0.0
<a name="requirement_aws"></a> aws>= 4.0
<a name="requirement_local"></a> local>= 2.4
<a name="requirement_template"></a> template>= 2.2
<a name="requirement_utils"></a> utils>= 1.10.0

Providers

No providers.

Modules

NameSourceVersion
<a name="module_eks"></a> ekscloudposse/stack-config/yaml//modules/remote-state1.5.0
<a name="module_iam_roles"></a> iam_roles../account-map/modules/iam-rolesn/a
<a name="module_mq_broker"></a> mq_brokercloudposse/mq-broker/aws3.0.0
<a name="module_this"></a> thiscloudposse/label/null0.25.0
<a name="module_vpc"></a> vpccloudposse/stack-config/yaml//modules/remote-state1.5.0

Resources

No resources.

Inputs

NameDescriptionTypeDefaultRequired
<a name="input_additional_tag_map"></a> additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration.map(string){}no
<a name="input_allowed_cidr_blocks"></a> allowed_cidr_blocksList of CIDR blocks that are allowed ingress to the broker's Security Group created in the modulelist(string)[]no
<a name="input_allowed_security_groups"></a> allowed_security_groupsList of security groups to be allowed to connect to the broker instancelist(string)[]no
<a name="input_apply_immediately"></a> apply_immediatelySpecifies whether any cluster modifications are applied immediately, or during the next maintenance windowboolfalseno
<a name="input_attributes"></a> attributesID element. Additional attributes (e.g. workers or cluster) to add to id,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the delimiter<br/>and treated as a single ID element.list(string)[]no
<a name="input_audit_log_enabled"></a> audit_log_enabledEnables audit logging. User management action made using JMX or the ActiveMQ Web Console is loggedbooltrueno
<a name="input_auto_minor_version_upgrade"></a> auto_minor_version_upgradeEnables automatic upgrades to new minor versions for brokers, as Apache releases the versionsboolfalseno
<a name="input_context"></a> contextSingle object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as null to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged.any<pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre>no
<a name="input_delimiter"></a> delimiterDelimiter to be used between ID elements.<br/>Defaults to - (hyphen). Set to "" to use no delimiter at all.stringnullno
<a name="input_deployment_mode"></a> deployment_modeThe deployment mode of the broker. Supported: SINGLE_INSTANCE and ACTIVE_STANDBY_MULTI_AZstring"ACTIVE_STANDBY_MULTI_AZ"no
<a name="input_descriptor_formats"></a> descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>{<br/> format = string<br/> labels = list(string)<br/>}<br/>(Type is any so the map values can later be enhanced to provide additional options.)<br/>format is a Terraform format string to be passed to the format() function.<br/>labels is a list of labels, in order, to pass to format() function.<br/>Label values will be normalized before being passed to format() so they will be<br/>identical to how they appear in id.<br/>Default is {} (descriptors output will be empty).any{}no
<a name="input_enabled"></a> enabledSet to false to prevent the module from creating any resourcesboolnullno
<a name="input_encryption_enabled"></a> encryption_enabledFlag to enable/disable Amazon MQ encryption at restbooltrueno
<a name="input_engine_type"></a> engine_typeType of broker engine, ActiveMQ or RabbitMQstring"ActiveMQ"no
<a name="input_engine_version"></a> engine_versionThe version of the broker engine. See https://docs.aws.amazon.com/amazon-mq/latest/developer-guide/broker-engine.html for more detailsstring"5.15.14"no
<a name="input_environment"></a> environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
<a name="input_existing_security_groups"></a> existing_security_groupsList 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 brokerlist(string)[]no
<a name="input_general_log_enabled"></a> general_log_enabledEnables general logging via CloudWatchbooltrueno
<a name="input_host_instance_type"></a> host_instance_typeThe broker's instance type. e.g. mq.t2.micro or mq.m4.largestring"mq.t3.micro"no
<a name="input_id_length_limit"></a> id_length_limitLimit id to this many characters (minimum 6).<br/>Set to 0 for unlimited length.<br/>Set to null for keep the existing setting, which defaults to 0.<br/>Does not affect id_full.numbernullno
<a name="input_kms_mq_key_arn"></a> kms_mq_key_arnARN of the AWS KMS key used for Amazon MQ encryptionstringnullno
<a name="input_kms_ssm_key_arn"></a> kms_ssm_key_arnARN of the AWS KMS key used for SSM encryptionstring"alias/aws/ssm"no
<a name="input_label_key_case"></a> label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the tags input.<br/>Possible values: lower, title, upper.<br/>Default value: title.stringnullno
<a name="input_label_order"></a> label_orderThe order in which the labels (ID elements) appear in the id.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.list(string)nullno
<a name="input_label_value_case"></a> label_value_caseControls the letter case of ID elements (labels) as included in id,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the tags input.<br/>Possible values: lower, title, upper and none (no transformation).<br/>Set this to title and set delimiter to "" to yield Pascal Case IDs.<br/>Default value: lower.stringnullno
<a name="input_labels_as_tags"></a> labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the tags output.<br/>Set to [] to suppress all generated tags.<br/>Notes:<br/> The value of the name tag, if included, will be the id, not the name.<br/> Unlike other null-label inputs, the initial setting of labels_as_tags cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.set(string)<pre>[<br/> "default"<br/>]</pre>no
<a name="input_maintenance_day_of_week"></a> maintenance_day_of_weekThe maintenance day of the week. e.g. MONDAY, TUESDAY, or WEDNESDAYstring"SUNDAY"no
<a name="input_maintenance_time_of_day"></a> maintenance_time_of_dayThe maintenance time, in 24-hour format. e.g. 02:00string"03:00"no
<a name="input_maintenance_time_zone"></a> maintenance_time_zoneThe maintenance time zone, in either the Country/City format, or the UTC offset format. e.g. CETstring"UTC"no
<a name="input_mq_admin_password"></a> mq_admin_passwordAdmin passwordstringnullno
<a name="input_mq_admin_password_ssm_parameter_name"></a> mq_admin_password_ssm_parameter_nameSSM parameter name for Admin passwordstring"mq_admin_password"no
<a name="input_mq_admin_user"></a> mq_admin_userAdmin usernamestringnullno
<a name="input_mq_admin_user_ssm_parameter_name"></a> mq_admin_user_ssm_parameter_nameSSM parameter name for Admin usernamestring"mq_admin_username"no
<a name="input_mq_application_password"></a> mq_application_passwordApplication passwordstringnullno
<a name="input_mq_application_password_ssm_parameter_name"></a> mq_application_password_ssm_parameter_nameSSM parameter name for Application passwordstring"mq_application_password"no
<a name="input_mq_application_user"></a> mq_application_userApplication usernamestringnullno
<a name="input_mq_application_user_ssm_parameter_name"></a> mq_application_user_ssm_parameter_nameSSM parameter name for Application usernamestring"mq_application_username"no
<a name="input_name"></a> nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a tag.<br/>The "name" tag is set to the full id string. There is no tag with the value of the name input.stringnullno
<a name="input_namespace"></a> namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
<a name="input_overwrite_ssm_parameter"></a> overwrite_ssm_parameterWhether to overwrite an existing SSM parameterbooltrueno
<a name="input_publicly_accessible"></a> publicly_accessibleWhether to enable connections from applications outside of the VPC that hosts the broker's subnetsboolfalseno
<a name="input_regex_replace_chars"></a> regex_replace_charsTerraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.stringnullno
<a name="input_region"></a> regionAWS Regionstringn/ayes
<a name="input_ssm_parameter_name_format"></a> ssm_parameter_name_formatSSM parameter name formatstring"/%s/%s"no
<a name="input_ssm_path"></a> ssm_pathSSM pathstring"mq"no
<a name="input_stage"></a> stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
<a name="input_tags"></a> tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).<br/>Neither the tag keys nor the tag values will be modified by this module.map(string){}no
<a name="input_tenant"></a> tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
<a name="input_use_aws_owned_key"></a> use_aws_owned_keyBoolean to enable an AWS owned Key Management Service (KMS) Customer Master Key (CMK) for Amazon MQ encryption that is not in your accountbooltrueno
<a name="input_use_existing_security_groups"></a> use_existing_security_groupsFlag 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 intoboolfalseno

Outputs

NameDescription
<a name="output_admin_username"></a> admin_usernameAmazonMQ admin username
<a name="output_application_username"></a> application_usernameAmazonMQ application username
<a name="output_broker_arn"></a> broker_arnAmazonMQ broker ARN
<a name="output_broker_id"></a> broker_idAmazonMQ broker ID
<a name="output_primary_amqp_ssl_endpoint"></a> primary_amqp_ssl_endpointAmazonMQ primary AMQP+SSL endpoint
<a name="output_primary_console_url"></a> primary_console_urlAmazonMQ active web console URL
<a name="output_primary_ip_address"></a> primary_ip_addressAmazonMQ primary IP address
<a name="output_primary_mqtt_ssl_endpoint"></a> primary_mqtt_ssl_endpointAmazonMQ primary MQTT+SSL endpoint
<a name="output_primary_ssl_endpoint"></a> primary_ssl_endpointAmazonMQ primary SSL endpoint
<a name="output_primary_stomp_ssl_endpoint"></a> primary_stomp_ssl_endpointAmazonMQ primary STOMP+SSL endpoint
<a name="output_primary_wss_endpoint"></a> primary_wss_endpointAmazonMQ primary WSS endpoint
<a name="output_secondary_amqp_ssl_endpoint"></a> secondary_amqp_ssl_endpointAmazonMQ secondary AMQP+SSL endpoint
<a name="output_secondary_console_url"></a> secondary_console_urlAmazonMQ secondary web console URL
<a name="output_secondary_ip_address"></a> secondary_ip_addressAmazonMQ secondary IP address
<a name="output_secondary_mqtt_ssl_endpoint"></a> secondary_mqtt_ssl_endpointAmazonMQ secondary MQTT+SSL endpoint
<a name="output_secondary_ssl_endpoint"></a> secondary_ssl_endpointAmazonMQ secondary SSL endpoint
<a name="output_secondary_stomp_ssl_endpoint"></a> secondary_stomp_ssl_endpointAmazonMQ secondary STOMP+SSL endpoint
<a name="output_secondary_wss_endpoint"></a> secondary_wss_endpointAmazonMQ secondary WSS endpoint
<a name="output_security_group_arn"></a> security_group_arnThe ARN of the created security group
<a name="output_security_group_id"></a> security_group_idAmazonMQ security group id
<a name="output_security_group_name"></a> security_group_nameThe name of the created security group
<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK --> <!-- prettier-ignore-end -->

References

[!TIP]

πŸ‘½ Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. <br/> Works with Github Actions, Atlantis, or Spacelift.

<details> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/><br/> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i> </detalis>

Related Projects

Check out these related projects.

[!TIP]

Use Terraform Reference Architectures for AWS

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.<br/> βœ… Your team owns everything.<br/> βœ… 100% Open Source and backed by fanatical support.<br/>

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-mq-broker&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

<details><summary>πŸ“š <strong>Learn More</strong></summary> <br/>

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.

Day-0: Your Foundation for Success

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-mq-broker&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-mq-broker&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

</details>

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

<a href="https://github.com/cloudposse-terraform-components/aws-mq-broker/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse-terraform-components/aws-mq-broker&max=24" /> </a>

For πŸ› bug reports & feature requests, please use the issue tracker.

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

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. 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!

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

πŸ“° Newsletter

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.

πŸ“† Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-mq-broker&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

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!

License

<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>

<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>
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.
</details>

Trademarks

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


Copyright Β© 2017-2024 Cloud Posse, LLC

<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse-terraform-components/aws-mq-broker&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>

<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse-terraform-components/aws-mq-broker?pixel&cs=github&cm=readme&an=aws-mq-broker"/>