Temporal Cloud documentation

Temporal Cloud is a managed, hosted Temporal environment that provides a platform for Temporal Applications—an alternative to deploying and operating your own Temporal Cluster.

Temporal Cloud is offered in units of isolation known as Namespaces. You can provision and use one or more Cloud Namespaces. A typical use case is to use separate Namespaces as development, testing, integration, staging, and production environments for an application.

Sign up for Temporal Cloud

To request a Temporal Cloud account, complete the request form.

• Get started with Temporal Cloud
• Manage certificates in Temporal Cloud
• Manage Namespaces in Temporal Cloud
• tcld (Temporal Cloud command-line interface)
• Temporal Cloud release notes

Action

An Action is the fundamental pricing unit in Temporal CloudWhat is Temporal Cloud?

Temporal Cloud is a managed, hosted Temporal environment that provides a platform for Temporal Applications.

Learn more.

The following operations result in Actions, which are billed monthly.

Workflows

• Workflow started. Occurs via client start, client Signal-With-Start, Continue-As-NewWhat is Continue-As-New?
  
  Continue-As-New is the mechanism by which all relevant state is passed to a new Workflow Execution with a fresh Event History.
  
  Learn more, or Child WorkflowWhat is a Child Workflow Execution?
  
  A Child Workflow Execution is a Workflow Execution that is spawned from within another Workflow.
  
  Learn more start. If a Workflow start fails, an Action is not recorded.
• Workflow reset. Occurs when a WorkflowWhat is a Workflow?
  
  In day-to-day conversations, the term "Workflow" frequently denotes either a Workflow Type, a Workflow Definition, or a Workflow Execution.
  
  Learn more is reset. (Actions that occur before a ResetWhat is a Reset?
  
  A Reset terminates a Workflow Execution, removes the progress in the Event History up to the reset point, and then creates a new Workflow Execution with the same Workflow Type and Id to continue.
  
  Learn more are counted even if they are no longer visible in Event HistoryWhat is an Event History?
  
  An append log of Events that represents the full state a Workflow Execution.
  
  Learn more.)
• Timer started. Includes implicit Timers that are started by a Temporal SDK when timeouts are set, such as AwaitWithTimeout in Go or condition in TypeScript.
• Search Attribute upsert requested. Occurs after a Workflow starts and invokes UpsertSearchAttributes.
• Signal sent. Includes sending a SignalWhat is a Signal?
  
  A Signal is an asynchronous request to a Workflow Execution.
  
  Learn more from a client or from within a Workflow to another Workflow.
• Query received. QueriesWhat is a Query?
  
  A Query is a synchronous operation that is used to report the state of a Workflow Execution.
  
  Learn more aren't recorded in Event History. An operation such as viewing the stack trace in the Temporal Cloud UI results in a Query.
• Version marker recorded. Occurs when a Workflow calls get-version or patch.
• Side Effect recorded. For a mutable Side EffectWhat is a Side Effect?
  
  A Side Effect is a way to execute a short, non-deterministic code snippet, such as generating a UUID, that executes the provided function once and records its result into the Workflow Execution Event History.
  
  Learn more, an Action occurs only when the value changes. (Be aware that some SDKs don't support Side Effects.)

Activities

• Activity started or retried. Occurs each time an Activity is started or retried.
• Local Activity started. Occurs each time a Local ActivityWhat is a Local Activity?
  
  A Local Activity is an Activity Execution that executes in the same process as the Workflow Execution that spawns it.
  
  Learn more is started.
• Activity Heartbeat recorded. A Heartbeat call from Activity code counts as an Action only if it reaches the Temporal ServerWhat is the Temporal Server?
  
  The Temporal Server is a grouping of four horizontally scalable services.
  
  Learn more. Temporal SDKs throttle Activity HeartbeatsWhat is an Activity Heartbeat?
  
  An Activity Heartbeat is a ping from the Worker that is executing the Activity to the Temporal Cluster. Each ping informs the Temporal Cluster that the Activity Execution is making progress and the Worker has not crashed.
  
  Learn more. The default throttle is 80% of the Heartbeat TimeoutWhat is a Heartbeat Timeout?
  
  A Heartbeat Timeout is the maximum time between Activity Heartbeats.
  
  Learn more. Heartbeats don't apply to Local Activities.

Temporal Cloud Account Id

A Temporal Cloud Account Id is a unique identifier for a customer for the entire time they use Temporal Cloud. Temporal Technologies assigns each Account Id, which is an opaque code of five or six alphanumeric characters, such as f45a2.

Account-level Roles

When a Global Admin invites a user to join an account, the Global Admin selects one of the following Roles for that user:

• Global Admin
  • Has full administrative permissions across the account, including users and usage
  • Has Namespace Admin permissions on all Namespaces in the account
• Developer
  • Can create and update Namespaces; has full control over Workflows
  • Has Namespace Admin permissions for each Namespace created by that user
• Read-Only: Can only read information

Temporal Cloud Namespace Name

A Cloud Namespace Name is a customer-supplied name for a Namespace in Temporal Cloud. Each Namespace Name, such as accounting-production, is unique within the scope of a customer's account. It cannot be changed after the Namespace is provisioned.

Each Namespace Name must conform to the following rules:

• A Namespace Name must contain at least 2 characters and no more than 34 characters.
• A Namespace Name must begin with a letter, end with a letter or number, and contain only letters, numbers, and the hyphen (-) character.
• Each hyphen (-) character must be immediately preceded and followed by a letter or number; consecutive hyphens are not permitted.
• All letters in a Namespace Name must be lowercase.

Temporal Cloud Namespace Id

A Cloud Namespace Id is a globally unique identifier for a Namespace in Temporal Cloud. A Namespace Id is formed by concatenating the following:

1. A Namespace NameWhat is a Cloud Namespace Name?
   
   A Cloud Namespace Name is a customer-supplied name for a Namespace in Temporal Cloud.
   
   Learn more
2. A period (.)
3. The Account IdWhat is a Temporal Cloud Account Id?
   
   A Temporal Cloud Account Id is a unique identifier for a customer.
   
   Learn more to which the Namespace belongs

For example, for the Account Id f45a2 and Namespace Name accounting-production, the Namespace Id is accounting-production.f45a2.

Namespace-level permissions

A Global Admin can assign permissions for any Namespace in an account. A Developer can assign permissions for a Namespace they create.

For a Namespace, a user can have one of the following permissions:

• Namespace Admin: Can create and edit Namespaces; can create, rename, update, and delete Workflows
• Write: Can create, rename, update, and delete Workflows within the Namespace
• Read-Only: Can only read information from the Namespace