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

temporalcloud.NamespaceSearchAttribute

Explore with Pulumi AI

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

    Create a search attribute in a Temporal Cloud namespace. Note the limits on quantity and naming.

    Create NamespaceSearchAttribute Resource

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

    Constructor syntax

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

@overload
def NamespaceSearchAttribute(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             namespace_id: Optional[str] = None,
                             type: Optional[str] = None,
                             name: Optional[str] = None)
    func NewNamespaceSearchAttribute(ctx *Context, name string, args NamespaceSearchAttributeArgs, opts ...ResourceOption) (*NamespaceSearchAttribute, error)
    public NamespaceSearchAttribute(string name, NamespaceSearchAttributeArgs args, CustomResourceOptions? opts = null)
    public NamespaceSearchAttribute(String name, NamespaceSearchAttributeArgs args)
public NamespaceSearchAttribute(String name, NamespaceSearchAttributeArgs args, CustomResourceOptions options)

    type: temporalcloud:NamespaceSearchAttribute
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 NamespaceSearchAttributeArgs
    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 NamespaceSearchAttributeArgs
    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 NamespaceSearchAttributeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NamespaceSearchAttributeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NamespaceSearchAttributeArgs
    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 namespaceSearchAttributeResource = new Temporalcloud.NamespaceSearchAttribute("namespaceSearchAttributeResource", new()
{
    NamespaceId = "string",
    Type = "string",
    Name = "string",
});

    example, err := temporalcloud.NewNamespaceSearchAttribute(ctx, "namespaceSearchAttributeResource", &temporalcloud.NamespaceSearchAttributeArgs{
NamespaceId: pulumi.String("string"),
Type: pulumi.String("string"),
Name: pulumi.String("string"),
})

    var namespaceSearchAttributeResource = new NamespaceSearchAttribute("namespaceSearchAttributeResource", NamespaceSearchAttributeArgs.builder()
    .namespaceId("string")
    .type("string")
    .name("string")
    .build());

    namespace_search_attribute_resource = temporalcloud.NamespaceSearchAttribute("namespaceSearchAttributeResource",
    namespace_id="string",
    type="string",
    name="string")

    const namespaceSearchAttributeResource = new temporalcloud.NamespaceSearchAttribute("namespaceSearchAttributeResource", {
    namespaceId: "string",
    type: "string",
    name: "string",
});

    type: temporalcloud:NamespaceSearchAttribute
properties:
    name: string
    namespaceId: string
    type: string

    NamespaceSearchAttribute 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 NamespaceSearchAttribute resource accepts the following input properties:

    NamespaceId string
    The ID of the namespace to which this search attribute belongs.
    Type string
    The type of the search attribute. Must be one of bool, datetime, double, int, keyword, keyword_list or text. (case-insensitive)
    Name string
    The name of the search attribute.
    NamespaceId string
    The ID of the namespace to which this search attribute belongs.
    Type string
    The type of the search attribute. Must be one of bool, datetime, double, int, keyword, keyword_list or text. (case-insensitive)
    Name string
    The name of the search attribute.
    namespaceId String
    The ID of the namespace to which this search attribute belongs.
    type String
    The type of the search attribute. Must be one of bool, datetime, double, int, keyword, keyword_list or text. (case-insensitive)
    name String
    The name of the search attribute.
    namespaceId string
    The ID of the namespace to which this search attribute belongs.
    type string
    The type of the search attribute. Must be one of bool, datetime, double, int, keyword, keyword_list or text. (case-insensitive)
    name string
    The name of the search attribute.
    namespace_id str
    The ID of the namespace to which this search attribute belongs.
    type str
    The type of the search attribute. Must be one of bool, datetime, double, int, keyword, keyword_list or text. (case-insensitive)
    name str
    The name of the search attribute.
    namespaceId String
    The ID of the namespace to which this search attribute belongs.
    type String
    The type of the search attribute. Must be one of bool, datetime, double, int, keyword, keyword_list or text. (case-insensitive)
    name String
    The name of the search attribute.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NamespaceSearchAttribute 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 NamespaceSearchAttribute Resource

    Get an existing NamespaceSearchAttribute 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?: NamespaceSearchAttributeState, opts?: CustomResourceOptions): NamespaceSearchAttribute
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        namespace_id: Optional[str] = None,
        type: Optional[str] = None) -> NamespaceSearchAttribute
    func GetNamespaceSearchAttribute(ctx *Context, name string, id IDInput, state *NamespaceSearchAttributeState, opts ...ResourceOption) (*NamespaceSearchAttribute, error)
    public static NamespaceSearchAttribute Get(string name, Input<string> id, NamespaceSearchAttributeState? state, CustomResourceOptions? opts = null)
    public static NamespaceSearchAttribute get(String name, Output<String> id, NamespaceSearchAttributeState state, CustomResourceOptions options)
    resources:  _:    type: temporalcloud:NamespaceSearchAttribute    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:
    Name string
    The name of the search attribute.
    NamespaceId string
    The ID of the namespace to which this search attribute belongs.
    Type string
    The type of the search attribute. Must be one of bool, datetime, double, int, keyword, keyword_list or text. (case-insensitive)
    Name string
    The name of the search attribute.
    NamespaceId string
    The ID of the namespace to which this search attribute belongs.
    Type string
    The type of the search attribute. Must be one of bool, datetime, double, int, keyword, keyword_list or text. (case-insensitive)
    name String
    The name of the search attribute.
    namespaceId String
    The ID of the namespace to which this search attribute belongs.
    type String
    The type of the search attribute. Must be one of bool, datetime, double, int, keyword, keyword_list or text. (case-insensitive)
    name string
    The name of the search attribute.
    namespaceId string
    The ID of the namespace to which this search attribute belongs.
    type string
    The type of the search attribute. Must be one of bool, datetime, double, int, keyword, keyword_list or text. (case-insensitive)
    name str
    The name of the search attribute.
    namespace_id str
    The ID of the namespace to which this search attribute belongs.
    type str
    The type of the search attribute. Must be one of bool, datetime, double, int, keyword, keyword_list or text. (case-insensitive)
    name String
    The name of the search attribute.
    namespaceId String
    The ID of the namespace to which this search attribute belongs.
    type String
    The type of the search attribute. Must be one of bool, datetime, double, int, keyword, keyword_list or text. (case-insensitive)

    Import

    Search Attributes can be imported to incorporate existing Namespace Search Attributes into your Terraform pipeline.

    To import a Search Attribute, you need

    • a resource configuration in your Terraform configuration file/module to accept the imported Search Attribute. In the example below, the placeholder is “temporalcloud_namespace_search_attribute” “saimport”

    • 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

    • the name of the Search Attribute, which is available in the Search Attribute configuration of Namespace’s page in the Temporal Cloud UI. In the example below, this is searchAttr

    $ pulumi import temporalcloud:index/namespaceSearchAttribute:NamespaceSearchAttribute saimport namespaceid.acctid/searchAttr

    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