1. Packages
  2. Packages
  3. Snowflake Provider
  4. API Docs
  5. CortexAgent
Viewing docs for Snowflake v2.17.0
published on Thursday, Jun 25, 2026 by Pulumi
snowflake logo
Viewing docs for Snowflake v2.17.0
published on Thursday, Jun 25, 2026 by Pulumi

    Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to previewFeaturesEnabled field in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.

    Resource used to manage Cortex agent objects. For more information, check Cortex agent documentation.

    Create CortexAgent Resource

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

    Constructor syntax

    new CortexAgent(name: string, args: CortexAgentArgs, opts?: CustomResourceOptions);
    @overload
    def CortexAgent(resource_name: str,
                    args: CortexAgentArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def CortexAgent(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    database: Optional[str] = None,
                    schema: Optional[str] = None,
                    specification: Optional[str] = None,
                    comment: Optional[str] = None,
                    name: Optional[str] = None,
                    profile: Optional[CortexAgentProfileArgs] = None)
    func NewCortexAgent(ctx *Context, name string, args CortexAgentArgs, opts ...ResourceOption) (*CortexAgent, error)
    public CortexAgent(string name, CortexAgentArgs args, CustomResourceOptions? opts = null)
    public CortexAgent(String name, CortexAgentArgs args)
    public CortexAgent(String name, CortexAgentArgs args, CustomResourceOptions options)
    
    type: snowflake:CortexAgent
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "snowflake_cortexagent" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args CortexAgentArgs
    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 CortexAgentArgs
    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 CortexAgentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CortexAgentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CortexAgentArgs
    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 cortexAgentResource = new Snowflake.CortexAgent("cortexAgentResource", new()
    {
        Database = "string",
        Schema = "string",
        Specification = "string",
        Comment = "string",
        Name = "string",
        Profile = new Snowflake.Inputs.CortexAgentProfileArgs
        {
            Avatar = "string",
            Color = "string",
            DisplayName = "string",
        },
    });
    
    example, err := snowflake.NewCortexAgent(ctx, "cortexAgentResource", &snowflake.CortexAgentArgs{
    	Database:      pulumi.String("string"),
    	Schema:        pulumi.String("string"),
    	Specification: pulumi.String("string"),
    	Comment:       pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	Profile: &snowflake.CortexAgentProfileArgs{
    		Avatar:      pulumi.String("string"),
    		Color:       pulumi.String("string"),
    		DisplayName: pulumi.String("string"),
    	},
    })
    
    resource "snowflake_cortexagent" "cortexAgentResource" {
      database      = "string"
      schema        = "string"
      specification = "string"
      comment       = "string"
      name          = "string"
      profile = {
        avatar       = "string"
        color        = "string"
        display_name = "string"
      }
    }
    
    var cortexAgentResource = new CortexAgent("cortexAgentResource", CortexAgentArgs.builder()
        .database("string")
        .schema("string")
        .specification("string")
        .comment("string")
        .name("string")
        .profile(CortexAgentProfileArgs.builder()
            .avatar("string")
            .color("string")
            .displayName("string")
            .build())
        .build());
    
    cortex_agent_resource = snowflake.CortexAgent("cortexAgentResource",
        database="string",
        schema="string",
        specification="string",
        comment="string",
        name="string",
        profile={
            "avatar": "string",
            "color": "string",
            "display_name": "string",
        })
    
    const cortexAgentResource = new snowflake.CortexAgent("cortexAgentResource", {
        database: "string",
        schema: "string",
        specification: "string",
        comment: "string",
        name: "string",
        profile: {
            avatar: "string",
            color: "string",
            displayName: "string",
        },
    });
    
    type: snowflake:CortexAgent
    properties:
        comment: string
        database: string
        name: string
        profile:
            avatar: string
            color: string
            displayName: string
        schema: string
        specification: string
    

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

    Database string
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Schema string
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Specification string
    Specifies a YAML object containing the settings for the Cortex agent.
    Comment string
    Specifies a comment for the Cortex agent.
    Name string
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Profile CortexAgentProfile
    Specifies agent profile information, such as display_name, avatar, and color.
    Database string
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Schema string
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Specification string
    Specifies a YAML object containing the settings for the Cortex agent.
    Comment string
    Specifies a comment for the Cortex agent.
    Name string
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Profile CortexAgentProfileArgs
    Specifies agent profile information, such as display_name, avatar, and color.
    database string
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema string
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    specification string
    Specifies a YAML object containing the settings for the Cortex agent.
    comment string
    Specifies a comment for the Cortex agent.
    name string
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    profile object
    Specifies agent profile information, such as display_name, avatar, and color.
    database String
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema String
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    specification String
    Specifies a YAML object containing the settings for the Cortex agent.
    comment String
    Specifies a comment for the Cortex agent.
    name String
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    profile CortexAgentProfile
    Specifies agent profile information, such as display_name, avatar, and color.
    database string
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema string
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    specification string
    Specifies a YAML object containing the settings for the Cortex agent.
    comment string
    Specifies a comment for the Cortex agent.
    name string
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    profile CortexAgentProfile
    Specifies agent profile information, such as display_name, avatar, and color.
    database str
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema str
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    specification str
    Specifies a YAML object containing the settings for the Cortex agent.
    comment str
    Specifies a comment for the Cortex agent.
    name str
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    profile CortexAgentProfileArgs
    Specifies agent profile information, such as display_name, avatar, and color.
    database String
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    schema String
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    specification String
    Specifies a YAML object containing the settings for the Cortex agent.
    comment String
    Specifies a comment for the Cortex agent.
    name String
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    profile Property Map
    Specifies agent profile information, such as display_name, avatar, and color.

    Outputs

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

    DescribeOutputs List<CortexAgentDescribeOutput>
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    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.
    ShowOutputs List<CortexAgentShowOutput>
    Outputs the result of SHOW AGENTS for this Cortex agent.
    DescribeOutputs []CortexAgentDescribeOutput
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    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.
    ShowOutputs []CortexAgentShowOutput
    Outputs the result of SHOW AGENTS for this Cortex agent.
    describe_outputs list(object)
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    fully_qualified_name 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.
    show_outputs list(object)
    Outputs the result of SHOW AGENTS for this Cortex agent.
    describeOutputs List<CortexAgentDescribeOutput>
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    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.
    showOutputs List<CortexAgentShowOutput>
    Outputs the result of SHOW AGENTS for this Cortex agent.
    describeOutputs CortexAgentDescribeOutput[]
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    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.
    showOutputs CortexAgentShowOutput[]
    Outputs the result of SHOW AGENTS for this Cortex agent.
    describe_outputs Sequence[CortexAgentDescribeOutput]
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    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.
    show_outputs Sequence[CortexAgentShowOutput]
    Outputs the result of SHOW AGENTS for this Cortex agent.
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    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.
    showOutputs List<Property Map>
    Outputs the result of SHOW AGENTS for this Cortex agent.

    Look up Existing CortexAgent Resource

    Get an existing CortexAgent 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?: CortexAgentState, opts?: CustomResourceOptions): CortexAgent
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            comment: Optional[str] = None,
            database: Optional[str] = None,
            describe_outputs: Optional[Sequence[CortexAgentDescribeOutputArgs]] = None,
            fully_qualified_name: Optional[str] = None,
            name: Optional[str] = None,
            profile: Optional[CortexAgentProfileArgs] = None,
            schema: Optional[str] = None,
            show_outputs: Optional[Sequence[CortexAgentShowOutputArgs]] = None,
            specification: Optional[str] = None) -> CortexAgent
    func GetCortexAgent(ctx *Context, name string, id IDInput, state *CortexAgentState, opts ...ResourceOption) (*CortexAgent, error)
    public static CortexAgent Get(string name, Input<string> id, CortexAgentState? state, CustomResourceOptions? opts = null)
    public static CortexAgent get(String name, Output<String> id, CortexAgentState state, CustomResourceOptions options)
    resources:  _:    type: snowflake:CortexAgent    get:      id: ${id}
    import {
      to = snowflake_cortexagent.example
      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:
    Comment string
    Specifies a comment for the Cortex agent.
    Database string
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    DescribeOutputs List<CortexAgentDescribeOutput>
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Profile CortexAgentProfile
    Specifies agent profile information, such as display_name, avatar, and color.
    Schema string
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowOutputs List<CortexAgentShowOutput>
    Outputs the result of SHOW AGENTS for this Cortex agent.
    Specification string
    Specifies a YAML object containing the settings for the Cortex agent.
    Comment string
    Specifies a comment for the Cortex agent.
    Database string
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    DescribeOutputs []CortexAgentDescribeOutputArgs
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    Name string
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Profile CortexAgentProfileArgs
    Specifies agent profile information, such as display_name, avatar, and color.
    Schema string
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    ShowOutputs []CortexAgentShowOutputArgs
    Outputs the result of SHOW AGENTS for this Cortex agent.
    Specification string
    Specifies a YAML object containing the settings for the Cortex agent.
    comment string
    Specifies a comment for the Cortex agent.
    database string
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describe_outputs list(object)
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    fully_qualified_name string
    Fully qualified name of the resource. For more information, see object name resolution.
    name string
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    profile object
    Specifies agent profile information, such as display_name, avatar, and color.
    schema string
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    show_outputs list(object)
    Outputs the result of SHOW AGENTS for this Cortex agent.
    specification string
    Specifies a YAML object containing the settings for the Cortex agent.
    comment String
    Specifies a comment for the Cortex agent.
    database String
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describeOutputs List<CortexAgentDescribeOutput>
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    profile CortexAgentProfile
    Specifies agent profile information, such as display_name, avatar, and color.
    schema String
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs List<CortexAgentShowOutput>
    Outputs the result of SHOW AGENTS for this Cortex agent.
    specification String
    Specifies a YAML object containing the settings for the Cortex agent.
    comment string
    Specifies a comment for the Cortex agent.
    database string
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describeOutputs CortexAgentDescribeOutput[]
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    name string
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    profile CortexAgentProfile
    Specifies agent profile information, such as display_name, avatar, and color.
    schema string
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs CortexAgentShowOutput[]
    Outputs the result of SHOW AGENTS for this Cortex agent.
    specification string
    Specifies a YAML object containing the settings for the Cortex agent.
    comment str
    Specifies a comment for the Cortex agent.
    database str
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describe_outputs Sequence[CortexAgentDescribeOutputArgs]
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    name str
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    profile CortexAgentProfileArgs
    Specifies agent profile information, such as display_name, avatar, and color.
    schema str
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    show_outputs Sequence[CortexAgentShowOutputArgs]
    Outputs the result of SHOW AGENTS for this Cortex agent.
    specification str
    Specifies a YAML object containing the settings for the Cortex agent.
    comment String
    Specifies a comment for the Cortex agent.
    database String
    The database in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    describeOutputs List<Property Map>
    Outputs the result of DESCRIBE AGENT for this Cortex agent.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    name String
    Specifies the identifier for the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    profile Property Map
    Specifies agent profile information, such as display_name, avatar, and color.
    schema String
    The schema in which to create the Cortex agent. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    showOutputs List<Property Map>
    Outputs the result of SHOW AGENTS for this Cortex agent.
    specification String
    Specifies a YAML object containing the settings for the Cortex agent.

    Supporting Types

    CortexAgentDescribeOutput, CortexAgentDescribeOutputArgs

    CortexAgentDescribeOutputProfile, CortexAgentDescribeOutputProfileArgs

    Avatar string
    Color string
    DisplayName string
    Avatar string
    Color string
    DisplayName string
    avatar string
    color string
    display_name string
    avatar String
    color String
    displayName String
    avatar string
    color string
    displayName string
    avatar String
    color String
    displayName String

    CortexAgentProfile, CortexAgentProfileArgs

    Avatar string
    Specifies an avatar image file name or identifier.
    Color string
    Specifies a color theme for the Cortex agent.
    DisplayName string
    Specifies a display name for the Cortex agent.
    Avatar string
    Specifies an avatar image file name or identifier.
    Color string
    Specifies a color theme for the Cortex agent.
    DisplayName string
    Specifies a display name for the Cortex agent.
    avatar string
    Specifies an avatar image file name or identifier.
    color string
    Specifies a color theme for the Cortex agent.
    display_name string
    Specifies a display name for the Cortex agent.
    avatar String
    Specifies an avatar image file name or identifier.
    color String
    Specifies a color theme for the Cortex agent.
    displayName String
    Specifies a display name for the Cortex agent.
    avatar string
    Specifies an avatar image file name or identifier.
    color string
    Specifies a color theme for the Cortex agent.
    displayName string
    Specifies a display name for the Cortex agent.
    avatar str
    Specifies an avatar image file name or identifier.
    color str
    Specifies a color theme for the Cortex agent.
    display_name str
    Specifies a display name for the Cortex agent.
    avatar String
    Specifies an avatar image file name or identifier.
    color String
    Specifies a color theme for the Cortex agent.
    displayName String
    Specifies a display name for the Cortex agent.

    CortexAgentShowOutput, CortexAgentShowOutputArgs

    CortexAgentShowOutputProfile, CortexAgentShowOutputProfileArgs

    Avatar string
    Color string
    DisplayName string
    Avatar string
    Color string
    DisplayName string
    avatar string
    color string
    display_name string
    avatar String
    color String
    displayName String
    avatar string
    color string
    displayName string
    avatar String
    color String
    displayName String

    Import

    $ pulumi import snowflake:index/cortexAgent:CortexAgent example '"<database_name>"."<schema_name>"."<cortex_agent_name>"'
    

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

    Package Details

    Repository
    Snowflake pulumi/pulumi-snowflake
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the snowflake Terraform Provider.
    snowflake logo
    Viewing docs for Snowflake v2.17.0
    published on Thursday, Jun 25, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial