Skip to content

Commit df1b738

Browse files
authored
Add connectivity rule example to resource definition (#344)
* consistent folder naming * add example usage to CR docs
1 parent 042fa65 commit df1b738

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed

docs/resources/connectivity_rule.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,52 @@ description: |-
1010

1111
Provisions a Temporal Cloud Connectivity Rule.
1212

13+
## Example Usage
1314

15+
```terraform
16+
terraform {
17+
required_providers {
18+
temporalcloud = {
19+
source = "temporalio/temporalcloud"
20+
}
21+
}
22+
}
23+
24+
provider "temporalcloud" {
25+
26+
}
27+
28+
// Create Public Connectivity Rule
29+
resource "temporalcloud_connectivity_rule" "public_rule" {
30+
connectivity_type = "public"
31+
}
32+
33+
// Create Private Connectivity Rule for AWS
34+
resource "temporalcloud_connectivity_rule" "private_aws" {
35+
connectivity_type = "private"
36+
connection_id = "vpce-12345678"
37+
region = "aws-us-west-2"
38+
}
39+
40+
// Create Private Connectivity Rule for GCP
41+
resource "temporalcloud_connectivity_rule" "private_gcp" {
42+
connectivity_type = "private"
43+
connection_id = "vpce-12345678"
44+
region = "gcp-us-central1"
45+
gcp_project_id = "my-gcp-project-id"
46+
}
47+
48+
// Attaching connectivity rules to a namespace
49+
resource "temporalcloud_namespace" "ns-with-cr" {
50+
name = "ns-with-cr"
51+
regions = ["aws-us-west-2"]
52+
api_key_auth = true
53+
retention_days = 14
54+
connectivity_rule_ids = [
55+
public_rule.id, private_aws.id
56+
]
57+
}
58+
```
1459

1560
<!-- schema generated by tfplugindocs -->
1661
## Schema

examples/resources/temporalcloud_connectivityrule/resource.tf renamed to examples/resources/temporalcloud_connectivity_rule/resource.tf

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,13 @@ resource "temporalcloud_connectivity_rule" "private_gcp" {
3030
gcp_project_id = "my-gcp-project-id"
3131
}
3232

33+
// Attaching connectivity rules to a namespace
34+
resource "temporalcloud_namespace" "ns-with-cr" {
35+
name = "ns-with-cr"
36+
regions = ["aws-us-west-2"]
37+
api_key_auth = true
38+
retention_days = 14
39+
connectivity_rule_ids = [
40+
public_rule.id, private_aws.id
41+
]
42+
}

0 commit comments

Comments
 (0)