Browse Source

doc: changes wrong documentation

tags/11.0.0
Guillaume Donval 2 months ago
parent
commit
5725c12993
Signed by: guillaume.donval <guillaume.donval@fxinnovation.com> GPG Key ID: 172AC3F9180CD64E
3 changed files with 3 additions and 3 deletions
  1. +1
    -1
      .pre-commit-config.yaml
  2. +1
    -1
      README.md
  3. +1
    -1
      variables.tf

+ 1
- 1
.pre-commit-config.yaml View File

@@ -1,6 +1,6 @@
repos:
- repo: git://github.com/antonbabenko/pre-commit-terraform
rev: v1.32.0
rev: v1.39.0
hooks:
- id: terraform_fmt
- id: terraform_docs


+ 1
- 1
README.md View File

@@ -136,7 +136,7 @@ Therefore until we find a more permanent solution for this we do NOT test this f
| num\_suffix\_digits | Number of significant digits to append to multiple same resources of the module. For example, a `var.num_suffix_digits` of `3` would produce `-001`, `-002`… suffixes. Ignored if `var.use_num_suffix` is `false`. | `number` | `2` | no |
| num\_suffix\_offset | The starting point of the numerical suffix. An offset of 1 would mean resources suffixes will starts at 2. Ignored if `var.use_num_suffix` is `false`. | `number` | `0` | no |
| placement\_group | ID of the Placement Group to start the instance (or launch template) in. | `string` | `null` | no |
| prefix | Prefix to be added to with all resource's names of the module except `iam_instance_profile_name` and `iam_instance_profile_iam_role_name`. Prefix is mainly used for tests and should remain empty in normal circumstances. | `string` | `""` | no |
| prefix | Prefix to be added to with all resource's names of the module. Prefix is mainly used for tests and should remain empty in normal circumstances. | `string` | `""` | no |
| primary\_network\_interface\_name | Name (tag:Name) of the primary network interface to be attached to the instance (or launch template). | `string` | `"nic"` | no |
| root\_block\_device\_delete\_on\_termination | Whether or not to delete the root block device on termination. **It's is strongly discouraged** to set this to `false`: only change this value if you have no other choice as this will leave a volume that will not be managed by terraform (even if the tag says it does) and you may end up building up costs.\*\* | `bool` | `true` | no |
| root\_block\_device\_encrypted | Customize details about the root block device of the instance (or launch template) root volume: enables EBS encryption on the volume. Cannot be used with snapshot\_id. Must be configured to perform drift detection. | `bool` | `true` | no |


+ 1
- 1
variables.tf View File

@@ -42,7 +42,7 @@ variable "num_suffix_offset" {
}

variable "prefix" {
description = "Prefix to be added to with all resource's names of the module except `iam_instance_profile_name` and `iam_instance_profile_iam_role_name`. Prefix is mainly used for tests and should remain empty in normal circumstances."
description = "Prefix to be added to with all resource's names of the module. Prefix is mainly used for tests and should remain empty in normal circumstances."
default = ""

validation {


Loading…
Cancel
Save