You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Allows you to have a access to result during plan phase that states whether valueor any nested attribute is marked as (known after apply) or not.
6
+
Allows you to have a access to result during plan phase that states whether value or any nested attribute is marked as "(known after apply)" or not.
7
+
Provider Metadata
8
+
Each module can use provider_meta. Beware that these settings only count for resources of this module. (see https://www.terraform.io/internals/provider-meta):
9
+
terraform
10
+
// Terraform provider_meta example
11
+
terraform {
12
+
// "value" is the provider name
13
+
provider_meta "value" {
14
+
// {workdir} -> The only available placeholder currently (see below for more information)
15
+
seed_prefix = "{workdir}#for-example" // Results into "/path/to/workdir#for-example"
16
+
}
17
+
}
18
+
19
+
Optional
20
+
seed_prefix (String) It gets appended to each seed of any value_is_fully_known (resource) or value_is_known (resource) within the same module.
21
+
Placeholders:
22
+
"{workdir}" (Keyword) The actual workdir; equals to terraform's path.root. This placeholder is
23
+
recommended because this value won't be drag along the plan and apply phase in comparison to
24
+
abspath(path.root) that you would add to resource seed where a change to path.root would be
25
+
recognized just as usual from terraform.
7
26
---
8
27
9
28
# value_is_fully_known (Resource)
10
29
11
-
Allows you to have a access to `result` during plan phase that states whether `value`or any nested attribute is marked as `(known after apply)` or not.
30
+
Allows you to have a access to `result` during plan phase that states whether `value` or any nested attribute is marked as "(known after apply)" or not.
31
+
## Provider Metadata
32
+
Each module can use provider_meta. Beware that these settings only count for resources of this module. (see https://www.terraform.io/internals/provider-meta):
33
+
```terraform
34
+
// Terraform provider_meta example
35
+
terraform {
36
+
// "value" is the provider name
37
+
provider_meta "value" {
38
+
// {workdir} -> The only available placeholder currently (see below for more information)
39
+
seed_prefix = "{workdir}#for-example" // Results into "/path/to/workdir#for-example"
40
+
}
41
+
}
42
+
```
43
+
### Optional
44
+
-`seed_prefix` (String) It gets appended to each seed of any `value_is_fully_known` (resource) or `value_is_known` (resource) within the same module.
45
+
46
+
**Placeholders**:
47
+
- "{workdir}" (Keyword) The actual workdir; equals to terraform's path.root. This placeholder is
48
+
recommended because this value won't be drag along the plan and apply phase in comparison to
49
+
abspath(path.root) that you would add to resource seed where a change to path.root would be
50
+
recognized just as usual from terraform.
12
51
13
52
14
53
@@ -17,10 +56,12 @@ Allows you to have a access to `result` during plan phase that states whether `v
17
56
18
57
### Required
19
58
20
-
-`value` (Dynamic) The `value` and nested attributes to test against `(known after apply)`
59
+
-`proposed_unknown` (Dynamic) It is very crucial that this field is **not** filled by any custom value except the one produced by `value_unknown_proposer` (resource). This has the reason as its `value` is **always** unknown during the plan phase. On this behaviour this resource must rely and it cannot check if you do not so!
60
+
-`unique_seed` (String) Attention! The seed is being used to determine resource uniqueness prior and during apply-phase. Very important to state is that the **seed must be fully known during the plan phase**, otherwise, an error is thrown. Within one terraform plan & apply the **seed of every "value_is_fully_known" must be unique**! I recommend you to use the provider_meta-feature for increased uniqueness. Under certain circumstances you may face problems if you run terraform concurrenctly. If you do so, then I recommend you to pass-through a random value via a user (environment) variable that you then add to the seed.
61
+
-`value` (Dynamic) The `value` and if existing, nested attributes, are tested against "(known after apply)"
21
62
22
-
### Read-Only
63
+
### Optional
23
64
24
-
-`result` (Boolean) States whether `value` or any nested attribute is marked as `(known after apply)` or not. If `value` is an aggregate type, not only the top level of the aggregate type is checked; elements and attributes are checked too.
65
+
-`result` (Boolean) States whether `value` or any nested attribute is marked as "(known after apply)" or not. If `value` is an aggregate type, not only the top level of the aggregate type is checked; elements and attributes are checked too.
Allows you to have a access to result during plan phase that states whether value is marked as (known after apply) or not.
6
+
Allows you to have a access to result during plan phase that states whether value marked as "(known after apply)" or not.
7
+
Provider Metadata
8
+
Each module can use provider_meta. Beware that these settings only count for resources of this module. (see https://www.terraform.io/internals/provider-meta):
9
+
terraform
10
+
// Terraform provider_meta example
11
+
terraform {
12
+
// "value" is the provider name
13
+
provider_meta "value" {
14
+
// {workdir} -> The only available placeholder currently (see below for more information)
15
+
seed_prefix = "{workdir}#for-example" // Results into "/path/to/workdir#for-example"
16
+
}
17
+
}
18
+
19
+
Optional
20
+
seed_prefix (String) It gets appended to each seed of any value_is_fully_known (resource) or value_is_known (resource) within the same module.
21
+
Placeholders:
22
+
"{workdir}" (Keyword) The actual workdir; equals to terraform's path.root. This placeholder is
23
+
recommended because this value won't be drag along the plan and apply phase in comparison to
24
+
abspath(path.root) that you would add to resource seed where a change to path.root would be
25
+
recognized just as usual from terraform.
7
26
---
8
27
9
28
# value_is_known (Resource)
10
29
11
-
Allows you to have a access to `result` during plan phase that states whether `value` is marked as `(known after apply)` or not.
30
+
Allows you to have a access to `result` during plan phase that states whether `value` marked as "(known after apply)" or not.
31
+
## Provider Metadata
32
+
Each module can use provider_meta. Beware that these settings only count for resources of this module. (see https://www.terraform.io/internals/provider-meta):
33
+
```terraform
34
+
// Terraform provider_meta example
35
+
terraform {
36
+
// "value" is the provider name
37
+
provider_meta "value" {
38
+
// {workdir} -> The only available placeholder currently (see below for more information)
39
+
seed_prefix = "{workdir}#for-example" // Results into "/path/to/workdir#for-example"
40
+
}
41
+
}
42
+
```
43
+
### Optional
44
+
-`seed_prefix` (String) It gets appended to each seed of any `value_is_fully_known` (resource) or `value_is_known` (resource) within the same module.
45
+
46
+
**Placeholders**:
47
+
- "{workdir}" (Keyword) The actual workdir; equals to terraform's path.root. This placeholder is
48
+
recommended because this value won't be drag along the plan and apply phase in comparison to
49
+
abspath(path.root) that you would add to resource seed where a change to path.root would be
50
+
recognized just as usual from terraform.
12
51
13
52
14
53
@@ -17,10 +56,12 @@ Allows you to have a access to `result` during plan phase that states whether `v
17
56
18
57
### Required
19
58
20
-
-`value` (Dynamic) The `value` to test against `(known after apply)`
59
+
-`proposed_unknown` (Dynamic) It is very crucial that this field is **not** filled by any custom value except the one produced by `value_unknown_proposer` (resource). This has the reason as its `value` is **always** unknown during the plan phase. On this behaviour this resource must rely and it cannot check if you do not so!
60
+
-`unique_seed` (String) Attention! The seed is being used to determine resource uniqueness prior and during apply-phase. Very important to state is that the **seed must be fully known during the plan phase**, otherwise, an error is thrown. Within one terraform plan & apply the **seed of every "value_is_known" must be unique**! I recommend you to use the provider_meta-feature for increased uniqueness. Under certain circumstances you may face problems if you run terraform concurrenctly. If you do so, then I recommend you to pass-through a random value via a user (environment) variable that you then add to the seed.
61
+
-`value` (Dynamic) The `value` (not nested attributes) is test against "(known after apply)"
21
62
22
-
### Read-Only
63
+
### Optional
23
64
24
-
-`result` (Boolean) States whether `value` is marked as `(known after apply)` or not. If `value` is an aggregate type, only the top level of the aggregate type is checked; elements and attributes are not checked.
65
+
-`result` (Boolean) States whether `value` is marked as "(known after apply)" or not. If `value` is an aggregate type, only the top level of the aggregate type is checked; elements and attributes are not checked.
Copy file name to clipboardExpand all lines: docs/resources/promise.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,10 +17,10 @@ Allows you to treat a value as unknown. This is desirable when you want postcond
17
17
18
18
### Required
19
19
20
-
-`value` (Dynamic) The value to promise. Any (nested) change to `value` results into `result` to be marked as `(known after apply)`
20
+
-`value` (Dynamic) The value to promise. Any (nested) change to `value` results into `result` to be marked as "(known after apply)"
21
21
22
22
### Read-Only
23
23
24
-
-`result` (Dynamic) `result` is as soon as you apply set to `value`. Every change of `value` results into `result` to be marked as `(known after apply)`
24
+
-`result` (Dynamic) `result` is as soon as you apply set to `value`. Every change of `value` results into `result` to be marked as "(known after apply)"
This resource is very obscure and misbehaving and you really should only use it for value_is_known.proposed_unknown or value_is_fully_known.proposed_unknown.
7
+
---
8
+
9
+
# value_unknown_proposer (Resource)
10
+
11
+
This resource is very obscure and misbehaving and you really should only use it for `value_is_known.proposed_unknown` or `value_is_fully_known.proposed_unknown`.
12
+
13
+
14
+
15
+
<!-- schema generated by tfplugindocs -->
16
+
## Schema
17
+
18
+
### Read-Only
19
+
20
+
-`value` (Boolean) This value will **always** be unknown during the plan phase but always true after apply phase.
0 commit comments