Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Temporalcloud Provider
  3. API Docs
  4. NexusEndpoint
temporalcloud 0.6.1 published on Friday, Mar 7, 2025 by temporalio
temporalio/terraform-provider-temporalcloud

temporalcloud.NexusEndpoint

Explore with Pulumi AI

temporalcloud logo
temporalcloud 0.6.1 published on Friday, Mar 7, 2025 by temporalio
temporalio/terraform-provider-temporalcloud

    Provisions a Temporal Cloud Nexus endpoint.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.temporalcloud.Namespace;
import com.pulumi.temporalcloud.NamespaceArgs;
import com.pulumi.temporalcloud.NexusEndpoint;
import com.pulumi.temporalcloud.NexusEndpointArgs;
import com.pulumi.temporalcloud.inputs.NexusEndpointWorkerTargetArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var targetNamespace = new Namespace("targetNamespace", NamespaceArgs.builder()
            .regions("aws-us-west-2")
            .apiKeyAuth(true)
            .retentionDays(14)
            .timeouts(NamespaceTimeoutsArgs.builder()
                .create("10m")
                .delete("10m")
                .build())
            .build());

        var callerNamespace = new Namespace("callerNamespace", NamespaceArgs.builder()
            .regions("aws-us-east-1")
            .apiKeyAuth(true)
            .retentionDays(14)
            .timeouts(NamespaceTimeoutsArgs.builder()
                .create("10m")
                .delete("10m")
                .build())
            .build());

        var callerNamespace2 = new Namespace("callerNamespace2", NamespaceArgs.builder()
            .regions("gcp-us-central1")
            .apiKeyAuth(true)
            .retentionDays(14)
            .timeouts(NamespaceTimeoutsArgs.builder()
                .create("10m")
                .delete("10m")
                .build())
            .build());

        var nexusEndpoint = new NexusEndpoint("nexusEndpoint", NexusEndpointArgs.builder()
            .description("""
Service Name:
  my-hello-service
Operation Names:
  echo
  say-hello

Input / Output arguments are in the following repository:
https://github.com/temporalio/samples-go/blob/main/nexus/service/api.go
            """)
            .workerTarget(NexusEndpointWorkerTargetArgs.builder()
                .namespace_id(targetNamespace.id())
                .task_queue("terraform-task-queue")
                .build())
            .allowedCallerNamespaces(            
                callerNamespace.id(),
                callerNamespace2.id())
            .build());

    }
}

    resources:
  targetNamespace:
    type: temporalcloud:Namespace
    properties:
      regions:
        - aws-us-west-2
      apiKeyAuth: true
      retentionDays: 14
      timeouts:
        - create: 10m
          delete: 10m
  callerNamespace:
    type: temporalcloud:Namespace
    properties:
      regions:
        - aws-us-east-1
      apiKeyAuth: true
      retentionDays: 14
      timeouts:
        - create: 10m
          delete: 10m
  callerNamespace2:
    type: temporalcloud:Namespace
    properties:
      regions:
        - gcp-us-central1
      apiKeyAuth: true
      retentionDays: 14
      timeouts:
        - create: 10m
          delete: 10m
  nexusEndpoint:
    type: temporalcloud:NexusEndpoint
    properties:
      description: |
        Service Name:
          my-hello-service
        Operation Names:
          echo
          say-hello

        Input / Output arguments are in the following repository:
        https://github.com/temporalio/samples-go/blob/main/nexus/service/api.go        
      workerTarget:
        namespace_id: ${targetNamespace.id}
        task_queue: terraform-task-queue
      allowedCallerNamespaces:
        - ${callerNamespace.id}
        - ${callerNamespace2.id}

    Create NexusEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NexusEndpoint(name: string, args: NexusEndpointArgs, opts?: CustomResourceOptions);
    @overload
def NexusEndpoint(resource_name: str,
                  args: NexusEndpointArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def NexusEndpoint(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  allowed_caller_namespaces: Optional[Sequence[str]] = None,
                  worker_target: Optional[NexusEndpointWorkerTargetArgs] = None,
                  description: Optional[str] = None,
                  name: Optional[str] = None,
                  timeouts: Optional[NexusEndpointTimeoutsArgs] = None)
    func NewNexusEndpoint(ctx *Context, name string, args NexusEndpointArgs, opts ...ResourceOption) (*NexusEndpoint, error)
    public NexusEndpoint(string name, NexusEndpointArgs args, CustomResourceOptions? opts = null)
    public NexusEndpoint(String name, NexusEndpointArgs args)
public NexusEndpoint(String name, NexusEndpointArgs args, CustomResourceOptions options)

    type: temporalcloud:NexusEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args NexusEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NexusEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NexusEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NexusEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NexusEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var nexusEndpointResource = new Temporalcloud.NexusEndpoint("nexusEndpointResource", new()
{
    AllowedCallerNamespaces = new[]
    {
        "string",
    },
    WorkerTarget = new Temporalcloud.Inputs.NexusEndpointWorkerTargetArgs
    {
        NamespaceId = "string",
        TaskQueue = "string",
    },
    Description = "string",
    Name = "string",
    Timeouts = new Temporalcloud.Inputs.NexusEndpointTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
    },
});

    example, err := temporalcloud.NewNexusEndpoint(ctx, "nexusEndpointResource", &temporalcloud.NexusEndpointArgs{
AllowedCallerNamespaces: pulumi.StringArray{
pulumi.String("string"),
},
WorkerTarget: &.NexusEndpointWorkerTargetArgs{
NamespaceId: pulumi.String("string"),
TaskQueue: pulumi.String("string"),
},
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Timeouts: &.NexusEndpointTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
})

    var nexusEndpointResource = new NexusEndpoint("nexusEndpointResource", NexusEndpointArgs.builder()
    .allowedCallerNamespaces("string")
    .workerTarget(NexusEndpointWorkerTargetArgs.builder()
        .namespaceId("string")
        .taskQueue("string")
        .build())
    .description("string")
    .name("string")
    .timeouts(NexusEndpointTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .build())
    .build());

    nexus_endpoint_resource = temporalcloud.NexusEndpoint("nexusEndpointResource",
    allowed_caller_namespaces=["string"],
    worker_target={
        "namespace_id": "string",
        "task_queue": "string",
    },
    description="string",
    name="string",
    timeouts={
        "create": "string",
        "delete": "string",
    })

    const nexusEndpointResource = new temporalcloud.NexusEndpoint("nexusEndpointResource", {
    allowedCallerNamespaces: ["string"],
    workerTarget: {
        namespaceId: "string",
        taskQueue: "string",
    },
    description: "string",
    name: "string",
    timeouts: {
        create: "string",
        "delete": "string",
    },
});

    type: temporalcloud:NexusEndpoint
properties:
    allowedCallerNamespaces:
        - string
    description: string
    name: string
    timeouts:
        create: string
        delete: string
    workerTarget:
        namespaceId: string
        taskQueue: string

    NexusEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The NexusEndpoint resource accepts the following input properties:

    AllowedCallerNamespaces List<string>
    Namespace Id(s) that are allowed to call this Endpoint.
    WorkerTarget NexusEndpointWorkerTarget
    A target spec for routing nexus requests to a specific cloud namespace worker.
    Description string
    The description for the Nexus endpoint.
    Name string
    The name of the endpoint. Must be unique within an account and match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$
    Timeouts NexusEndpointTimeouts
    AllowedCallerNamespaces []string
    Namespace Id(s) that are allowed to call this Endpoint.
    WorkerTarget NexusEndpointWorkerTargetArgs
    A target spec for routing nexus requests to a specific cloud namespace worker.
    Description string
    The description for the Nexus endpoint.
    Name string
    The name of the endpoint. Must be unique within an account and match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$
    Timeouts NexusEndpointTimeoutsArgs
    allowedCallerNamespaces List<String>
    Namespace Id(s) that are allowed to call this Endpoint.
    workerTarget NexusEndpointWorkerTarget
    A target spec for routing nexus requests to a specific cloud namespace worker.
    description String
    The description for the Nexus endpoint.
    name String
    The name of the endpoint. Must be unique within an account and match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$
    timeouts NexusEndpointTimeouts
    allowedCallerNamespaces string[]
    Namespace Id(s) that are allowed to call this Endpoint.
    workerTarget NexusEndpointWorkerTarget
    A target spec for routing nexus requests to a specific cloud namespace worker.
    description string
    The description for the Nexus endpoint.
    name string
    The name of the endpoint. Must be unique within an account and match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$
    timeouts NexusEndpointTimeouts
    allowed_caller_namespaces Sequence[str]
    Namespace Id(s) that are allowed to call this Endpoint.
    worker_target NexusEndpointWorkerTargetArgs
    A target spec for routing nexus requests to a specific cloud namespace worker.
    description str
    The description for the Nexus endpoint.
    name str
    The name of the endpoint. Must be unique within an account and match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$
    timeouts NexusEndpointTimeoutsArgs
    allowedCallerNamespaces List<String>
    Namespace Id(s) that are allowed to call this Endpoint.
    workerTarget Property Map
    A target spec for routing nexus requests to a specific cloud namespace worker.
    description String
    The description for the Nexus endpoint.
    name String
    The name of the endpoint. Must be unique within an account and match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NexusEndpoint resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NexusEndpoint Resource

    Get an existing NexusEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: NexusEndpointState, opts?: CustomResourceOptions): NexusEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_caller_namespaces: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        timeouts: Optional[NexusEndpointTimeoutsArgs] = None,
        worker_target: Optional[NexusEndpointWorkerTargetArgs] = None) -> NexusEndpoint
    func GetNexusEndpoint(ctx *Context, name string, id IDInput, state *NexusEndpointState, opts ...ResourceOption) (*NexusEndpoint, error)
    public static NexusEndpoint Get(string name, Input<string> id, NexusEndpointState? state, CustomResourceOptions? opts = null)
    public static NexusEndpoint get(String name, Output<String> id, NexusEndpointState state, CustomResourceOptions options)
    resources:  _:    type: temporalcloud:NexusEndpoint    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowedCallerNamespaces List<string>
    Namespace Id(s) that are allowed to call this Endpoint.
    Description string
    The description for the Nexus endpoint.
    Name string
    The name of the endpoint. Must be unique within an account and match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$
    Timeouts NexusEndpointTimeouts
    WorkerTarget NexusEndpointWorkerTarget
    A target spec for routing nexus requests to a specific cloud namespace worker.
    AllowedCallerNamespaces []string
    Namespace Id(s) that are allowed to call this Endpoint.
    Description string
    The description for the Nexus endpoint.
    Name string
    The name of the endpoint. Must be unique within an account and match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$
    Timeouts NexusEndpointTimeoutsArgs
    WorkerTarget NexusEndpointWorkerTargetArgs
    A target spec for routing nexus requests to a specific cloud namespace worker.
    allowedCallerNamespaces List<String>
    Namespace Id(s) that are allowed to call this Endpoint.
    description String
    The description for the Nexus endpoint.
    name String
    The name of the endpoint. Must be unique within an account and match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$
    timeouts NexusEndpointTimeouts
    workerTarget NexusEndpointWorkerTarget
    A target spec for routing nexus requests to a specific cloud namespace worker.
    allowedCallerNamespaces string[]
    Namespace Id(s) that are allowed to call this Endpoint.
    description string
    The description for the Nexus endpoint.
    name string
    The name of the endpoint. Must be unique within an account and match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$
    timeouts NexusEndpointTimeouts
    workerTarget NexusEndpointWorkerTarget
    A target spec for routing nexus requests to a specific cloud namespace worker.
    allowed_caller_namespaces Sequence[str]
    Namespace Id(s) that are allowed to call this Endpoint.
    description str
    The description for the Nexus endpoint.
    name str
    The name of the endpoint. Must be unique within an account and match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$
    timeouts NexusEndpointTimeoutsArgs
    worker_target NexusEndpointWorkerTargetArgs
    A target spec for routing nexus requests to a specific cloud namespace worker.
    allowedCallerNamespaces List<String>
    Namespace Id(s) that are allowed to call this Endpoint.
    description String
    The description for the Nexus endpoint.
    name String
    The name of the endpoint. Must be unique within an account and match ^[a-zA-Z][a-zA-Z0-9\-]*[a-zA-Z0-9]$
    timeouts Property Map
    workerTarget Property Map
    A target spec for routing nexus requests to a specific cloud namespace worker.

    Supporting Types

    NexusEndpointTimeouts, NexusEndpointTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration 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.
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration 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.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration 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.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration 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.
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration 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.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration 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.

    NexusEndpointWorkerTarget, NexusEndpointWorkerTargetArgs

    NamespaceId string
    The target cloud namespace to route requests to. Namespace must be in same account as the endpoint.
    TaskQueue string
    The task queue on the cloud namespace to route requests to.
    NamespaceId string
    The target cloud namespace to route requests to. Namespace must be in same account as the endpoint.
    TaskQueue string
    The task queue on the cloud namespace to route requests to.
    namespaceId String
    The target cloud namespace to route requests to. Namespace must be in same account as the endpoint.
    taskQueue String
    The task queue on the cloud namespace to route requests to.
    namespaceId string
    The target cloud namespace to route requests to. Namespace must be in same account as the endpoint.
    taskQueue string
    The task queue on the cloud namespace to route requests to.
    namespace_id str
    The target cloud namespace to route requests to. Namespace must be in same account as the endpoint.
    task_queue str
    The task queue on the cloud namespace to route requests to.
    namespaceId String
    The target cloud namespace to route requests to. Namespace must be in same account as the endpoint.
    taskQueue String
    The task queue on the cloud namespace to route requests to.

    Import

    Nexus Endpoints can be imported to incorporate existing Nexus Endpoints into your Terraform pipeline.

    To import a Nexus Endpoint, you need

    • a resource configuration in your Terraform configuration file/module to accept the imported Nexus Endpoint. In the example below, the placeholder is “temporalcloud_nexus_endpoint” “nexus_endpoint”

    • the Nexus Endpoint’s ID, which is found using the Temporal Cloud CLI tcld nexus endpoint list. In the example below, this is 405f7da4224a43d99c211904ed9b3819

    $ pulumi import temporalcloud:index/nexusEndpoint:NexusEndpoint nexus_endpoint 405f7da4224a43d99c211904ed9b3819

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    temporalcloud temporalio/terraform-provider-temporalcloud
    License
    Notes
    This Pulumi package is based on the temporalcloud Terraform Provider.
    temporalcloud logo
    temporalcloud 0.6.1 published on Friday, Mar 7, 2025 by temporalio
    temporalio/terraform-provider-temporalcloud