docs/cloudwatch_event_target: reference the rule name, not its id - #49887
Open
dchaudhari7177 wants to merge 1 commit into
Open
docs/cloudwatch_event_target: reference the rule name, not its id#49887dchaudhari7177 wants to merge 1 commit into
dchaudhari7177 wants to merge 1 commit into
Conversation
`rule` takes the rule's name. `aws_cloudwatch_event_rule`'s id is only the name on the default event bus; ruleCreateResourceID joins `<event_bus_name>/<rule_name>` for any other bus, so these four examples break as soon as they are adapted to a custom bus. The other examples in this page already use `.name`.
Contributor
Community GuidelinesThis comment is added to every new Pull Request to provide quick reference to how the Terraform AWS Provider is maintained. Please review the information below, and thank you for contributing to the community that keeps the provider thriving! 🚀 Voting for Prioritization
Pull Request Authors
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Four examples on the
aws_cloudwatch_event_targetpage setrulefromaws_cloudwatch_event_rule.<name>.id. The argument reference on the same page saysruleis "The name of the rule you want to add targets to", and the remaining examples on the page already use.name..idhappens to equal the name only on the default event bus. Frominternal/service/events/rule.go:So a reader who copies one of these examples and points it at a custom event bus gets
my-bus/my-rulewhere a bare rule name is required. This makes the four examples consistent with the page's own argument reference and with its other examples.Relations
Closes #49798
Changes
Only
website/docs/r/cloudwatch_event_target.html.markdown, four lines,.id→.name:No configuration or generated code is touched, so there is no
.changelogentry.Output from Acceptance Testing
Website-only change; no acceptance tests apply.