Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Upstash
  3. API Docs
  4. Search
Upstash v0.5.0 published on Wednesday, Aug 27, 2025 by Upstash
upstash/pulumi-upstash

upstash.Search

Explore with Pulumi AI

upstash logo
Upstash v0.5.0 published on Wednesday, Aug 27, 2025 by Upstash
upstash/pulumi-upstash

    Create Search Resource

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

    Constructor syntax

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

@overload
def Search(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           region: Optional[str] = None,
           type: Optional[str] = None,
           name: Optional[str] = None,
           reserved_price: Optional[float] = None)
    func NewSearch(ctx *Context, name string, args SearchArgs, opts ...ResourceOption) (*Search, error)
    public Search(string name, SearchArgs args, CustomResourceOptions? opts = null)
    public Search(String name, SearchArgs args)
public Search(String name, SearchArgs args, CustomResourceOptions options)

    type: upstash:Search
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 SearchArgs
    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 SearchArgs
    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 SearchArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SearchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SearchArgs
    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 searchResource = new Upstash.Search("searchResource", new()
{
    Region = "string",
    Type = "string",
    Name = "string",
    ReservedPrice = 0,
});

    example, err := upstash.NewSearch(ctx, "searchResource", &upstash.SearchArgs{
	Region:        pulumi.String("string"),
	Type:          pulumi.String("string"),
	Name:          pulumi.String("string"),
	ReservedPrice: pulumi.Float64(0),
})

    var searchResource = new Search("searchResource", SearchArgs.builder()
    .region("string")
    .type("string")
    .name("string")
    .reservedPrice(0.0)
    .build());

    search_resource = upstash.Search("searchResource",
    region="string",
    type="string",
    name="string",
    reserved_price=0)

    const searchResource = new upstash.Search("searchResource", {
    region: "string",
    type: "string",
    name: "string",
    reservedPrice: 0,
});

    type: upstash:Search
properties:
    name: string
    region: string
    reservedPrice: 0
    type: string

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

    Region string
    The region where your search is deployed.
    Type string
    Associated plan of the search. payg can be used
    Name string
    Name of the search.
    ReservedPrice double
    Monthly pricing of your search. Only available for fixed and pro plans.
    Region string
    The region where your search is deployed.
    Type string
    Associated plan of the search. payg can be used
    Name string
    Name of the search.
    ReservedPrice float64
    Monthly pricing of your search. Only available for fixed and pro plans.
    region String
    The region where your search is deployed.
    type String
    Associated plan of the search. payg can be used
    name String
    Name of the search.
    reservedPrice Double
    Monthly pricing of your search. Only available for fixed and pro plans.
    region string
    The region where your search is deployed.
    type string
    Associated plan of the search. payg can be used
    name string
    Name of the search.
    reservedPrice number
    Monthly pricing of your search. Only available for fixed and pro plans.
    region str
    The region where your search is deployed.
    type str
    Associated plan of the search. payg can be used
    name str
    Name of the search.
    reserved_price float
    Monthly pricing of your search. Only available for fixed and pro plans.
    region String
    The region where your search is deployed.
    type String
    Associated plan of the search. payg can be used
    name String
    Name of the search.
    reservedPrice Number
    Monthly pricing of your search. Only available for fixed and pro plans.

    Outputs

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

    CreationTime int
    The creation time of the search in UTC as unix timestamp.
    CustomerId string
    The unique ID associated to the owner of this search.
    Endpoint string
    Associated endpoint of your search.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxDailyQueries int
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    MaxDailyUpdates int
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    MaxMonthlyBandwidth int
    The maximum amount of monthly bandwidth for the search. Unit is bytes. -1 if the limit is unlimited.
    MaxQueryPerSecond int
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    MaxReadsPerRequest int
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    MaxTotalMetadataSize int
    The amount of maximum size for the total metadata sizes in your search.
    MaxVectorCount int
    The number of maximum that your search can contain.
    MaxWritesPerRequest int
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    MaxWritesPerSecond int
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    ReadOnlyToken string
    Readonly REST token to send request to the related search. You can't perform update operation with this token.
    Token string
    REST token to send request to the related search.
    CreationTime int
    The creation time of the search in UTC as unix timestamp.
    CustomerId string
    The unique ID associated to the owner of this search.
    Endpoint string
    Associated endpoint of your search.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxDailyQueries int
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    MaxDailyUpdates int
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    MaxMonthlyBandwidth int
    The maximum amount of monthly bandwidth for the search. Unit is bytes. -1 if the limit is unlimited.
    MaxQueryPerSecond int
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    MaxReadsPerRequest int
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    MaxTotalMetadataSize int
    The amount of maximum size for the total metadata sizes in your search.
    MaxVectorCount int
    The number of maximum that your search can contain.
    MaxWritesPerRequest int
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    MaxWritesPerSecond int
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    ReadOnlyToken string
    Readonly REST token to send request to the related search. You can't perform update operation with this token.
    Token string
    REST token to send request to the related search.
    creationTime Integer
    The creation time of the search in UTC as unix timestamp.
    customerId String
    The unique ID associated to the owner of this search.
    endpoint String
    Associated endpoint of your search.
    id String
    The provider-assigned unique ID for this managed resource.
    maxDailyQueries Integer
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    maxDailyUpdates Integer
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    maxMonthlyBandwidth Integer
    The maximum amount of monthly bandwidth for the search. Unit is bytes. -1 if the limit is unlimited.
    maxQueryPerSecond Integer
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    maxReadsPerRequest Integer
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    maxTotalMetadataSize Integer
    The amount of maximum size for the total metadata sizes in your search.
    maxVectorCount Integer
    The number of maximum that your search can contain.
    maxWritesPerRequest Integer
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    maxWritesPerSecond Integer
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    readOnlyToken String
    Readonly REST token to send request to the related search. You can't perform update operation with this token.
    token String
    REST token to send request to the related search.
    creationTime number
    The creation time of the search in UTC as unix timestamp.
    customerId string
    The unique ID associated to the owner of this search.
    endpoint string
    Associated endpoint of your search.
    id string
    The provider-assigned unique ID for this managed resource.
    maxDailyQueries number
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    maxDailyUpdates number
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    maxMonthlyBandwidth number
    The maximum amount of monthly bandwidth for the search. Unit is bytes. -1 if the limit is unlimited.
    maxQueryPerSecond number
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    maxReadsPerRequest number
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    maxTotalMetadataSize number
    The amount of maximum size for the total metadata sizes in your search.
    maxVectorCount number
    The number of maximum that your search can contain.
    maxWritesPerRequest number
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    maxWritesPerSecond number
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    readOnlyToken string
    Readonly REST token to send request to the related search. You can't perform update operation with this token.
    token string
    REST token to send request to the related search.
    creation_time int
    The creation time of the search in UTC as unix timestamp.
    customer_id str
    The unique ID associated to the owner of this search.
    endpoint str
    Associated endpoint of your search.
    id str
    The provider-assigned unique ID for this managed resource.
    max_daily_queries int
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    max_daily_updates int
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    max_monthly_bandwidth int
    The maximum amount of monthly bandwidth for the search. Unit is bytes. -1 if the limit is unlimited.
    max_query_per_second int
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    max_reads_per_request int
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    max_total_metadata_size int
    The amount of maximum size for the total metadata sizes in your search.
    max_vector_count int
    The number of maximum that your search can contain.
    max_writes_per_request int
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    max_writes_per_second int
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    read_only_token str
    Readonly REST token to send request to the related search. You can't perform update operation with this token.
    token str
    REST token to send request to the related search.
    creationTime Number
    The creation time of the search in UTC as unix timestamp.
    customerId String
    The unique ID associated to the owner of this search.
    endpoint String
    Associated endpoint of your search.
    id String
    The provider-assigned unique ID for this managed resource.
    maxDailyQueries Number
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    maxDailyUpdates Number
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    maxMonthlyBandwidth Number
    The maximum amount of monthly bandwidth for the search. Unit is bytes. -1 if the limit is unlimited.
    maxQueryPerSecond Number
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    maxReadsPerRequest Number
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    maxTotalMetadataSize Number
    The amount of maximum size for the total metadata sizes in your search.
    maxVectorCount Number
    The number of maximum that your search can contain.
    maxWritesPerRequest Number
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    maxWritesPerSecond Number
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    readOnlyToken String
    Readonly REST token to send request to the related search. You can't perform update operation with this token.
    token String
    REST token to send request to the related search.

    Look up Existing Search Resource

    Get an existing Search 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?: SearchState, opts?: CustomResourceOptions): Search
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_time: Optional[int] = None,
        customer_id: Optional[str] = None,
        endpoint: Optional[str] = None,
        max_daily_queries: Optional[int] = None,
        max_daily_updates: Optional[int] = None,
        max_monthly_bandwidth: Optional[int] = None,
        max_query_per_second: Optional[int] = None,
        max_reads_per_request: Optional[int] = None,
        max_total_metadata_size: Optional[int] = None,
        max_vector_count: Optional[int] = None,
        max_writes_per_request: Optional[int] = None,
        max_writes_per_second: Optional[int] = None,
        name: Optional[str] = None,
        read_only_token: Optional[str] = None,
        region: Optional[str] = None,
        reserved_price: Optional[float] = None,
        token: Optional[str] = None,
        type: Optional[str] = None) -> Search
    func GetSearch(ctx *Context, name string, id IDInput, state *SearchState, opts ...ResourceOption) (*Search, error)
    public static Search Get(string name, Input<string> id, SearchState? state, CustomResourceOptions? opts = null)
    public static Search get(String name, Output<String> id, SearchState state, CustomResourceOptions options)
    resources:  _:    type: upstash:Search    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:
    CreationTime int
    The creation time of the search in UTC as unix timestamp.
    CustomerId string
    The unique ID associated to the owner of this search.
    Endpoint string
    Associated endpoint of your search.
    MaxDailyQueries int
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    MaxDailyUpdates int
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    MaxMonthlyBandwidth int
    The maximum amount of monthly bandwidth for the search. Unit is bytes. -1 if the limit is unlimited.
    MaxQueryPerSecond int
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    MaxReadsPerRequest int
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    MaxTotalMetadataSize int
    The amount of maximum size for the total metadata sizes in your search.
    MaxVectorCount int
    The number of maximum that your search can contain.
    MaxWritesPerRequest int
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    MaxWritesPerSecond int
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    Name string
    Name of the search.
    ReadOnlyToken string
    Readonly REST token to send request to the related search. You can't perform update operation with this token.
    Region string
    The region where your search is deployed.
    ReservedPrice double
    Monthly pricing of your search. Only available for fixed and pro plans.
    Token string
    REST token to send request to the related search.
    Type string
    Associated plan of the search. payg can be used
    CreationTime int
    The creation time of the search in UTC as unix timestamp.
    CustomerId string
    The unique ID associated to the owner of this search.
    Endpoint string
    Associated endpoint of your search.
    MaxDailyQueries int
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    MaxDailyUpdates int
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    MaxMonthlyBandwidth int
    The maximum amount of monthly bandwidth for the search. Unit is bytes. -1 if the limit is unlimited.
    MaxQueryPerSecond int
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    MaxReadsPerRequest int
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    MaxTotalMetadataSize int
    The amount of maximum size for the total metadata sizes in your search.
    MaxVectorCount int
    The number of maximum that your search can contain.
    MaxWritesPerRequest int
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    MaxWritesPerSecond int
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    Name string
    Name of the search.
    ReadOnlyToken string
    Readonly REST token to send request to the related search. You can't perform update operation with this token.
    Region string
    The region where your search is deployed.
    ReservedPrice float64
    Monthly pricing of your search. Only available for fixed and pro plans.
    Token string
    REST token to send request to the related search.
    Type string
    Associated plan of the search. payg can be used
    creationTime Integer
    The creation time of the search in UTC as unix timestamp.
    customerId String
    The unique ID associated to the owner of this search.
    endpoint String
    Associated endpoint of your search.
    maxDailyQueries Integer
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    maxDailyUpdates Integer
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    maxMonthlyBandwidth Integer
    The maximum amount of monthly bandwidth for the search. Unit is bytes. -1 if the limit is unlimited.
    maxQueryPerSecond Integer
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    maxReadsPerRequest Integer
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    maxTotalMetadataSize Integer
    The amount of maximum size for the total metadata sizes in your search.
    maxVectorCount Integer
    The number of maximum that your search can contain.
    maxWritesPerRequest Integer
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    maxWritesPerSecond Integer
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    name String
    Name of the search.
    readOnlyToken String
    Readonly REST token to send request to the related search. You can't perform update operation with this token.
    region String
    The region where your search is deployed.
    reservedPrice Double
    Monthly pricing of your search. Only available for fixed and pro plans.
    token String
    REST token to send request to the related search.
    type String
    Associated plan of the search. payg can be used
    creationTime number
    The creation time of the search in UTC as unix timestamp.
    customerId string
    The unique ID associated to the owner of this search.
    endpoint string
    Associated endpoint of your search.
    maxDailyQueries number
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    maxDailyUpdates number
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    maxMonthlyBandwidth number
    The maximum amount of monthly bandwidth for the search. Unit is bytes. -1 if the limit is unlimited.
    maxQueryPerSecond number
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    maxReadsPerRequest number
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    maxTotalMetadataSize number
    The amount of maximum size for the total metadata sizes in your search.
    maxVectorCount number
    The number of maximum that your search can contain.
    maxWritesPerRequest number
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    maxWritesPerSecond number
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    name string
    Name of the search.
    readOnlyToken string
    Readonly REST token to send request to the related search. You can't perform update operation with this token.
    region string
    The region where your search is deployed.
    reservedPrice number
    Monthly pricing of your search. Only available for fixed and pro plans.
    token string
    REST token to send request to the related search.
    type string
    Associated plan of the search. payg can be used
    creation_time int
    The creation time of the search in UTC as unix timestamp.
    customer_id str
    The unique ID associated to the owner of this search.
    endpoint str
    Associated endpoint of your search.
    max_daily_queries int
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    max_daily_updates int
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    max_monthly_bandwidth int
    The maximum amount of monthly bandwidth for the search. Unit is bytes. -1 if the limit is unlimited.
    max_query_per_second int
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    max_reads_per_request int
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    max_total_metadata_size int
    The amount of maximum size for the total metadata sizes in your search.
    max_vector_count int
    The number of maximum that your search can contain.
    max_writes_per_request int
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    max_writes_per_second int
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    name str
    Name of the search.
    read_only_token str
    Readonly REST token to send request to the related search. You can't perform update operation with this token.
    region str
    The region where your search is deployed.
    reserved_price float
    Monthly pricing of your search. Only available for fixed and pro plans.
    token str
    REST token to send request to the related search.
    type str
    Associated plan of the search. payg can be used
    creationTime Number
    The creation time of the search in UTC as unix timestamp.
    customerId String
    The unique ID associated to the owner of this search.
    endpoint String
    Associated endpoint of your search.
    maxDailyQueries Number
    The number of maximum query operations you can perform in a day. Only query operations are included in query count.
    maxDailyUpdates Number
    The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
    maxMonthlyBandwidth Number
    The maximum amount of monthly bandwidth for the search. Unit is bytes. -1 if the limit is unlimited.
    maxQueryPerSecond Number
    The number of maximum query operations you can perform per second. Only query operations are included in query count.
    maxReadsPerRequest Number
    The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
    maxTotalMetadataSize Number
    The amount of maximum size for the total metadata sizes in your search.
    maxVectorCount Number
    The number of maximum that your search can contain.
    maxWritesPerRequest Number
    The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
    maxWritesPerSecond Number
    The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
    name String
    Name of the search.
    readOnlyToken String
    Readonly REST token to send request to the related search. You can't perform update operation with this token.
    region String
    The region where your search is deployed.
    reservedPrice Number
    Monthly pricing of your search. Only available for fixed and pro plans.
    token String
    REST token to send request to the related search.
    type String
    Associated plan of the search. payg can be used

    Package Details

    Repository
    upstash upstash/pulumi-upstash
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the upstash Terraform Provider.
    upstash logo
    Upstash v0.5.0 published on Wednesday, Aug 27, 2025 by Upstash
    upstash/pulumi-upstash