Updating docs to make type and assume_role_policy use more clear. #198
Conversation
DevOpsDave
changed the title
docs/resources/alks_iamrole.md
Outdated
| * `type` - (Required) The role type to use. This argument is mutually exclusive with `assume_role_policy`. To see a list of available roles, [call this endpoint](https://pages.ghe.coxautoinc.com/ETS-CloudAutomation/ALKS-Documentation/#/aws-role-type-rest-service/getAllAwsRoleTypesUsingGET). | ||
| * `assume_role_policy` - (Required) A JSON string representing the trust policy for the role. This is only supported for single-service trust policies trusting an approved AWS service. This argument is mutually exclusive with `type`. |
There was a problem hiding this comment.
Referencing documentation examples from the AWS provider, XORd attributes are Optional with a note: "Exactly one of this, this, or this must be specified". I think wording it this way is clearer.
Also, This page can use some serious upgrades and edits. For instance, the introduction summary is grammatically incorrect. Also The details regarding custom trust policy usage starting on line 32 have changed. The guidelines should be a translation of this function in Fides.
And Lastly, the URL provided in the type attr description is incorrect. It should be the following: https://pages.ghe.coxautoinc.com/ETS-CloudAutomation/ALKS-Documentation/#operation/getAllAwsRoleTypes
All or some of these concerns can be address in this PR. Anything that seems like it falls out of scope can be punted to a new story.
There was a problem hiding this comment.
Thanks for the catch. I updated the text to use the "Exactly one of this, this, or this must be specified" pattern. Also updated the URL to the correct link.
For your other concerns, I will make a separate defect.
…fied' pattern to describe the mutual exclusiveness of 2 required params. Also updated the list roles endpoint url.
Change Log Items
Description
When using alks_iamrole users should either specify type or assume_role_policy. Not both but must use one.
Rally:
DE431382: ALKS TF provider: Role Type is mandatory