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

[Docs]: Opensearch_domain_policy example has wrong syntax #33716

Closed
obounaim opened this issue Oct 2, 2023 · 3 comments · Fixed by #33724
Closed

[Docs]: Opensearch_domain_policy example has wrong syntax #33716

obounaim opened this issue Oct 2, 2023 · 3 comments · Fixed by #33724
Labels
documentation Introduces or discusses updates to documentation. service/iam Issues and PRs that pertain to the iam service.
Milestone

Comments

@obounaim
Copy link
Contributor

obounaim commented Oct 2, 2023

Documentation Link

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/opensearch_domain_policy

Description

In the opensearch_domain_policy provided example :

The syntax of the aws_iam_policy_document data source is wrong, the arguments should be encapsulated in a statement argument.

Also, the values field in the condition argument should be of type list instead of string.

The example should look like this :

data "aws_iam_policy_document" "main" {
  statement {
    effect = "Allow"

    principals {
      type        = "*"
      identifiers = ["*"]
    }

    actions   = ["es:*"]
    resources = ["${aws_opensearch_domain.example.arn}/*"]

    condition {
      test     = "IpAddress"
      variable = "aws:SourceIp"
      values   = ["127.0.0.1/32"]
    }
  }
}

References

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document

Would you like to implement a fix?

None

@obounaim obounaim added the documentation Introduces or discusses updates to documentation. label Oct 2, 2023
@github-actions
Copy link

github-actions bot commented Oct 2, 2023

Community Note

Voting for Prioritization

  • Please vote on this issue by adding a 👍 reaction to the original post to help the community and maintainers prioritize this request.
  • Please see our prioritization guide for information on how we prioritize.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request.

Volunteering to Work on This Issue

  • If you are interested in working on this issue, please leave a comment.
  • If this would be your first contribution, please review the contribution guide.

@github-actions github-actions bot added the service/iam Issues and PRs that pertain to the iam service. label Oct 2, 2023
@terraform-aws-provider terraform-aws-provider bot added the needs-triage Waiting for first response or review from a maintainer. label Oct 2, 2023
@justinretzolk justinretzolk removed the needs-triage Waiting for first response or review from a maintainer. label Oct 26, 2023
@github-actions github-actions bot added this to the v5.23.0 milestone Oct 26, 2023
@github-actions
Copy link

This functionality has been released in v5.23.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. Thank you!

Copy link

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 have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 26, 2023
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. service/iam Issues and PRs that pertain to the iam service.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants