aws-cloudformation / aws-cloudformation/cloudformation-coverage-roadmap

AWS::AmazonMQ::Broker - Fix AmazonMQ documentation

Open
#1,975 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
No language data
Stars
1.1k
Forks
62
PR merge metrics
No merged PRs in 30d

Description

### Name of the resource

AWS::AmazonMQ::Broker

### Resource name

_No response_

### Reference Link

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-broker.html
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configuration.html
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amazonmq-configurationassociation.html

### Details

1. Configuration can now be applied to RabbitMQ brokers. Update documentation for the `Configuration` property of the broker to remove the "does not apply to rabbit" message and remove the equivalent information from the Configuration and Association (this is also mentioned in various properties).
`AWS::AmazonMQ::Configuration` can be created with `EngineType: RABBITMQ` so that should be added as an allowed value.

2. Fix the `AWS::AmazonMQ::Configuration` documentation to remove the incorrect `Id` return value listed. Attempting to use `!GetAtt Broker.Id` causes `Attribute 'Id' does not exist` error (also mentioned in #1658). Only `Ref` works as a way of getting ID value.

Contributor guide

Open the contributing guide

Research direction

Start with the three referenced AWS CloudFormation documentation pages for AWS::AmazonMQ::Broker, AWS::AmazonMQ::Configuration, and AWS::AmazonMQ::ConfigurationAssociation. Verify the Configuration and EngineType text, remove the incorrect Id return value, and confirm the documentation reflects RabbitMQ support and the stated Ref behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws
Domain
cloud, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.