Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. CortexSearchService
Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-snowflake

snowflake.CortexSearchService

Explore with Pulumi AI

Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-snowflake

Import

$ pulumi import snowflake:index/cortexSearchService:CortexSearchService example 'dbName|schemaName|fileFormatName'
Copy

Create CortexSearchService Resource

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

Constructor syntax

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

@overload
def CortexSearchService(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        database: Optional[str] = None,
                        on: Optional[str] = None,
                        query: Optional[str] = None,
                        schema: Optional[str] = None,
                        target_lag: Optional[str] = None,
                        warehouse: Optional[str] = None,
                        attributes: Optional[Sequence[str]] = None,
                        comment: Optional[str] = None,
                        name: Optional[str] = None)
func NewCortexSearchService(ctx *Context, name string, args CortexSearchServiceArgs, opts ...ResourceOption) (*CortexSearchService, error)
public CortexSearchService(string name, CortexSearchServiceArgs args, CustomResourceOptions? opts = null)
public CortexSearchService(String name, CortexSearchServiceArgs args)
public CortexSearchService(String name, CortexSearchServiceArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CortexSearchServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CortexSearchServiceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CortexSearchServiceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CortexSearchServiceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CortexSearchServiceArgs
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 cortexSearchServiceResource = new Snowflake.CortexSearchService("cortexSearchServiceResource", new()
{
    Database = "string",
    On = "string",
    Query = "string",
    Schema = "string",
    TargetLag = "string",
    Warehouse = "string",
    Attributes = new[]
    {
        "string",
    },
    Comment = "string",
    Name = "string",
});
Copy
example, err := snowflake.NewCortexSearchService(ctx, "cortexSearchServiceResource", &snowflake.CortexSearchServiceArgs{
	Database:  pulumi.String("string"),
	On:        pulumi.String("string"),
	Query:     pulumi.String("string"),
	Schema:    pulumi.String("string"),
	TargetLag: pulumi.String("string"),
	Warehouse: pulumi.String("string"),
	Attributes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Comment: pulumi.String("string"),
	Name:    pulumi.String("string"),
})
Copy
var cortexSearchServiceResource = new CortexSearchService("cortexSearchServiceResource", CortexSearchServiceArgs.builder()
    .database("string")
    .on("string")
    .query("string")
    .schema("string")
    .targetLag("string")
    .warehouse("string")
    .attributes("string")
    .comment("string")
    .name("string")
    .build());
Copy
cortex_search_service_resource = snowflake.CortexSearchService("cortexSearchServiceResource",
    database="string",
    on="string",
    query="string",
    schema="string",
    target_lag="string",
    warehouse="string",
    attributes=["string"],
    comment="string",
    name="string")
Copy
const cortexSearchServiceResource = new snowflake.CortexSearchService("cortexSearchServiceResource", {
    database: "string",
    on: "string",
    query: "string",
    schema: "string",
    targetLag: "string",
    warehouse: "string",
    attributes: ["string"],
    comment: "string",
    name: "string",
});
Copy
type: snowflake:CortexSearchService
properties:
    attributes:
        - string
    comment: string
    database: string
    name: string
    "on": string
    query: string
    schema: string
    targetLag: string
    warehouse: string
Copy

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

Database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the Cortex search service.
On
This property is required.
Changes to this property will trigger replacement.
string
Specifies the column to use as the search column for the Cortex search service; must be a text value.
Query
This property is required.
Changes to this property will trigger replacement.
string
Specifies the query to use to populate the Cortex search service.
Schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the Cortex search service.
TargetLag This property is required. string
Specifies the maximum target lag time for the Cortex search service.
Warehouse This property is required. string
The warehouse in which to create the Cortex search service.
Attributes Changes to this property will trigger replacement. List<string>
Specifies the list of columns in the base table to enable filtering on when issuing queries to the service.
Comment string
Specifies a comment for the Cortex search service.
Name Changes to this property will trigger replacement. string
Specifies the name of the Cortex search service. The name must be unique for the schema in which the service is created.
Database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the Cortex search service.
On
This property is required.
Changes to this property will trigger replacement.
string
Specifies the column to use as the search column for the Cortex search service; must be a text value.
Query
This property is required.
Changes to this property will trigger replacement.
string
Specifies the query to use to populate the Cortex search service.
Schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the Cortex search service.
TargetLag This property is required. string
Specifies the maximum target lag time for the Cortex search service.
Warehouse This property is required. string
The warehouse in which to create the Cortex search service.
Attributes Changes to this property will trigger replacement. []string
Specifies the list of columns in the base table to enable filtering on when issuing queries to the service.
Comment string
Specifies a comment for the Cortex search service.
Name Changes to this property will trigger replacement. string
Specifies the name of the Cortex search service. The name must be unique for the schema in which the service is created.
database
This property is required.
Changes to this property will trigger replacement.
String
The database in which to create the Cortex search service.
on
This property is required.
Changes to this property will trigger replacement.
String
Specifies the column to use as the search column for the Cortex search service; must be a text value.
query
This property is required.
Changes to this property will trigger replacement.
String
Specifies the query to use to populate the Cortex search service.
schema
This property is required.
Changes to this property will trigger replacement.
String
The schema in which to create the Cortex search service.
targetLag This property is required. String
Specifies the maximum target lag time for the Cortex search service.
warehouse This property is required. String
The warehouse in which to create the Cortex search service.
attributes Changes to this property will trigger replacement. List<String>
Specifies the list of columns in the base table to enable filtering on when issuing queries to the service.
comment String
Specifies a comment for the Cortex search service.
name Changes to this property will trigger replacement. String
Specifies the name of the Cortex search service. The name must be unique for the schema in which the service is created.
database
This property is required.
Changes to this property will trigger replacement.
string
The database in which to create the Cortex search service.
on
This property is required.
Changes to this property will trigger replacement.
string
Specifies the column to use as the search column for the Cortex search service; must be a text value.
query
This property is required.
Changes to this property will trigger replacement.
string
Specifies the query to use to populate the Cortex search service.
schema
This property is required.
Changes to this property will trigger replacement.
string
The schema in which to create the Cortex search service.
targetLag This property is required. string
Specifies the maximum target lag time for the Cortex search service.
warehouse This property is required. string
The warehouse in which to create the Cortex search service.
attributes Changes to this property will trigger replacement. string[]
Specifies the list of columns in the base table to enable filtering on when issuing queries to the service.
comment string
Specifies a comment for the Cortex search service.
name Changes to this property will trigger replacement. string
Specifies the name of the Cortex search service. The name must be unique for the schema in which the service is created.
database
This property is required.
Changes to this property will trigger replacement.
str
The database in which to create the Cortex search service.
on
This property is required.
Changes to this property will trigger replacement.
str
Specifies the column to use as the search column for the Cortex search service; must be a text value.
query
This property is required.
Changes to this property will trigger replacement.
str
Specifies the query to use to populate the Cortex search service.
schema
This property is required.
Changes to this property will trigger replacement.
str
The schema in which to create the Cortex search service.
target_lag This property is required. str
Specifies the maximum target lag time for the Cortex search service.
warehouse This property is required. str
The warehouse in which to create the Cortex search service.
attributes Changes to this property will trigger replacement. Sequence[str]
Specifies the list of columns in the base table to enable filtering on when issuing queries to the service.
comment str
Specifies a comment for the Cortex search service.
name Changes to this property will trigger replacement. str
Specifies the name of the Cortex search service. The name must be unique for the schema in which the service is created.
database
This property is required.
Changes to this property will trigger replacement.
String
The database in which to create the Cortex search service.
on
This property is required.
Changes to this property will trigger replacement.
String
Specifies the column to use as the search column for the Cortex search service; must be a text value.
query
This property is required.
Changes to this property will trigger replacement.
String
Specifies the query to use to populate the Cortex search service.
schema
This property is required.
Changes to this property will trigger replacement.
String
The schema in which to create the Cortex search service.
targetLag This property is required. String
Specifies the maximum target lag time for the Cortex search service.
warehouse This property is required. String
The warehouse in which to create the Cortex search service.
attributes Changes to this property will trigger replacement. List<String>
Specifies the list of columns in the base table to enable filtering on when issuing queries to the service.
comment String
Specifies a comment for the Cortex search service.
name Changes to this property will trigger replacement. String
Specifies the name of the Cortex search service. The name must be unique for the schema in which the service is created.

Outputs

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

CreatedOn string
Creation date for the given Cortex search service.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Id string
The provider-assigned unique ID for this managed resource.
CreatedOn string
Creation date for the given Cortex search service.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Id string
The provider-assigned unique ID for this managed resource.
createdOn String
Creation date for the given Cortex search service.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
id String
The provider-assigned unique ID for this managed resource.
createdOn string
Creation date for the given Cortex search service.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
id string
The provider-assigned unique ID for this managed resource.
created_on str
Creation date for the given Cortex search service.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
id str
The provider-assigned unique ID for this managed resource.
createdOn String
Creation date for the given Cortex search service.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing CortexSearchService Resource

Get an existing CortexSearchService 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?: CortexSearchServiceState, opts?: CustomResourceOptions): CortexSearchService
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        attributes: Optional[Sequence[str]] = None,
        comment: Optional[str] = None,
        created_on: Optional[str] = None,
        database: Optional[str] = None,
        fully_qualified_name: Optional[str] = None,
        name: Optional[str] = None,
        on: Optional[str] = None,
        query: Optional[str] = None,
        schema: Optional[str] = None,
        target_lag: Optional[str] = None,
        warehouse: Optional[str] = None) -> CortexSearchService
func GetCortexSearchService(ctx *Context, name string, id IDInput, state *CortexSearchServiceState, opts ...ResourceOption) (*CortexSearchService, error)
public static CortexSearchService Get(string name, Input<string> id, CortexSearchServiceState? state, CustomResourceOptions? opts = null)
public static CortexSearchService get(String name, Output<String> id, CortexSearchServiceState state, CustomResourceOptions options)
resources:  _:    type: snowflake:CortexSearchService    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Attributes Changes to this property will trigger replacement. List<string>
Specifies the list of columns in the base table to enable filtering on when issuing queries to the service.
Comment string
Specifies a comment for the Cortex search service.
CreatedOn string
Creation date for the given Cortex search service.
Database Changes to this property will trigger replacement. string
The database in which to create the Cortex search service.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Name Changes to this property will trigger replacement. string
Specifies the name of the Cortex search service. The name must be unique for the schema in which the service is created.
On Changes to this property will trigger replacement. string
Specifies the column to use as the search column for the Cortex search service; must be a text value.
Query Changes to this property will trigger replacement. string
Specifies the query to use to populate the Cortex search service.
Schema Changes to this property will trigger replacement. string
The schema in which to create the Cortex search service.
TargetLag string
Specifies the maximum target lag time for the Cortex search service.
Warehouse string
The warehouse in which to create the Cortex search service.
Attributes Changes to this property will trigger replacement. []string
Specifies the list of columns in the base table to enable filtering on when issuing queries to the service.
Comment string
Specifies a comment for the Cortex search service.
CreatedOn string
Creation date for the given Cortex search service.
Database Changes to this property will trigger replacement. string
The database in which to create the Cortex search service.
FullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
Name Changes to this property will trigger replacement. string
Specifies the name of the Cortex search service. The name must be unique for the schema in which the service is created.
On Changes to this property will trigger replacement. string
Specifies the column to use as the search column for the Cortex search service; must be a text value.
Query Changes to this property will trigger replacement. string
Specifies the query to use to populate the Cortex search service.
Schema Changes to this property will trigger replacement. string
The schema in which to create the Cortex search service.
TargetLag string
Specifies the maximum target lag time for the Cortex search service.
Warehouse string
The warehouse in which to create the Cortex search service.
attributes Changes to this property will trigger replacement. List<String>
Specifies the list of columns in the base table to enable filtering on when issuing queries to the service.
comment String
Specifies a comment for the Cortex search service.
createdOn String
Creation date for the given Cortex search service.
database Changes to this property will trigger replacement. String
The database in which to create the Cortex search service.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
name Changes to this property will trigger replacement. String
Specifies the name of the Cortex search service. The name must be unique for the schema in which the service is created.
on Changes to this property will trigger replacement. String
Specifies the column to use as the search column for the Cortex search service; must be a text value.
query Changes to this property will trigger replacement. String
Specifies the query to use to populate the Cortex search service.
schema Changes to this property will trigger replacement. String
The schema in which to create the Cortex search service.
targetLag String
Specifies the maximum target lag time for the Cortex search service.
warehouse String
The warehouse in which to create the Cortex search service.
attributes Changes to this property will trigger replacement. string[]
Specifies the list of columns in the base table to enable filtering on when issuing queries to the service.
comment string
Specifies a comment for the Cortex search service.
createdOn string
Creation date for the given Cortex search service.
database Changes to this property will trigger replacement. string
The database in which to create the Cortex search service.
fullyQualifiedName string
Fully qualified name of the resource. For more information, see object name resolution.
name Changes to this property will trigger replacement. string
Specifies the name of the Cortex search service. The name must be unique for the schema in which the service is created.
on Changes to this property will trigger replacement. string
Specifies the column to use as the search column for the Cortex search service; must be a text value.
query Changes to this property will trigger replacement. string
Specifies the query to use to populate the Cortex search service.
schema Changes to this property will trigger replacement. string
The schema in which to create the Cortex search service.
targetLag string
Specifies the maximum target lag time for the Cortex search service.
warehouse string
The warehouse in which to create the Cortex search service.
attributes Changes to this property will trigger replacement. Sequence[str]
Specifies the list of columns in the base table to enable filtering on when issuing queries to the service.
comment str
Specifies a comment for the Cortex search service.
created_on str
Creation date for the given Cortex search service.
database Changes to this property will trigger replacement. str
The database in which to create the Cortex search service.
fully_qualified_name str
Fully qualified name of the resource. For more information, see object name resolution.
name Changes to this property will trigger replacement. str
Specifies the name of the Cortex search service. The name must be unique for the schema in which the service is created.
on Changes to this property will trigger replacement. str
Specifies the column to use as the search column for the Cortex search service; must be a text value.
query Changes to this property will trigger replacement. str
Specifies the query to use to populate the Cortex search service.
schema Changes to this property will trigger replacement. str
The schema in which to create the Cortex search service.
target_lag str
Specifies the maximum target lag time for the Cortex search service.
warehouse str
The warehouse in which to create the Cortex search service.
attributes Changes to this property will trigger replacement. List<String>
Specifies the list of columns in the base table to enable filtering on when issuing queries to the service.
comment String
Specifies a comment for the Cortex search service.
createdOn String
Creation date for the given Cortex search service.
database Changes to this property will trigger replacement. String
The database in which to create the Cortex search service.
fullyQualifiedName String
Fully qualified name of the resource. For more information, see object name resolution.
name Changes to this property will trigger replacement. String
Specifies the name of the Cortex search service. The name must be unique for the schema in which the service is created.
on Changes to this property will trigger replacement. String
Specifies the column to use as the search column for the Cortex search service; must be a text value.
query Changes to this property will trigger replacement. String
Specifies the query to use to populate the Cortex search service.
schema Changes to this property will trigger replacement. String
The schema in which to create the Cortex search service.
targetLag String
Specifies the maximum target lag time for the Cortex search service.
warehouse String
The warehouse in which to create the Cortex search service.

Package Details

Repository
Snowflake pulumi/pulumi-snowflake
License
Apache-2.0
Notes
This Pulumi package is based on the snowflake Terraform Provider.
Snowflake v1.2.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-snowflake