|
| 1 | +--- |
| 2 | +# generated by https://github.com/hashicorp/terraform-plugin-docs |
| 3 | +page_title: "temporalcloud_namespace_tags Resource - terraform-provider-temporalcloud" |
| 4 | +subcategory: "" |
| 5 | +description: |- |
| 6 | + Manages the complete set of tags for a Temporal Cloud namespace. |
| 7 | +--- |
| 8 | + |
| 9 | +# temporalcloud_namespace_tags (Resource) |
| 10 | + |
| 11 | +Manages the complete set of tags for a Temporal Cloud namespace. |
| 12 | + |
| 13 | +## Example Usage |
| 14 | + |
| 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 a namespace first |
| 29 | +resource "temporalcloud_namespace" "example" { |
| 30 | + name = "example-namespace" |
| 31 | + regions = ["aws-us-west-2"] |
| 32 | + api_key_auth = true |
| 33 | + retention_days = 14 |
| 34 | +} |
| 35 | +
|
| 36 | +// Basic namespace tags example, with a custom timeout |
| 37 | +resource "temporalcloud_namespace_tags" "example" { |
| 38 | + namespace_id = temporalcloud_namespace.example.id |
| 39 | + tags = { |
| 40 | + "environment" = "production" |
| 41 | + "team" = "backend" |
| 42 | + "project" = "temporal-workflows" |
| 43 | + } |
| 44 | + timeouts { |
| 45 | + create = "10m" |
| 46 | + delete = "5m" |
| 47 | + } |
| 48 | +} |
| 49 | +``` |
| 50 | + |
| 51 | +<!-- schema generated by tfplugindocs --> |
| 52 | +## Schema |
| 53 | + |
| 54 | +### Required |
| 55 | + |
| 56 | +- `namespace_id` (String) The ID of the namespace to manage tags for. |
| 57 | +- `tags` (Map of String) A map of tag keys to tag values. |
| 58 | + |
| 59 | +### Optional |
| 60 | + |
| 61 | +- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts)) |
| 62 | + |
| 63 | +### Read-Only |
| 64 | + |
| 65 | +- `id` (String) The ID of this namespace tags resource. |
| 66 | + |
| 67 | +<a id="nestedblock--timeouts"></a> |
| 68 | +### Nested Schema for `timeouts` |
| 69 | + |
| 70 | +Optional: |
| 71 | + |
| 72 | +- `create` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). |
| 73 | +- `delete` (String) A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs. |
| 74 | + |
| 75 | +## Import |
| 76 | + |
| 77 | +Import is supported using the following syntax: |
| 78 | + |
| 79 | +```shell |
| 80 | +# Namespace Tags can be imported to incorporate existing Namespace Tags into your Terraform pipeline. |
| 81 | +# To import Namespace Tags, you need: |
| 82 | +# - a resource configuration in your Terraform configuration file/module to accept the imported Namespace Tags. In the example below, the placeholder is "temporalcloud_namespace_tags" "tags_import" |
| 83 | +# - the Namespace ID, which includes the Namespace Name and Account ID available at the top of the Namespace's page in the Temporal Cloud UI. In the example below, this is namespaceid.acctid |
| 84 | +# The import ID format is: namespaceid.acctid/tags |
| 85 | + |
| 86 | +terraform import temporalcloud_namespace_tags.tags_import namespaceid.acctid/tags |
| 87 | +``` |
0 commit comments