index.md

page_title	subcategory	description
temporalcloud Provider		Use the temporalcloud provider to interact with resources supported by Temporal Cloud https://temporal.io/cloud. Use the navigation to the left to learn about the available resources supported by this provider. ~> This provider is in Public Preview, is under active development, and is subject to change. We reserve the right to make breaking changes during this pre-GA period, though we will do our best to maintain compatibility wherever possible. Provider Configuration Credentials for Temporal Cloud can be provided by adding an api_key property or by setting the environment variable TEMPORAL_CLOUD_API_KEY. You can generate an API key for Temporal Cloud by following these instructions https://docs.temporal.io/cloud/api-keys. !> Hard-coded credentials are not recommended in any Terraform configuration and should not be committed in version control. We recommend passing credentials to this provider via environment variables.

temporalcloud Provider

Use the temporalcloud provider to interact with resources supported by Temporal Cloud.

Use the navigation to the left to learn about the available resources supported by this provider.

~> This provider is in Public Preview, is under active development, and is subject to change. We reserve the right to make breaking changes during this pre-GA period, though we will do our best to maintain compatibility wherever possible.

Provider Configuration

Credentials for Temporal Cloud can be provided by adding an api_key property or by setting the environment variable TEMPORAL_CLOUD_API_KEY. You can generate an API key for Temporal Cloud by following these instructions.

!> Hard-coded credentials are not recommended in any Terraform configuration and should not be committed in version control. We recommend passing credentials to this provider via environment variables.

Example Usage

terraform {
  required_providers {
    temporalcloud = {
      source = "temporalio/temporalcloud"
    }
  }
}

provider "temporalcloud" {
  # Also can be set by environment variable `TEMPORAL_CLOUD_API_KEY`
  api_key = "my-temporalcloud-api-key"

  # Also can be set by environment variable `TEMPORAL_CLOUD_ENDPOINT`
  endpoint = "saas-api.tmprl.cloud:443"

  # Also can be set by environment variable `TEMPORAL_CLOUD_ALLOW_INSECURE`
  allow_insecure = false
}

Schema

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.
• api_key (String, Sensitive) The API key for Temporal Cloud. See this documentation 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.