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.

Sign up for GitHub

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

Jump to bottom

Updating docs to make type and assume_role_policy use more clear. #198

Merged
merged 2 commits into from
May 16, 2024
Merged

Updating docs to make type and assume_role_policy use more clear. #198

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf39de9
Updating docs to call out the mutual exclusiveness of type and assume…
DevOpsDave May 10, 2024
4615102
Updated per comments. Modified using 'Exactly one of or must be sp…
DevOpsDave May 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/resources/alks_iamrole.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ The following arguments are supported:

* `name` - (Optional/Computed) The name of the ALKS IAM role which will be reflected in AWS and the ALKS UI.
* `name_prefix` - (Optional/Computed) A prefix for a generated name of the ALKS IAM role which will be reflected in AWS and the ALKS UI.
* `type` - (Required) The role type to use. 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).
* `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`.
Copy link
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

* `include_default_policies` - (Required) Whether or not the default manages policies should be attached to the role.
* `role_added_to_ip` - (Computed) Indicates whether or not an instance profile role was created.
* `arn` - (Computed) Provides the ARN of the role that was created.
Expand Down
Loading