docs(README) Update AWS README for module refactor #35
Conversation
This file contains 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
scottford-lw
force-pushed
the
scottford/update-aws-readme
branch
from
75b0678 to
1a92386
Compare
afiune
suggested changes
Jun 22, 2020
aws/README.md
Outdated
| | sns_topic_name | SNS topic name. Can be used when generating a new resource or when using an existing resource. | `string` | "" | no | | ||
| | sqs_queue_name | SQS queue name. Can be used when generating a new resource or when using an existing resource. | `string` | "" | no | | ||
| | use_existing_cloudtrail | Set this to true to use an existing cloudtrail | `bool` | `false` | no | | ||
| | use_existing_iam_role | Set this to true to use an existing IAM role | `bool` | `false` | no | |
There was a problem hiding this comment.
I would make sure to explain here that, if a user sets this to true, they must provide the iam_role_name and iam_role_external_id.
aws/README.md
Outdated
| | prefix | The prefix that will be use at the beginning of every generated resource | `string` | lacework-ct | no | | ||
| | sns_topic_name | SNS topic name. Can be used when generating a new resource or when using an existing resource. | `string` | "" | no | | ||
| | sqs_queue_name | SQS queue name. Can be used when generating a new resource or when using an existing resource. | `string` | "" | no | | ||
| | use_existing_cloudtrail | Set this to true to use an existing cloudtrail | `bool` | `false` | no | |
There was a problem hiding this comment.
I would make sure to explain here that, if a user sets this to true, they must provide the bucket_name and sns_topic_name.
scottford-lw
force-pushed
the
scottford/update-aws-readme
branch
from
d62b998 to
2ee46de
Compare
afiune
approved these changes
Jun 23, 2020
aws/README.md
Outdated
| | iam_role_external_id | External ID for IAM Role | `string` | "" | no | | ||
| | iam_role_name | The IAM role name | `string` | "lacework_iam_role" | no | | ||
| | lacework_account_id | The Lacework AWS account that the IAM role will grant access | `string` | 434813966438 | no | | ||
| | lacework_integration_name | The name of the integration in Lacework | `string` | TF config | no | |
There was a problem hiding this comment.
One last thing; This variable is available for both modules, it is the name of the integration for config and cloudtrail, they both have defaults.
Signed-off-by: Scott Ford <[email protected]>
scottford-lw
force-pushed
the
scottford/update-aws-readme
branch
from
8b201d3 to
622b809
Compare
Merged
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.
Re-write of the AWS README to document usage of the new TF modules.
Signed-off-by: Scott Ford [email protected]