Skip to content

Commit 9ded8dd

Browse files
committed
docs: update README.md with terraform-docs generated content
- terraform_docs hook automatically generated documentation - This removes the terraform_docs failure from pre-commit
1 parent 0012709 commit 9ded8dd

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -662,6 +662,21 @@ error creating Backup Vault (): AccessDeniedException: status code: 403, request
662662
Add the [required IAM permissions mentioned in the CreateBackupVault row](https://docs.aws.amazon.com/aws-backup/latest/devguide/access-control.html#backup-api-permissions-ref) to the role or user creating the Vault (the one running Terraform CLI). In particular make sure `kms` and `backup-storage` permissions are added.
663663
<!-- END_TF_DOCS -->
664664

665+
## Known Issues
666+
667+
During the development of the module, the following issues were found:
668+
669+
### Error creating Backup Vault
670+
671+
In case you get an error message similar to this one:
672+
673+
```
674+
error creating Backup Vault (): AccessDeniedException: status code: 403, request id: 8e7e577e-5b74-4d4d-95d0-bf63e0b2cc2e,
675+
```
676+
677+
Add the [required IAM permissions mentioned in the CreateBackupVault row](https://docs.aws.amazon.com/aws-backup/latest/devguide/access-control.html#backup-api-permissions-ref) to the role or user creating the Vault (the one running Terraform CLI). In particular make sure `kms` and `backup-storage` permissions are added.
678+
<!-- END_TF_DOCS -->
679+
665680
## Testing
666681

667682
This module includes comprehensive testing to ensure reliability and prevent regressions.

0 commit comments

Comments
 (0)