Skip to content

Commit 4944ac4

Browse files
authored
docs: link to region list (#266) (#334)
* docs: link to region list
1 parent 3d62a69 commit 4944ac4

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

docs/resources/namespace.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,17 @@ page_title: "temporalcloud_namespace Resource - terraform-provider-temporalcloud
44
subcategory: ""
55
description: |-
66
Provisions a Temporal Cloud namespace.
7+
Regions available in Temporal Cloud: https://docs.temporal.io/cloud/regions.
8+
Note that regions are prefixed with the cloud provider (aws-us-east-1, not us-east-1)
79
---
810

911
# temporalcloud_namespace (Resource)
1012

11-
Provisions a Temporal Cloud namespace.
13+
Provisions a Temporal Cloud namespace.
14+
15+
Regions available in Temporal Cloud: https://docs.temporal.io/cloud/regions.
16+
17+
Note that regions are prefixed with the cloud provider (aws-us-east-1, not us-east-1)
1218

1319
## Example Usage
1420

@@ -132,7 +138,7 @@ resource "temporalcloud_namespace" "terraform3" {
132138
### Required
133139

134140
- `name` (String) The name of the namespace.
135-
- `regions` (List of String) The list of regions that this namespace is available in. If more than one region is specified, this namespace is a "Multi-region Namespace". Please note that changing, adding, or removing regions is not supported and the provider will attempt to recreate the namespace. For Multi-region Namespaces the provider will ignore order changes on regions which can happen if the namespace fails over.
141+
- `regions` (List of String) The list of regions that this namespace is available in. If more than one region is specified, this namespace is a "Multi-region Namespace". Please note that changing, adding, or removing regions is not supported and the provider will attempt to recreate the namespace. For Multi-region Namespaces the provider will ignore order changes on regions which can happen if the namespace fails over. See https://docs.temporal.io/cloud/regions for a list of available regions. Note that regions are prefixed with the cloud provider (aws-us-east-1, not us-east-1)
136142
- `retention_days` (Number) The number of days to retain workflow history. Any changes to the retention period will be applied to all new running workflows.
137143

138144
### Optional

internal/provider/namespace_resource.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ func (r *namespaceResource) Metadata(_ context.Context, req resource.MetadataReq
157157
// Schema defines the schema for the resource.
158158
func (r *namespaceResource) Schema(ctx context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
159159
resp.Schema = schema.Schema{
160-
Description: "Provisions a Temporal Cloud namespace.",
160+
Description: "Provisions a Temporal Cloud namespace. \n\nRegions available in Temporal Cloud: https://docs.temporal.io/cloud/regions. \n\nNote that regions are prefixed with the cloud provider (aws-us-east-1, not us-east-1)",
161161
Attributes: map[string]schema.Attribute{
162162
"name": schema.StringAttribute{
163163
Description: "The name of the namespace.",
@@ -174,7 +174,7 @@ func (r *namespaceResource) Schema(ctx context.Context, _ resource.SchemaRequest
174174
},
175175
},
176176
"regions": schema.ListAttribute{
177-
Description: "The list of regions that this namespace is available in. If more than one region is specified, this namespace is a \"Multi-region Namespace\". Please note that changing, adding, or removing regions is not supported and the provider will attempt to recreate the namespace. For Multi-region Namespaces the provider will ignore order changes on regions which can happen if the namespace fails over.",
177+
Description: "The list of regions that this namespace is available in. If more than one region is specified, this namespace is a \"Multi-region Namespace\". Please note that changing, adding, or removing regions is not supported and the provider will attempt to recreate the namespace. For Multi-region Namespaces the provider will ignore order changes on regions which can happen if the namespace fails over. See https://docs.temporal.io/cloud/regions for a list of available regions. Note that regions are prefixed with the cloud provider (aws-us-east-1, not us-east-1)",
178178
ElementType: types.StringType,
179179
Required: true,
180180
CustomType: internaltypes.UnorderedStringListType{

0 commit comments

Comments
 (0)