README.yaml

---
#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-mq-broker

tags:
  - aws
  - terraform
  - terraform-modules
  - broker
  - message-broker
  - amazonmq
  - amazon-mq
  - activemq
  - active-mq
  - rabbitmq
  - rabbit-mq

categories:
  - terraform-modules/message-brokers

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-mq-broker

# Badges to display
badges:
  - name: "Latest Release"
    image: "https://img.shields.io/github/release/cloudposse/terraform-aws-mq-broker.svg"
    url: "https://github.com/cloudposse/terraform-aws-mq-broker/releases/latest"
  - name: "Slack Community"
    image: "https://slack.cloudposse.com/badge.svg"
    url: "https://slack.cloudposse.com"

related:
  - name: "terraform-aws-codefresh-backing-services"
    description: "Terraform module to provision CodeFresh Enterprise backing services"
    url: "https://github.com/cloudposse/terraform-aws-codefresh-backing-services"

# Short description of this project
description: |-
  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.

# How to use this project
usage: |-

  For a complete example, see [examples/complete](examples/complete).

  For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest)
  (which tests and deploys the example on AWS), see [test](test).

  ```hcl
    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
    }
  ```

include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors:
  - name: Josh Myers
    github: joshmyers
  - name: Erik Osterman
    github: osterman
  - name: Andriy Knysh
    github: aknysh
  - name: Vladimir Syromyatnikov
    github: SweetOps