Skip to content

Commit c35e272

Browse files
authored
docs: update terraform-docs for null provider and validation bypass variable (#306)
1 parent e02455f commit c35e272

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,15 @@ See [examples/simple_audit_framework/main.tf](examples/simple_audit_framework/ma
6262
|------|---------|
6363
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.3.0 |
6464
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 6.11.0 |
65+
| <a name="requirement_null"></a> [null](#requirement\_null) | >= 3.0 |
6566
| <a name="requirement_random"></a> [random](#requirement\_random) | >= 3.1 |
6667

6768
## Providers
6869

6970
| Name | Version |
7071
|------|---------|
7172
| <a name="provider_aws"></a> [aws](#provider\_aws) | 6.13.0 |
73+
| <a name="provider_null"></a> [null](#provider\_null) | 3.2.4 |
7274
| <a name="provider_random"></a> [random](#provider\_random) | 3.7.2 |
7375

7476
## Modules
@@ -104,6 +106,7 @@ No modules.
104106
| [aws_organizations_policy.backup_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/organizations_policy) | resource |
105107
| [aws_organizations_policy_attachment.backup_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/organizations_policy_attachment) | resource |
106108
| [aws_sns_topic_policy.backup_events](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/sns_topic_policy) | resource |
109+
| [null_resource.vault_name_validation](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |
107110
| [random_string.restore_testing_suffix](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/string) | resource |
108111
| [aws_iam_policy_document.ab_role_assume_role_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
109112
| [aws_iam_policy_document.ab_tag_policy_document](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |
@@ -163,6 +166,7 @@ No modules.
163166
| <a name="input_vault_force_destroy"></a> [vault\_force\_destroy](#input\_vault\_force\_destroy) | A boolean that indicates that all recovery points stored in the vault are deleted so that the vault can be destroyed without error | `bool` | `false` | no |
164167
| <a name="input_vault_kms_key_arn"></a> [vault\_kms\_key\_arn](#input\_vault\_kms\_key\_arn) | The server-side encryption key that is used to protect your backups | `string` | `null` | no |
165168
| <a name="input_vault_name"></a> [vault\_name](#input\_vault\_name) | Name of the backup vault to create. If not given, AWS use default | `string` | `null` | no |
169+
| <a name="input_vault_name_validation_bypass"></a> [vault\_name\_validation\_bypass](#input\_vault\_name\_validation\_bypass) | Bypass the vault name word validation (test, temp, delete, remove, default). Set to true for existing vaults with these words. Only disables word validation, format validation remains active. | `bool` | `false` | no |
166170
| <a name="input_vault_type"></a> [vault\_type](#input\_vault\_type) | Type of backup vault to create. Valid values are 'standard' (default) or 'logically\_air\_gapped' | `string` | `"standard"` | no |
167171
| <a name="input_windows_vss_backup"></a> [windows\_vss\_backup](#input\_windows\_vss\_backup) | Enable Windows VSS backup option and create a VSS Windows backup | `bool` | `false` | no |
168172

@@ -342,6 +346,21 @@ In case you get an error message similar to this one:
342346
error creating Backup Vault (): AccessDeniedException: status code: 403, request id: 8e7e577e-5b74-4d4d-95d0-bf63e0b2cc2e,
343347
```
344348

349+
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.
350+
<!-- END_TF_DOCS -->
351+
352+
## Known Issues
353+
354+
During the development of the module, the following issues were found:
355+
356+
### Error creating Backup Vault
357+
358+
In case you get an error message similar to this one:
359+
360+
```
361+
error creating Backup Vault (): AccessDeniedException: status code: 403, request id: 8e7e577e-5b74-4d4d-95d0-bf63e0b2cc2e,
362+
```
363+
345364
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.
346365

347366
## Testing

0 commit comments

Comments
 (0)