10000 chore: adding note about immutable resources · coder/coder@a893b79 · GitHub
[go: up one dir, main page]
Skip to content

Commit a893b79

Browse files
dannykoppingdannykopping
committed
chore: adding note about immutable resources
Signed-off-by: Danny Kopping <dannykopping@gmail.com>
1 parent 7577a90 commit a893b79

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

‎docs/admin/templates/extending-templates/prebuilt-workspaces.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,12 @@ resource "docker_container" "workspace" {
163163

164164
Learn more about `ignore_changes` in the [Terraform documentation](https://developer.hashicorp.com/terraform/language/meta-arguments/lifecycle#ignore_changes).
165165

166+
_A note on "immutable" attributes: Terraform providers may specify `ForceNew` on their resources' attributes. Any change
167+
to these attributes require the replacement (destruction and recreation) of the managed resource instance, rather than an in-place update.
168+
For example, the [`ami`](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/instance#ami-1) attribute on the `aws_instance` resource
169+
has [`ForceNew`](https://github.com/hashicorp/terraform-provider-aws/blob/main/internal/service/ec2/ec2_instance.go#L75-L81) set,
170+
since the AMI cannot be changed in-place._
171+
166172
### Current limitations
167173

168174
The prebuilt workspaces feature has these current limitations:

0 commit comments

Comments
 (0)
0