docs and examples

temporalio · Jan 9, 2025 · 6c5153b · 6c5153b
1 parent 414b8db
commit 6c5153b
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/docs/index.md b/docs/index.md
@@ -49,6 +49,9 @@ provider "temporalcloud" {
 
   # Also can be set by environment variable `TEMPORAL_CLOUD_ALLOW_INSECURE`
   allow_insecure = false
+
+  # Also can be set by environment variable `TEMPORAL_CLOUD_ALLOWED_ACCOUNT_ID`
+  allowed_account_id = "my-temporalcloud-account-id"
 }
 ```
 
@@ -58,5 +61,6 @@ provider "temporalcloud" {
 ### Optional
 
 - `allow_insecure` (Boolean) If set to True, it allows for an insecure connection to the Temporal Cloud API. This should never be set to 'true' in production and defaults to false.
+- `allowed_account_id` (String) The ID of the account to operate on. Prevents accidental mutation of accounts other than that provided.
 - `api_key` (String, Sensitive) The API key for Temporal Cloud. See [this documentation](https://docs.temporal.io/cloud/api-keys) for information on how to obtain an API key.
 - `endpoint` (String) The endpoint for the Temporal Cloud API. Defaults to `saas-api.tmprl.cloud:443`.
diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -15,4 +15,7 @@ provider "temporalcloud" {
 
   # Also can be set by environment variable `TEMPORAL_CLOUD_ALLOW_INSECURE`
   allow_insecure = false
+
+  # Also can be set by environment variable `TEMPORAL_CLOUD_ALLOWED_ACCOUNT_ID`
+  allowed_account_id = "my-temporalcloud-account-id"
 }
diff --git a/internal/provider/provider.go b/internal/provider/provider.go
@@ -73,7 +73,7 @@ in version control. We recommend passing credentials to this provider via enviro
 				Optional:    true,
 			},
 			"allowed_account_id": schema.StringAttribute{
-				Description: "The ID of the account to operate on. Prevents accidental mutation of accounts other than that listed",
+				Description: "The ID of the account to operate on. Prevents accidental mutation of accounts other than that provided.",
 				Optional:    true,
 			},
 		},