Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Snowflake Provider
  3. API Docs
  4. FunctionPython
Snowflake v1.1.0 published on Monday, Jan 13, 2025 by Pulumi
pulumi/pulumi-snowflake

snowflake.FunctionPython

Explore with Pulumi AI

snowflake logo
Snowflake v1.1.0 published on Monday, Jan 13, 2025 by Pulumi
pulumi/pulumi-snowflake

    Import

    $ pulumi import snowflake:index/functionPython:FunctionPython example '"<database_name>"."<schema_name>"."<function_name>"(varchar, varchar, varchar)'

    Note: Snowflake is not returning all information needed to populate the state correctly after import (e.g. data types with attributes like NUMBER(32, 10) are returned as NUMBER, default values for arguments are not returned at all).

    Also, ALTER for functions is very limited so most of the attributes on this resource are marked as force new. Because of that, in multiple situations plan won’t be empty after importing and manual state operations may be required.

    Create FunctionPython Resource

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

    Constructor syntax

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

@overload
def FunctionPython(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   handler: Optional[str] = None,
                   schema: Optional[str] = None,
                   database: Optional[str] = None,
                   runtime_version: Optional[str] = None,
                   return_type: Optional[str] = None,
                   log_level: Optional[str] = None,
                   name: Optional[str] = None,
                   imports: Optional[Sequence[FunctionPythonImportArgs]] = None,
                   is_aggregate: Optional[str] = None,
                   is_secure: Optional[str] = None,
                   arguments: Optional[Sequence[FunctionPythonArgumentArgs]] = None,
                   metric_level: Optional[str] = None,
                   function_definition: Optional[str] = None,
                   null_input_behavior: Optional[str] = None,
                   packages: Optional[Sequence[str]] = None,
                   return_results_behavior: Optional[str] = None,
                   external_access_integrations: Optional[Sequence[str]] = None,
                   enable_console_output: Optional[bool] = None,
                   comment: Optional[str] = None,
                   secrets: Optional[Sequence[FunctionPythonSecretArgs]] = None,
                   trace_level: Optional[str] = None)
    func NewFunctionPython(ctx *Context, name string, args FunctionPythonArgs, opts ...ResourceOption) (*FunctionPython, error)
    public FunctionPython(string name, FunctionPythonArgs args, CustomResourceOptions? opts = null)
    public FunctionPython(String name, FunctionPythonArgs args)
public FunctionPython(String name, FunctionPythonArgs args, CustomResourceOptions options)

    type: snowflake:FunctionPython
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 FunctionPythonArgs
    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 FunctionPythonArgs
    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 FunctionPythonArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FunctionPythonArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FunctionPythonArgs
    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 functionPythonResource = new Snowflake.FunctionPython("functionPythonResource", new()
{
    Handler = "string",
    Schema = "string",
    Database = "string",
    RuntimeVersion = "string",
    ReturnType = "string",
    LogLevel = "string",
    Name = "string",
    Imports = new[]
    {
        new Snowflake.Inputs.FunctionPythonImportArgs
        {
            PathOnStage = "string",
            StageLocation = "string",
        },
    },
    IsAggregate = "string",
    IsSecure = "string",
    Arguments = new[]
    {
        new Snowflake.Inputs.FunctionPythonArgumentArgs
        {
            ArgDataType = "string",
            ArgName = "string",
            ArgDefaultValue = "string",
        },
    },
    MetricLevel = "string",
    FunctionDefinition = "string",
    NullInputBehavior = "string",
    Packages = new[]
    {
        "string",
    },
    ReturnResultsBehavior = "string",
    ExternalAccessIntegrations = new[]
    {
        "string",
    },
    EnableConsoleOutput = false,
    Comment = "string",
    Secrets = new[]
    {
        new Snowflake.Inputs.FunctionPythonSecretArgs
        {
            SecretId = "string",
            SecretVariableName = "string",
        },
    },
    TraceLevel = "string",
});

    example, err := snowflake.NewFunctionPython(ctx, "functionPythonResource", &snowflake.FunctionPythonArgs{
	Handler:        pulumi.String("string"),
	Schema:         pulumi.String("string"),
	Database:       pulumi.String("string"),
	RuntimeVersion: pulumi.String("string"),
	ReturnType:     pulumi.String("string"),
	LogLevel:       pulumi.String("string"),
	Name:           pulumi.String("string"),
	Imports: snowflake.FunctionPythonImportArray{
		&snowflake.FunctionPythonImportArgs{
			PathOnStage:   pulumi.String("string"),
			StageLocation: pulumi.String("string"),
		},
	},
	IsAggregate: pulumi.String("string"),
	IsSecure:    pulumi.String("string"),
	Arguments: snowflake.FunctionPythonArgumentArray{
		&snowflake.FunctionPythonArgumentArgs{
			ArgDataType:     pulumi.String("string"),
			ArgName:         pulumi.String("string"),
			ArgDefaultValue: pulumi.String("string"),
		},
	},
	MetricLevel:        pulumi.String("string"),
	FunctionDefinition: pulumi.String("string"),
	NullInputBehavior:  pulumi.String("string"),
	Packages: pulumi.StringArray{
		pulumi.String("string"),
	},
	ReturnResultsBehavior: pulumi.String("string"),
	ExternalAccessIntegrations: pulumi.StringArray{
		pulumi.String("string"),
	},
	EnableConsoleOutput: pulumi.Bool(false),
	Comment:             pulumi.String("string"),
	Secrets: snowflake.FunctionPythonSecretArray{
		&snowflake.FunctionPythonSecretArgs{
			SecretId:           pulumi.String("string"),
			SecretVariableName: pulumi.String("string"),
		},
	},
	TraceLevel: pulumi.String("string"),
})

    var functionPythonResource = new FunctionPython("functionPythonResource", FunctionPythonArgs.builder()
    .handler("string")
    .schema("string")
    .database("string")
    .runtimeVersion("string")
    .returnType("string")
    .logLevel("string")
    .name("string")
    .imports(FunctionPythonImportArgs.builder()
        .pathOnStage("string")
        .stageLocation("string")
        .build())
    .isAggregate("string")
    .isSecure("string")
    .arguments(FunctionPythonArgumentArgs.builder()
        .argDataType("string")
        .argName("string")
        .argDefaultValue("string")
        .build())
    .metricLevel("string")
    .functionDefinition("string")
    .nullInputBehavior("string")
    .packages("string")
    .returnResultsBehavior("string")
    .externalAccessIntegrations("string")
    .enableConsoleOutput(false)
    .comment("string")
    .secrets(FunctionPythonSecretArgs.builder()
        .secretId("string")
        .secretVariableName("string")
        .build())
    .traceLevel("string")
    .build());

    function_python_resource = snowflake.FunctionPython("functionPythonResource",
    handler="string",
    schema="string",
    database="string",
    runtime_version="string",
    return_type="string",
    log_level="string",
    name="string",
    imports=[{
        "path_on_stage": "string",
        "stage_location": "string",
    }],
    is_aggregate="string",
    is_secure="string",
    arguments=[{
        "arg_data_type": "string",
        "arg_name": "string",
        "arg_default_value": "string",
    }],
    metric_level="string",
    function_definition="string",
    null_input_behavior="string",
    packages=["string"],
    return_results_behavior="string",
    external_access_integrations=["string"],
    enable_console_output=False,
    comment="string",
    secrets=[{
        "secret_id": "string",
        "secret_variable_name": "string",
    }],
    trace_level="string")

    const functionPythonResource = new snowflake.FunctionPython("functionPythonResource", {
    handler: "string",
    schema: "string",
    database: "string",
    runtimeVersion: "string",
    returnType: "string",
    logLevel: "string",
    name: "string",
    imports: [{
        pathOnStage: "string",
        stageLocation: "string",
    }],
    isAggregate: "string",
    isSecure: "string",
    arguments: [{
        argDataType: "string",
        argName: "string",
        argDefaultValue: "string",
    }],
    metricLevel: "string",
    functionDefinition: "string",
    nullInputBehavior: "string",
    packages: ["string"],
    returnResultsBehavior: "string",
    externalAccessIntegrations: ["string"],
    enableConsoleOutput: false,
    comment: "string",
    secrets: [{
        secretId: "string",
        secretVariableName: "string",
    }],
    traceLevel: "string",
});

    type: snowflake:FunctionPython
properties:
    arguments:
        - argDataType: string
          argDefaultValue: string
          argName: string
    comment: string
    database: string
    enableConsoleOutput: false
    externalAccessIntegrations:
        - string
    functionDefinition: string
    handler: string
    imports:
        - pathOnStage: string
          stageLocation: string
    isAggregate: string
    isSecure: string
    logLevel: string
    metricLevel: string
    name: string
    nullInputBehavior: string
    packages:
        - string
    returnResultsBehavior: string
    returnType: string
    runtimeVersion: string
    schema: string
    secrets:
        - secretId: string
          secretVariableName: string
    traceLevel: string

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

    Database string
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Handler string
    The name of the handler function or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a function name. If the handler code is in-line with the CREATE FUNCTION statement, you can use the function name alone. When the handler code is referenced at a stage, this value should be qualified with the module name, as in the following form: my_module.my_function. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    ReturnType string
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    RuntimeVersion string
    Specifies the Python version to use. The supported versions of Python are: 3.9, 3.10, and 3.11.
    Schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Arguments List<FunctionPythonArgument>
    List of the arguments for the function. Consult the docs for more details.
    Comment string
    Specifies a comment for the function.
    EnableConsoleOutput bool
    Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
    ExternalAccessIntegrations List<string>
    The names of external access integrations needed in order for this function’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
    FunctionDefinition string
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be Python source code. For more information, see Introduction to Python UDFs. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
    Imports List<FunctionPythonImport>
    The location (stage), path, and name of the file(s) to import. A file can be a .py file or another type of file. Python UDFs can also read non-Python files, such as text files. For an example, see Reading a file. Consult the docs.
    IsAggregate string
    Specifies that the function is an aggregate function. For more information about user-defined aggregate functions, see Python user-defined aggregate functions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    IsSecure string
    LogLevel string
    LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
    MetricLevel string
    METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
    Name string
    The name of the function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    NullInputBehavior string
    Specifies the behavior of the function when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT.
    Packages List<string>
    The name and version number of packages required as dependencies. The value should be of the form package_name==version_number.
    ReturnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    Secrets List<FunctionPythonSecret>
    Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
    TraceLevel string
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    Database string
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Handler string
    The name of the handler function or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a function name. If the handler code is in-line with the CREATE FUNCTION statement, you can use the function name alone. When the handler code is referenced at a stage, this value should be qualified with the module name, as in the following form: my_module.my_function. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    ReturnType string
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    RuntimeVersion string
    Specifies the Python version to use. The supported versions of Python are: 3.9, 3.10, and 3.11.
    Schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Arguments []FunctionPythonArgumentArgs
    List of the arguments for the function. Consult the docs for more details.
    Comment string
    Specifies a comment for the function.
    EnableConsoleOutput bool
    Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
    ExternalAccessIntegrations []string
    The names of external access integrations needed in order for this function’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
    FunctionDefinition string
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be Python source code. For more information, see Introduction to Python UDFs. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
    Imports []FunctionPythonImportArgs
    The location (stage), path, and name of the file(s) to import. A file can be a .py file or another type of file. Python UDFs can also read non-Python files, such as text files. For an example, see Reading a file. Consult the docs.
    IsAggregate string
    Specifies that the function is an aggregate function. For more information about user-defined aggregate functions, see Python user-defined aggregate functions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    IsSecure string
    LogLevel string
    LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
    MetricLevel string
    METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
    Name string
    The name of the function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    NullInputBehavior string
    Specifies the behavior of the function when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT.
    Packages []string
    The name and version number of packages required as dependencies. The value should be of the form package_name==version_number.
    ReturnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    Secrets []FunctionPythonSecretArgs
    Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
    TraceLevel string
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    database String
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    handler String
    The name of the handler function or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a function name. If the handler code is in-line with the CREATE FUNCTION statement, you can use the function name alone. When the handler code is referenced at a stage, this value should be qualified with the module name, as in the following form: my_module.my_function. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    returnType String
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    runtimeVersion String
    Specifies the Python version to use. The supported versions of Python are: 3.9, 3.10, and 3.11.
    schema String
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    arguments List<FunctionPythonArgument>
    List of the arguments for the function. Consult the docs for more details.
    comment String
    Specifies a comment for the function.
    enableConsoleOutput Boolean
    Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
    externalAccessIntegrations List<String>
    The names of external access integrations needed in order for this function’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
    functionDefinition String
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be Python source code. For more information, see Introduction to Python UDFs. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
    imports List<FunctionPythonImport>
    The location (stage), path, and name of the file(s) to import. A file can be a .py file or another type of file. Python UDFs can also read non-Python files, such as text files. For an example, see Reading a file. Consult the docs.
    isAggregate String
    Specifies that the function is an aggregate function. For more information about user-defined aggregate functions, see Python user-defined aggregate functions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    isSecure String
    logLevel String
    LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
    metricLevel String
    METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
    name String
    The name of the function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    nullInputBehavior String
    Specifies the behavior of the function when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT.
    packages List<String>
    The name and version number of packages required as dependencies. The value should be of the form package_name==version_number.
    returnResultsBehavior String
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    secrets List<FunctionPythonSecret>
    Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
    traceLevel String
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    database string
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    handler string
    The name of the handler function or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a function name. If the handler code is in-line with the CREATE FUNCTION statement, you can use the function name alone. When the handler code is referenced at a stage, this value should be qualified with the module name, as in the following form: my_module.my_function. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    returnType string
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    runtimeVersion string
    Specifies the Python version to use. The supported versions of Python are: 3.9, 3.10, and 3.11.
    schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    arguments FunctionPythonArgument[]
    List of the arguments for the function. Consult the docs for more details.
    comment string
    Specifies a comment for the function.
    enableConsoleOutput boolean
    Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
    externalAccessIntegrations string[]
    The names of external access integrations needed in order for this function’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
    functionDefinition string
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be Python source code. For more information, see Introduction to Python UDFs. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
    imports FunctionPythonImport[]
    The location (stage), path, and name of the file(s) to import. A file can be a .py file or another type of file. Python UDFs can also read non-Python files, such as text files. For an example, see Reading a file. Consult the docs.
    isAggregate string
    Specifies that the function is an aggregate function. For more information about user-defined aggregate functions, see Python user-defined aggregate functions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    isSecure string
    logLevel string
    LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
    metricLevel string
    METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
    name string
    The name of the function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    nullInputBehavior string
    Specifies the behavior of the function when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT.
    packages string[]
    The name and version number of packages required as dependencies. The value should be of the form package_name==version_number.
    returnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    secrets FunctionPythonSecret[]
    Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
    traceLevel string
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    database str
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    handler str
    The name of the handler function or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a function name. If the handler code is in-line with the CREATE FUNCTION statement, you can use the function name alone. When the handler code is referenced at a stage, this value should be qualified with the module name, as in the following form: my_module.my_function. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    return_type str
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    runtime_version str
    Specifies the Python version to use. The supported versions of Python are: 3.9, 3.10, and 3.11.
    schema str
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    arguments Sequence[FunctionPythonArgumentArgs]
    List of the arguments for the function. Consult the docs for more details.
    comment str
    Specifies a comment for the function.
    enable_console_output bool
    Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
    external_access_integrations Sequence[str]
    The names of external access integrations needed in order for this function’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
    function_definition str
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be Python source code. For more information, see Introduction to Python UDFs. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
    imports Sequence[FunctionPythonImportArgs]
    The location (stage), path, and name of the file(s) to import. A file can be a .py file or another type of file. Python UDFs can also read non-Python files, such as text files. For an example, see Reading a file. Consult the docs.
    is_aggregate str
    Specifies that the function is an aggregate function. For more information about user-defined aggregate functions, see Python user-defined aggregate functions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    is_secure str
    log_level str
    LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
    metric_level str
    METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
    name str
    The name of the function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    null_input_behavior str
    Specifies the behavior of the function when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT.
    packages Sequence[str]
    The name and version number of packages required as dependencies. The value should be of the form package_name==version_number.
    return_results_behavior str
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    secrets Sequence[FunctionPythonSecretArgs]
    Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
    trace_level str
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    database String
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    handler String
    The name of the handler function or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a function name. If the handler code is in-line with the CREATE FUNCTION statement, you can use the function name alone. When the handler code is referenced at a stage, this value should be qualified with the module name, as in the following form: my_module.my_function. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    returnType String
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    runtimeVersion String
    Specifies the Python version to use. The supported versions of Python are: 3.9, 3.10, and 3.11.
    schema String
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    arguments List<Property Map>
    List of the arguments for the function. Consult the docs for more details.
    comment String
    Specifies a comment for the function.
    enableConsoleOutput Boolean
    Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
    externalAccessIntegrations List<String>
    The names of external access integrations needed in order for this function’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
    functionDefinition String
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be Python source code. For more information, see Introduction to Python UDFs. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
    imports List<Property Map>
    The location (stage), path, and name of the file(s) to import. A file can be a .py file or another type of file. Python UDFs can also read non-Python files, such as text files. For an example, see Reading a file. Consult the docs.
    isAggregate String
    Specifies that the function is an aggregate function. For more information about user-defined aggregate functions, see Python user-defined aggregate functions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    isSecure String
    logLevel String
    LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
    metricLevel String
    METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
    name String
    The name of the function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    nullInputBehavior String
    Specifies the behavior of the function when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT.
    packages List<String>
    The name and version number of packages required as dependencies. The value should be of the form package_name==version_number.
    returnResultsBehavior String
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    secrets List<Property Map>
    Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
    traceLevel String
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.

    Outputs

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

    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    FunctionLanguage string
    Specifies language for the user. Used to detect external changes.
    Id string
    The provider-assigned unique ID for this managed resource.
    Parameters List<FunctionPythonParameter>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    ShowOutputs List<FunctionPythonShowOutput>
    Outputs the result of SHOW FUNCTION for the given function.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    FunctionLanguage string
    Specifies language for the user. Used to detect external changes.
    Id string
    The provider-assigned unique ID for this managed resource.
    Parameters []FunctionPythonParameter
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    ShowOutputs []FunctionPythonShowOutput
    Outputs the result of SHOW FUNCTION for the given function.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    functionLanguage String
    Specifies language for the user. Used to detect external changes.
    id String
    The provider-assigned unique ID for this managed resource.
    parameters List<FunctionPythonParameter>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    showOutputs List<FunctionPythonShowOutput>
    Outputs the result of SHOW FUNCTION for the given function.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    functionLanguage string
    Specifies language for the user. Used to detect external changes.
    id string
    The provider-assigned unique ID for this managed resource.
    parameters FunctionPythonParameter[]
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    showOutputs FunctionPythonShowOutput[]
    Outputs the result of SHOW FUNCTION for the given function.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    function_language str
    Specifies language for the user. Used to detect external changes.
    id str
    The provider-assigned unique ID for this managed resource.
    parameters Sequence[FunctionPythonParameter]
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    show_outputs Sequence[FunctionPythonShowOutput]
    Outputs the result of SHOW FUNCTION for the given function.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    functionLanguage String
    Specifies language for the user. Used to detect external changes.
    id String
    The provider-assigned unique ID for this managed resource.
    parameters List<Property Map>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    showOutputs List<Property Map>
    Outputs the result of SHOW FUNCTION for the given function.

    Look up Existing FunctionPython Resource

    Get an existing FunctionPython 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?: FunctionPythonState, opts?: CustomResourceOptions): FunctionPython
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arguments: Optional[Sequence[FunctionPythonArgumentArgs]] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        enable_console_output: Optional[bool] = None,
        external_access_integrations: Optional[Sequence[str]] = None,
        fully_qualified_name: Optional[str] = None,
        function_definition: Optional[str] = None,
        function_language: Optional[str] = None,
        handler: Optional[str] = None,
        imports: Optional[Sequence[FunctionPythonImportArgs]] = None,
        is_aggregate: Optional[str] = None,
        is_secure: Optional[str] = None,
        log_level: Optional[str] = None,
        metric_level: Optional[str] = None,
        name: Optional[str] = None,
        null_input_behavior: Optional[str] = None,
        packages: Optional[Sequence[str]] = None,
        parameters: Optional[Sequence[FunctionPythonParameterArgs]] = None,
        return_results_behavior: Optional[str] = None,
        return_type: Optional[str] = None,
        runtime_version: Optional[str] = None,
        schema: Optional[str] = None,
        secrets: Optional[Sequence[FunctionPythonSecretArgs]] = None,
        show_outputs: Optional[Sequence[FunctionPythonShowOutputArgs]] = None,
        trace_level: Optional[str] = None) -> FunctionPython
    func GetFunctionPython(ctx *Context, name string, id IDInput, state *FunctionPythonState, opts ...ResourceOption) (*FunctionPython, error)
    public static FunctionPython Get(string name, Input<string> id, FunctionPythonState? state, CustomResourceOptions? opts = null)
    public static FunctionPython get(String name, Output<String> id, FunctionPythonState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Arguments List<FunctionPythonArgument>
    List of the arguments for the function. Consult the docs for more details.
    Comment string
    Specifies a comment for the function.
    Database string
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    EnableConsoleOutput bool
    Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
    ExternalAccessIntegrations List<string>
    The names of external access integrations needed in order for this function’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    FunctionDefinition string
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be Python source code. For more information, see Introduction to Python UDFs. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
    FunctionLanguage string
    Specifies language for the user. Used to detect external changes.
    Handler string
    The name of the handler function or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a function name. If the handler code is in-line with the CREATE FUNCTION statement, you can use the function name alone. When the handler code is referenced at a stage, this value should be qualified with the module name, as in the following form: my_module.my_function. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    Imports List<FunctionPythonImport>
    The location (stage), path, and name of the file(s) to import. A file can be a .py file or another type of file. Python UDFs can also read non-Python files, such as text files. For an example, see Reading a file. Consult the docs.
    IsAggregate string
    Specifies that the function is an aggregate function. For more information about user-defined aggregate functions, see Python user-defined aggregate functions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    IsSecure string
    LogLevel string
    LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
    MetricLevel string
    METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
    Name string
    The name of the function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    NullInputBehavior string
    Specifies the behavior of the function when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT.
    Packages List<string>
    The name and version number of packages required as dependencies. The value should be of the form package_name==version_number.
    Parameters List<FunctionPythonParameter>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    ReturnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    ReturnType string
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    RuntimeVersion string
    Specifies the Python version to use. The supported versions of Python are: 3.9, 3.10, and 3.11.
    Schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Secrets List<FunctionPythonSecret>
    Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
    ShowOutputs List<FunctionPythonShowOutput>
    Outputs the result of SHOW FUNCTION for the given function.
    TraceLevel string
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    Arguments []FunctionPythonArgumentArgs
    List of the arguments for the function. Consult the docs for more details.
    Comment string
    Specifies a comment for the function.
    Database string
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    EnableConsoleOutput bool
    Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
    ExternalAccessIntegrations []string
    The names of external access integrations needed in order for this function’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
    FullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    FunctionDefinition string
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be Python source code. For more information, see Introduction to Python UDFs. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
    FunctionLanguage string
    Specifies language for the user. Used to detect external changes.
    Handler string
    The name of the handler function or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a function name. If the handler code is in-line with the CREATE FUNCTION statement, you can use the function name alone. When the handler code is referenced at a stage, this value should be qualified with the module name, as in the following form: my_module.my_function. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    Imports []FunctionPythonImportArgs
    The location (stage), path, and name of the file(s) to import. A file can be a .py file or another type of file. Python UDFs can also read non-Python files, such as text files. For an example, see Reading a file. Consult the docs.
    IsAggregate string
    Specifies that the function is an aggregate function. For more information about user-defined aggregate functions, see Python user-defined aggregate functions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    IsSecure string
    LogLevel string
    LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
    MetricLevel string
    METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
    Name string
    The name of the function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    NullInputBehavior string
    Specifies the behavior of the function when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT.
    Packages []string
    The name and version number of packages required as dependencies. The value should be of the form package_name==version_number.
    Parameters []FunctionPythonParameterArgs
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    ReturnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    ReturnType string
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    RuntimeVersion string
    Specifies the Python version to use. The supported versions of Python are: 3.9, 3.10, and 3.11.
    Schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Secrets []FunctionPythonSecretArgs
    Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
    ShowOutputs []FunctionPythonShowOutputArgs
    Outputs the result of SHOW FUNCTION for the given function.
    TraceLevel string
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    arguments List<FunctionPythonArgument>
    List of the arguments for the function. Consult the docs for more details.
    comment String
    Specifies a comment for the function.
    database String
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    enableConsoleOutput Boolean
    Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
    externalAccessIntegrations List<String>
    The names of external access integrations needed in order for this function’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    functionDefinition String
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be Python source code. For more information, see Introduction to Python UDFs. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
    functionLanguage String
    Specifies language for the user. Used to detect external changes.
    handler String
    The name of the handler function or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a function name. If the handler code is in-line with the CREATE FUNCTION statement, you can use the function name alone. When the handler code is referenced at a stage, this value should be qualified with the module name, as in the following form: my_module.my_function. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    imports List<FunctionPythonImport>
    The location (stage), path, and name of the file(s) to import. A file can be a .py file or another type of file. Python UDFs can also read non-Python files, such as text files. For an example, see Reading a file. Consult the docs.
    isAggregate String
    Specifies that the function is an aggregate function. For more information about user-defined aggregate functions, see Python user-defined aggregate functions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    isSecure String
    logLevel String
    LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
    metricLevel String
    METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
    name String
    The name of the function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    nullInputBehavior String
    Specifies the behavior of the function when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT.
    packages List<String>
    The name and version number of packages required as dependencies. The value should be of the form package_name==version_number.
    parameters List<FunctionPythonParameter>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    returnResultsBehavior String
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    returnType String
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    runtimeVersion String
    Specifies the Python version to use. The supported versions of Python are: 3.9, 3.10, and 3.11.
    schema String
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    secrets List<FunctionPythonSecret>
    Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
    showOutputs List<FunctionPythonShowOutput>
    Outputs the result of SHOW FUNCTION for the given function.
    traceLevel String
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    arguments FunctionPythonArgument[]
    List of the arguments for the function. Consult the docs for more details.
    comment string
    Specifies a comment for the function.
    database string
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    enableConsoleOutput boolean
    Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
    externalAccessIntegrations string[]
    The names of external access integrations needed in order for this function’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
    fullyQualifiedName string
    Fully qualified name of the resource. For more information, see object name resolution.
    functionDefinition string
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be Python source code. For more information, see Introduction to Python UDFs. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
    functionLanguage string
    Specifies language for the user. Used to detect external changes.
    handler string
    The name of the handler function or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a function name. If the handler code is in-line with the CREATE FUNCTION statement, you can use the function name alone. When the handler code is referenced at a stage, this value should be qualified with the module name, as in the following form: my_module.my_function. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    imports FunctionPythonImport[]
    The location (stage), path, and name of the file(s) to import. A file can be a .py file or another type of file. Python UDFs can also read non-Python files, such as text files. For an example, see Reading a file. Consult the docs.
    isAggregate string
    Specifies that the function is an aggregate function. For more information about user-defined aggregate functions, see Python user-defined aggregate functions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    isSecure string
    logLevel string
    LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
    metricLevel string
    METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
    name string
    The name of the function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    nullInputBehavior string
    Specifies the behavior of the function when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT.
    packages string[]
    The name and version number of packages required as dependencies. The value should be of the form package_name==version_number.
    parameters FunctionPythonParameter[]
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    returnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    returnType string
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    runtimeVersion string
    Specifies the Python version to use. The supported versions of Python are: 3.9, 3.10, and 3.11.
    schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    secrets FunctionPythonSecret[]
    Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
    showOutputs FunctionPythonShowOutput[]
    Outputs the result of SHOW FUNCTION for the given function.
    traceLevel string
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    arguments Sequence[FunctionPythonArgumentArgs]
    List of the arguments for the function. Consult the docs for more details.
    comment str
    Specifies a comment for the function.
    database str
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    enable_console_output bool
    Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
    external_access_integrations Sequence[str]
    The names of external access integrations needed in order for this function’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
    fully_qualified_name str
    Fully qualified name of the resource. For more information, see object name resolution.
    function_definition str
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be Python source code. For more information, see Introduction to Python UDFs. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
    function_language str
    Specifies language for the user. Used to detect external changes.
    handler str
    The name of the handler function or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a function name. If the handler code is in-line with the CREATE FUNCTION statement, you can use the function name alone. When the handler code is referenced at a stage, this value should be qualified with the module name, as in the following form: my_module.my_function. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    imports Sequence[FunctionPythonImportArgs]
    The location (stage), path, and name of the file(s) to import. A file can be a .py file or another type of file. Python UDFs can also read non-Python files, such as text files. For an example, see Reading a file. Consult the docs.
    is_aggregate str
    Specifies that the function is an aggregate function. For more information about user-defined aggregate functions, see Python user-defined aggregate functions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    is_secure str
    log_level str
    LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
    metric_level str
    METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
    name str
    The name of the function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    null_input_behavior str
    Specifies the behavior of the function when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT.
    packages Sequence[str]
    The name and version number of packages required as dependencies. The value should be of the form package_name==version_number.
    parameters Sequence[FunctionPythonParameterArgs]
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    return_results_behavior str
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    return_type str
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    runtime_version str
    Specifies the Python version to use. The supported versions of Python are: 3.9, 3.10, and 3.11.
    schema str
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    secrets Sequence[FunctionPythonSecretArgs]
    Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
    show_outputs Sequence[FunctionPythonShowOutputArgs]
    Outputs the result of SHOW FUNCTION for the given function.
    trace_level str
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    arguments List<Property Map>
    List of the arguments for the function. Consult the docs for more details.
    comment String
    Specifies a comment for the function.
    database String
    The database in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    enableConsoleOutput Boolean
    Enable stdout/stderr fast path logging for anonyous stored procs. This is a public parameter (similar to LOGLEVEL). For more information, check CONSOLE_OUTPUT docsENABLE.
    externalAccessIntegrations List<String>
    The names of external access integrations needed in order for this function’s handler code to access external networks. An external access integration specifies network rules and secrets that specify external locations and credentials (if any) allowed for use by handler code when making requests of an external network, such as an external REST API.
    fullyQualifiedName String
    Fully qualified name of the resource. For more information, see object name resolution.
    functionDefinition String
    Defines the handler code executed when the UDF is called. Wrapping $$ signs are added by the provider automatically; do not include them. The function_definition value must be Python source code. For more information, see Introduction to Python UDFs. To mitigate permadiff on this field, the provider replaces blank characters with a space. This can lead to false positives in cases where a change in case or run of whitespace is semantically significant.
    functionLanguage String
    Specifies language for the user. Used to detect external changes.
    handler String
    The name of the handler function or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a function name. If the handler code is in-line with the CREATE FUNCTION statement, you can use the function name alone. When the handler code is referenced at a stage, this value should be qualified with the module name, as in the following form: my_module.my_function. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    imports List<Property Map>
    The location (stage), path, and name of the file(s) to import. A file can be a .py file or another type of file. Python UDFs can also read non-Python files, such as text files. For an example, see Reading a file. Consult the docs.
    isAggregate String
    Specifies that the function is an aggregate function. For more information about user-defined aggregate functions, see Python user-defined aggregate functions. Available options are: "true" or "false". When the value is not set in the configuration the provider will put "default" there which means to use the Snowflake default for this value.
    isSecure String
    logLevel String
    LOG*LEVEL to use when filtering events For more information, check LOG*LEVEL docs.
    metricLevel String
    METRIC*LEVEL value to control whether to emit metrics to Event Table For more information, check METRIC*LEVEL docs.
    name String
    The name of the function; the identifier does not need to be unique for the schema in which the function is created because UDFs are identified and resolved by the combination of the name and argument types. Check the docs. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    nullInputBehavior String
    Specifies the behavior of the function when called with null inputs. Valid values are (case-insensitive): CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT.
    packages List<String>
    The name and version number of packages required as dependencies. The value should be of the form package_name==version_number.
    parameters List<Property Map>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    returnResultsBehavior String
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    returnType String
    Specifies the results returned by the UDF, which determines the UDF type. Use <result_data_type> to create a scalar UDF that returns a single value with the specified data type. Use TABLE (col_name col_data_type, ...) to creates a table UDF that returns tabular results with the specified table column(s) and column type(s). For the details, consult the docs.
    runtimeVersion String
    Specifies the Python version to use. The supported versions of Python are: 3.9, 3.10, and 3.11.
    schema String
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    secrets List<Property Map>
    Assigns the names of secrets to variables so that you can use the variables to reference the secrets when retrieving information from secrets in handler code. Secrets you specify here must be allowed by the external access integration specified as a value of this CREATE FUNCTION command’s EXTERNALACCESSINTEGRATIONS parameter.
    showOutputs List<Property Map>
    Outputs the result of SHOW FUNCTION for the given function.
    traceLevel String
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.

    Supporting Types

    FunctionPythonArgument, FunctionPythonArgumentArgs

    ArgDataType string
    The argument type.
    ArgName string
    The argument name. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the function definition.
    ArgDefaultValue string
    ArgDataType string
    The argument type.
    ArgName string
    The argument name. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the function definition.
    ArgDefaultValue string
    argDataType String
    The argument type.
    argName String
    The argument name. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the function definition.
    argDefaultValue String
    argDataType string
    The argument type.
    argName string
    The argument name. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the function definition.
    argDefaultValue string
    arg_data_type str
    The argument type.
    arg_name str
    The argument name. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the function definition.
    arg_default_value str
    argDataType String
    The argument type.
    argName String
    The argument name. The provider wraps it in double quotes by default, so be aware of that while referencing the argument in the function definition.
    argDefaultValue String

    FunctionPythonImport, FunctionPythonImportArgs

    PathOnStage string
    Path for import on stage, without the leading /.
    StageLocation string
    PathOnStage string
    Path for import on stage, without the leading /.
    StageLocation string
    pathOnStage String
    Path for import on stage, without the leading /.
    stageLocation String
    pathOnStage string
    Path for import on stage, without the leading /.
    stageLocation string
    path_on_stage str
    Path for import on stage, without the leading /.
    stage_location str
    pathOnStage String
    Path for import on stage, without the leading /.
    stageLocation String

    FunctionPythonParameter, FunctionPythonParameterArgs

    FunctionPythonParameterEnableConsoleOutput, FunctionPythonParameterEnableConsoleOutputArgs

    Default string
    Description string
    Key string
    Level string
    Value string
    Default string
    Description string
    Key string
    Level string
    Value string
    default_ String
    description String
    key String
    level String
    value String
    default string
    description string
    key string
    level string
    value string
    default String
    description String
    key String
    level String
    value String

    FunctionPythonParameterLogLevel, FunctionPythonParameterLogLevelArgs

    Default string
    Description string
    Key string
    Level string
    Value string
    Default string
    Description string
    Key string
    Level string
    Value string
    default_ String
    description String
    key String
    level String
    value String
    default string
    description string
    key string
    level string
    value string
    default String
    description String
    key String
    level String
    value String

    FunctionPythonParameterMetricLevel, FunctionPythonParameterMetricLevelArgs

    Default string
    Description string
    Key string
    Level string
    Value string
    Default string
    Description string
    Key string
    Level string
    Value string
    default_ String
    description String
    key String
    level String
    value String
    default string
    description string
    key string
    level string
    value string
    default String
    description String
    key String
    level String
    value String

    FunctionPythonParameterTraceLevel, FunctionPythonParameterTraceLevelArgs

    Default string
    Description string
    Key string
    Level string
    Value string
    Default string
    Description string
    Key string
    Level string
    Value string
    default_ String
    description String
    key String
    level String
    value String
    default string
    description string
    key string
    level string
    value string
    default String
    description String
    key String
    level String
    value String

    FunctionPythonSecret, FunctionPythonSecretArgs

    SecretId string
    Fully qualified name of the allowed secret. You will receive an error if you specify a SECRETS value whose secret isn’t also included in an integration specified by the EXTERNALACCESSINTEGRATIONS parameter.
    SecretVariableName string
    The variable that will be used in handler code when retrieving information from the secret.
    SecretId string
    Fully qualified name of the allowed secret. You will receive an error if you specify a SECRETS value whose secret isn’t also included in an integration specified by the EXTERNALACCESSINTEGRATIONS parameter.
    SecretVariableName string
    The variable that will be used in handler code when retrieving information from the secret.
    secretId String
    Fully qualified name of the allowed secret. You will receive an error if you specify a SECRETS value whose secret isn’t also included in an integration specified by the EXTERNALACCESSINTEGRATIONS parameter.
    secretVariableName String
    The variable that will be used in handler code when retrieving information from the secret.
    secretId string
    Fully qualified name of the allowed secret. You will receive an error if you specify a SECRETS value whose secret isn’t also included in an integration specified by the EXTERNALACCESSINTEGRATIONS parameter.
    secretVariableName string
    The variable that will be used in handler code when retrieving information from the secret.
    secret_id str
    Fully qualified name of the allowed secret. You will receive an error if you specify a SECRETS value whose secret isn’t also included in an integration specified by the EXTERNALACCESSINTEGRATIONS parameter.
    secret_variable_name str
    The variable that will be used in handler code when retrieving information from the secret.
    secretId String
    Fully qualified name of the allowed secret. You will receive an error if you specify a SECRETS value whose secret isn’t also included in an integration specified by the EXTERNALACCESSINTEGRATIONS parameter.
    secretVariableName String
    The variable that will be used in handler code when retrieving information from the secret.

    FunctionPythonShowOutput, FunctionPythonShowOutputArgs

    Package Details

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