Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify that overriding policy document statements can be added to current document if sid does not match #17468

Conversation

aperiodic
Copy link
Contributor

In the description of iam_policy_document data source's
override_json argument, state specifically that any statements in the
override document that have sids that do not match a statement in
the current document will be added to the current document, instead of
ignored. Before this change, there was no description of how
non-matching statements in the override_json were used, so the
behavior was unclear: the opposite and incorrect conclusion that these
statements were ignored was equally consistent with the documentation.

This behavior is covered by an acceptance test, so from the coverage I'm
inferring that this behavior is both intended and supported.

Community Note

  • Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

I am omitting the output from acceptance testing, because this is a documentation-only change.

@aperiodic aperiodic requested a review from a team as a code owner February 4, 2021 20:13
@ghost ghost added size/XS Managed by automation to categorize the size of a PR. documentation Introduces or discusses updates to documentation. service/iam Issues and PRs that pertain to the iam service. labels Feb 4, 2021
@github-actions github-actions bot added the needs-triage Waiting for first response or review from a maintainer. label Feb 4, 2021
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Welcome @aperiodic 👋

It looks like this is your first Pull Request submission to the Terraform AWS Provider! If you haven’t already done so please make sure you have checked out our CONTRIBUTING guide and FAQ to make sure your contribution is adhering to best practice and has all the necessary elements in place for a successful approval.

Also take a look at our FAQ which details how we prioritize Pull Requests for inclusion.

Thanks again, and welcome to the community! 😃

…rrent document if `sid` does not match

In the description of `iam_policy_document` data source's
`override_json` argument, state specifically that any statements in the
override document that have `sid`s that do _not_ match a statement in
the current document will be added to the current document, instead of
ignored. Before this change, there was no description of how
non-matching statements in the `override_json` were used, so the
behavior was unclear: the opposite and incorrect conclusion that these
statements were ignored was equally consistent with the documentation.

This behavior is covered by an acceptance test, so from the coverage I'm
inferring that this behavior is both intended and supported.
@YakDriver YakDriver force-pushed the d/iam-policy-document-clarify-override-merge branch from fcde276 to de5c76c Compare February 10, 2021 22:10
@YakDriver YakDriver removed the needs-triage Waiting for first response or review from a maintainer. label Feb 10, 2021
@YakDriver YakDriver self-assigned this Feb 10, 2021
@YakDriver YakDriver force-pushed the d/iam-policy-document-clarify-override-merge branch from de5c76c to 755ac6f Compare February 10, 2021 22:13
@YakDriver
Copy link
Member

@aperiodic Thank you for noticing this hole in the documentation and taking the initiative to fill it! 🎉 This builds on a fairly extensive overhaul of the aws_iam_policy_document documentation in #12055.

@YakDriver YakDriver added this to the v3.28.0 milestone Feb 10, 2021
@YakDriver YakDriver merged commit 94a427b into hashicorp:main Feb 10, 2021
@YakDriver YakDriver added the partition/aws-us-gov Pertains to the aws-us-gov partition. label Feb 10, 2021
@ghost
Copy link

ghost commented Feb 12, 2021

This has been released in version 3.28.0 of the Terraform AWS provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template for triage. Thanks!

@ghost
Copy link

ghost commented Mar 13, 2021

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.

If you feel this issue should be reopened, we encourage creating a new issue linking back to this one for added context. Thanks!

@ghost ghost locked as resolved and limited conversation to collaborators Mar 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Introduces or discusses updates to documentation. partition/aws-us-gov Pertains to the aws-us-gov partition. service/iam Issues and PRs that pertain to the iam service. size/XS Managed by automation to categorize the size of a PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants