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

snowflake.FunctionJava

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/functionJava:FunctionJava 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 FunctionJava Resource

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

    Constructor syntax

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

@overload
def FunctionJava(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 handler: Optional[str] = None,
                 schema: Optional[str] = None,
                 database: Optional[str] = None,
                 return_type: Optional[str] = None,
                 function_definition: Optional[str] = None,
                 packages: Optional[Sequence[str]] = None,
                 external_access_integrations: Optional[Sequence[str]] = None,
                 imports: Optional[Sequence[FunctionJavaImportArgs]] = 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,
                 arguments: Optional[Sequence[FunctionJavaArgumentArgs]] = None,
                 return_results_behavior: Optional[str] = None,
                 enable_console_output: Optional[bool] = None,
                 runtime_version: Optional[str] = None,
                 comment: Optional[str] = None,
                 secrets: Optional[Sequence[FunctionJavaSecretArgs]] = None,
                 target_path: Optional[FunctionJavaTargetPathArgs] = None,
                 trace_level: Optional[str] = None)
    func NewFunctionJava(ctx *Context, name string, args FunctionJavaArgs, opts ...ResourceOption) (*FunctionJava, error)
    public FunctionJava(string name, FunctionJavaArgs args, CustomResourceOptions? opts = null)
    public FunctionJava(String name, FunctionJavaArgs args)
public FunctionJava(String name, FunctionJavaArgs args, CustomResourceOptions options)

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

    example, err := snowflake.NewFunctionJava(ctx, "functionJavaResource", &snowflake.FunctionJavaArgs{
	Handler:            pulumi.String("string"),
	Schema:             pulumi.String("string"),
	Database:           pulumi.String("string"),
	ReturnType:         pulumi.String("string"),
	FunctionDefinition: pulumi.String("string"),
	Packages: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExternalAccessIntegrations: pulumi.StringArray{
		pulumi.String("string"),
	},
	Imports: snowflake.FunctionJavaImportArray{
		&snowflake.FunctionJavaImportArgs{
			PathOnStage:   pulumi.String("string"),
			StageLocation: pulumi.String("string"),
		},
	},
	IsSecure:          pulumi.String("string"),
	LogLevel:          pulumi.String("string"),
	MetricLevel:       pulumi.String("string"),
	Name:              pulumi.String("string"),
	NullInputBehavior: pulumi.String("string"),
	Arguments: snowflake.FunctionJavaArgumentArray{
		&snowflake.FunctionJavaArgumentArgs{
			ArgDataType:     pulumi.String("string"),
			ArgName:         pulumi.String("string"),
			ArgDefaultValue: pulumi.String("string"),
		},
	},
	ReturnResultsBehavior: pulumi.String("string"),
	EnableConsoleOutput:   pulumi.Bool(false),
	RuntimeVersion:        pulumi.String("string"),
	Comment:               pulumi.String("string"),
	Secrets: snowflake.FunctionJavaSecretArray{
		&snowflake.FunctionJavaSecretArgs{
			SecretId:           pulumi.String("string"),
			SecretVariableName: pulumi.String("string"),
		},
	},
	TargetPath: &snowflake.FunctionJavaTargetPathArgs{
		PathOnStage:   pulumi.String("string"),
		StageLocation: pulumi.String("string"),
	},
	TraceLevel: pulumi.String("string"),
})

    var functionJavaResource = new FunctionJava("functionJavaResource", FunctionJavaArgs.builder()
    .handler("string")
    .schema("string")
    .database("string")
    .returnType("string")
    .functionDefinition("string")
    .packages("string")
    .externalAccessIntegrations("string")
    .imports(FunctionJavaImportArgs.builder()
        .pathOnStage("string")
        .stageLocation("string")
        .build())
    .isSecure("string")
    .logLevel("string")
    .metricLevel("string")
    .name("string")
    .nullInputBehavior("string")
    .arguments(FunctionJavaArgumentArgs.builder()
        .argDataType("string")
        .argName("string")
        .argDefaultValue("string")
        .build())
    .returnResultsBehavior("string")
    .enableConsoleOutput(false)
    .runtimeVersion("string")
    .comment("string")
    .secrets(FunctionJavaSecretArgs.builder()
        .secretId("string")
        .secretVariableName("string")
        .build())
    .targetPath(FunctionJavaTargetPathArgs.builder()
        .pathOnStage("string")
        .stageLocation("string")
        .build())
    .traceLevel("string")
    .build());

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

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

    type: snowflake:FunctionJava
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
    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
    targetPath:
        pathOnStage: string
        stageLocation: string
    traceLevel: string

    FunctionJava 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 FunctionJava 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 method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. 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.
    Schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Arguments List<FunctionJavaArgument>
    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 Java source code. For more information, see Introduction to Java 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<FunctionJavaImport>
    The location (stage), path, and name of the file(s) to import. A file can be a JAR file or another type of file. If the file is a JAR file, it can contain one or more .class files and zero or more resource files. JNI (Java Native Interface) is not supported. Snowflake prohibits loading libraries that contain native code (as opposed to Java bytecode). Java UDFs can also read non-JAR files. For an example, see Reading a file specified statically in IMPORTS. Consult the docs.
    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 Snowflake system packages required as dependencies. The value should be of the form package_name:version_number, where package_name is snowflake_domain:package.
    ReturnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    RuntimeVersion string
    Specifies the Java JDK runtime version to use. The supported versions of Java are 11.x and 17.x. If RUNTIME_VERSION is not set, Java JDK 11 is used.
    Secrets List<FunctionJavaSecret>
    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.
    TargetPath FunctionJavaTargetPath
    The name of the handler method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    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 method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. 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.
    Schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Arguments []FunctionJavaArgumentArgs
    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 Java source code. For more information, see Introduction to Java 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 []FunctionJavaImportArgs
    The location (stage), path, and name of the file(s) to import. A file can be a JAR file or another type of file. If the file is a JAR file, it can contain one or more .class files and zero or more resource files. JNI (Java Native Interface) is not supported. Snowflake prohibits loading libraries that contain native code (as opposed to Java bytecode). Java UDFs can also read non-JAR files. For an example, see Reading a file specified statically in IMPORTS. Consult the docs.
    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 Snowflake system packages required as dependencies. The value should be of the form package_name:version_number, where package_name is snowflake_domain:package.
    ReturnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    RuntimeVersion string
    Specifies the Java JDK runtime version to use. The supported versions of Java are 11.x and 17.x. If RUNTIME_VERSION is not set, Java JDK 11 is used.
    Secrets []FunctionJavaSecretArgs
    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.
    TargetPath FunctionJavaTargetPathArgs
    The name of the handler method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    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 method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. 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.
    schema String
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    arguments List<FunctionJavaArgument>
    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 Java source code. For more information, see Introduction to Java 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<FunctionJavaImport>
    The location (stage), path, and name of the file(s) to import. A file can be a JAR file or another type of file. If the file is a JAR file, it can contain one or more .class files and zero or more resource files. JNI (Java Native Interface) is not supported. Snowflake prohibits loading libraries that contain native code (as opposed to Java bytecode). Java UDFs can also read non-JAR files. For an example, see Reading a file specified statically in IMPORTS. Consult the docs.
    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 Snowflake system packages required as dependencies. The value should be of the form package_name:version_number, where package_name is snowflake_domain:package.
    returnResultsBehavior String
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    runtimeVersion String
    Specifies the Java JDK runtime version to use. The supported versions of Java are 11.x and 17.x. If RUNTIME_VERSION is not set, Java JDK 11 is used.
    secrets List<FunctionJavaSecret>
    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.
    targetPath FunctionJavaTargetPath
    The name of the handler method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    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 method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. 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.
    schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    arguments FunctionJavaArgument[]
    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 Java source code. For more information, see Introduction to Java 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 FunctionJavaImport[]
    The location (stage), path, and name of the file(s) to import. A file can be a JAR file or another type of file. If the file is a JAR file, it can contain one or more .class files and zero or more resource files. JNI (Java Native Interface) is not supported. Snowflake prohibits loading libraries that contain native code (as opposed to Java bytecode). Java UDFs can also read non-JAR files. For an example, see Reading a file specified statically in IMPORTS. Consult the docs.
    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 Snowflake system packages required as dependencies. The value should be of the form package_name:version_number, where package_name is snowflake_domain:package.
    returnResultsBehavior string
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    runtimeVersion string
    Specifies the Java JDK runtime version to use. The supported versions of Java are 11.x and 17.x. If RUNTIME_VERSION is not set, Java JDK 11 is used.
    secrets FunctionJavaSecret[]
    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.
    targetPath FunctionJavaTargetPath
    The name of the handler method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    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 method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. 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.
    schema str
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    arguments Sequence[FunctionJavaArgumentArgs]
    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 Java source code. For more information, see Introduction to Java 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[FunctionJavaImportArgs]
    The location (stage), path, and name of the file(s) to import. A file can be a JAR file or another type of file. If the file is a JAR file, it can contain one or more .class files and zero or more resource files. JNI (Java Native Interface) is not supported. Snowflake prohibits loading libraries that contain native code (as opposed to Java bytecode). Java UDFs can also read non-JAR files. For an example, see Reading a file specified statically in IMPORTS. Consult the docs.
    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 Snowflake system packages required as dependencies. The value should be of the form package_name:version_number, where package_name is snowflake_domain:package.
    return_results_behavior str
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    runtime_version str
    Specifies the Java JDK runtime version to use. The supported versions of Java are 11.x and 17.x. If RUNTIME_VERSION is not set, Java JDK 11 is used.
    secrets Sequence[FunctionJavaSecretArgs]
    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.
    target_path FunctionJavaTargetPathArgs
    The name of the handler method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    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 method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. 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.
    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 Java source code. For more information, see Introduction to Java 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 JAR file or another type of file. If the file is a JAR file, it can contain one or more .class files and zero or more resource files. JNI (Java Native Interface) is not supported. Snowflake prohibits loading libraries that contain native code (as opposed to Java bytecode). Java UDFs can also read non-JAR files. For an example, see Reading a file specified statically in IMPORTS. Consult the docs.
    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 Snowflake system packages required as dependencies. The value should be of the form package_name:version_number, where package_name is snowflake_domain:package.
    returnResultsBehavior String
    Specifies the behavior of the function when returning results. Valid values are (case-insensitive): VOLATILE | IMMUTABLE.
    runtimeVersion String
    Specifies the Java JDK runtime version to use. The supported versions of Java are 11.x and 17.x. If RUNTIME_VERSION is not set, Java JDK 11 is used.
    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.
    targetPath Property Map
    The name of the handler method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    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 FunctionJava 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<FunctionJavaParameter>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    ShowOutputs List<FunctionJavaShowOutput>
    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 []FunctionJavaParameter
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    ShowOutputs []FunctionJavaShowOutput
    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<FunctionJavaParameter>
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    showOutputs List<FunctionJavaShowOutput>
    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 FunctionJavaParameter[]
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    showOutputs FunctionJavaShowOutput[]
    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[FunctionJavaParameter]
    Outputs the result of SHOW PARAMETERS IN FUNCTION for the given function.
    show_outputs Sequence[FunctionJavaShowOutput]
    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 FunctionJava Resource

    Get an existing FunctionJava 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?: FunctionJavaState, opts?: CustomResourceOptions): FunctionJava
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arguments: Optional[Sequence[FunctionJavaArgumentArgs]] = 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[FunctionJavaImportArgs]] = 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[FunctionJavaParameterArgs]] = None,
        return_results_behavior: Optional[str] = None,
        return_type: Optional[str] = None,
        runtime_version: Optional[str] = None,
        schema: Optional[str] = None,
        secrets: Optional[Sequence[FunctionJavaSecretArgs]] = None,
        show_outputs: Optional[Sequence[FunctionJavaShowOutputArgs]] = None,
        target_path: Optional[FunctionJavaTargetPathArgs] = None,
        trace_level: Optional[str] = None) -> FunctionJava
    func GetFunctionJava(ctx *Context, name string, id IDInput, state *FunctionJavaState, opts ...ResourceOption) (*FunctionJava, error)
    public static FunctionJava Get(string name, Input<string> id, FunctionJavaState? state, CustomResourceOptions? opts = null)
    public static FunctionJava get(String name, Output<String> id, FunctionJavaState state, CustomResourceOptions options)
    resources:  _:    type: snowflake:FunctionJava    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arguments List<FunctionJavaArgument>
    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 Java source code. For more information, see Introduction to Java 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 method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    Imports List<FunctionJavaImport>
    The location (stage), path, and name of the file(s) to import. A file can be a JAR file or another type of file. If the file is a JAR file, it can contain one or more .class files and zero or more resource files. JNI (Java Native Interface) is not supported. Snowflake prohibits loading libraries that contain native code (as opposed to Java bytecode). Java UDFs can also read non-JAR files. For an example, see Reading a file specified statically in IMPORTS. Consult the docs.
    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 Snowflake system packages required as dependencies. The value should be of the form package_name:version_number, where package_name is snowflake_domain:package.
    Parameters List<FunctionJavaParameter>
    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 Java JDK runtime version to use. The supported versions of Java are 11.x and 17.x. If RUNTIME_VERSION is not set, Java JDK 11 is used.
    Schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Secrets List<FunctionJavaSecret>
    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<FunctionJavaShowOutput>
    Outputs the result of SHOW FUNCTION for the given function.
    TargetPath FunctionJavaTargetPath
    The name of the handler method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    TraceLevel string
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    Arguments []FunctionJavaArgumentArgs
    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 Java source code. For more information, see Introduction to Java 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 method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    Imports []FunctionJavaImportArgs
    The location (stage), path, and name of the file(s) to import. A file can be a JAR file or another type of file. If the file is a JAR file, it can contain one or more .class files and zero or more resource files. JNI (Java Native Interface) is not supported. Snowflake prohibits loading libraries that contain native code (as opposed to Java bytecode). Java UDFs can also read non-JAR files. For an example, see Reading a file specified statically in IMPORTS. Consult the docs.
    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 Snowflake system packages required as dependencies. The value should be of the form package_name:version_number, where package_name is snowflake_domain:package.
    Parameters []FunctionJavaParameterArgs
    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 Java JDK runtime version to use. The supported versions of Java are 11.x and 17.x. If RUNTIME_VERSION is not set, Java JDK 11 is used.
    Schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    Secrets []FunctionJavaSecretArgs
    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 []FunctionJavaShowOutputArgs
    Outputs the result of SHOW FUNCTION for the given function.
    TargetPath FunctionJavaTargetPathArgs
    The name of the handler method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    TraceLevel string
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    arguments List<FunctionJavaArgument>
    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 Java source code. For more information, see Introduction to Java 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 method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    imports List<FunctionJavaImport>
    The location (stage), path, and name of the file(s) to import. A file can be a JAR file or another type of file. If the file is a JAR file, it can contain one or more .class files and zero or more resource files. JNI (Java Native Interface) is not supported. Snowflake prohibits loading libraries that contain native code (as opposed to Java bytecode). Java UDFs can also read non-JAR files. For an example, see Reading a file specified statically in IMPORTS. Consult the docs.
    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 Snowflake system packages required as dependencies. The value should be of the form package_name:version_number, where package_name is snowflake_domain:package.
    parameters List<FunctionJavaParameter>
    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 Java JDK runtime version to use. The supported versions of Java are 11.x and 17.x. If RUNTIME_VERSION is not set, Java JDK 11 is used.
    schema String
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    secrets List<FunctionJavaSecret>
    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<FunctionJavaShowOutput>
    Outputs the result of SHOW FUNCTION for the given function.
    targetPath FunctionJavaTargetPath
    The name of the handler method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    traceLevel String
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    arguments FunctionJavaArgument[]
    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 Java source code. For more information, see Introduction to Java 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 method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    imports FunctionJavaImport[]
    The location (stage), path, and name of the file(s) to import. A file can be a JAR file or another type of file. If the file is a JAR file, it can contain one or more .class files and zero or more resource files. JNI (Java Native Interface) is not supported. Snowflake prohibits loading libraries that contain native code (as opposed to Java bytecode). Java UDFs can also read non-JAR files. For an example, see Reading a file specified statically in IMPORTS. Consult the docs.
    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 Snowflake system packages required as dependencies. The value should be of the form package_name:version_number, where package_name is snowflake_domain:package.
    parameters FunctionJavaParameter[]
    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 Java JDK runtime version to use. The supported versions of Java are 11.x and 17.x. If RUNTIME_VERSION is not set, Java JDK 11 is used.
    schema string
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    secrets FunctionJavaSecret[]
    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 FunctionJavaShowOutput[]
    Outputs the result of SHOW FUNCTION for the given function.
    targetPath FunctionJavaTargetPath
    The name of the handler method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    traceLevel string
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.
    arguments Sequence[FunctionJavaArgumentArgs]
    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 Java source code. For more information, see Introduction to Java 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 method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    imports Sequence[FunctionJavaImportArgs]
    The location (stage), path, and name of the file(s) to import. A file can be a JAR file or another type of file. If the file is a JAR file, it can contain one or more .class files and zero or more resource files. JNI (Java Native Interface) is not supported. Snowflake prohibits loading libraries that contain native code (as opposed to Java bytecode). Java UDFs can also read non-JAR files. For an example, see Reading a file specified statically in IMPORTS. Consult the docs.
    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 Snowflake system packages required as dependencies. The value should be of the form package_name:version_number, where package_name is snowflake_domain:package.
    parameters Sequence[FunctionJavaParameterArgs]
    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 Java JDK runtime version to use. The supported versions of Java are 11.x and 17.x. If RUNTIME_VERSION is not set, Java JDK 11 is used.
    schema str
    The schema in which to create the function. Due to technical limitations (read more here), avoid using the following characters: |, ., ".
    secrets Sequence[FunctionJavaSecretArgs]
    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[FunctionJavaShowOutputArgs]
    Outputs the result of SHOW FUNCTION for the given function.
    target_path FunctionJavaTargetPathArgs
    The name of the handler method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    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 Java source code. For more information, see Introduction to Java 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 method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. 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 JAR file or another type of file. If the file is a JAR file, it can contain one or more .class files and zero or more resource files. JNI (Java Native Interface) is not supported. Snowflake prohibits loading libraries that contain native code (as opposed to Java bytecode). Java UDFs can also read non-JAR files. For an example, see Reading a file specified statically in IMPORTS. Consult the docs.
    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 Snowflake system packages required as dependencies. The value should be of the form package_name:version_number, where package_name is snowflake_domain:package.
    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 Java JDK runtime version to use. The supported versions of Java are 11.x and 17.x. If RUNTIME_VERSION is not set, Java JDK 11 is used.
    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.
    targetPath Property Map
    The name of the handler method or class. If the handler is for a scalar UDF, returning a non-tabular value, the HANDLER value should be a method name, as in the following form: MyClass.myMethod. If the handler is for a tabular UDF, the HANDLER value should be the name of a handler class.
    traceLevel String
    Trace level value to use when generating/filtering trace events For more information, check TRACE_LEVEL docs.

    Supporting Types

    FunctionJavaArgument, FunctionJavaArgumentArgs

    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

    FunctionJavaImport, FunctionJavaImportArgs

    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

    FunctionJavaParameter, FunctionJavaParameterArgs

    FunctionJavaParameterEnableConsoleOutput, FunctionJavaParameterEnableConsoleOutputArgs

    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

    FunctionJavaParameterLogLevel, FunctionJavaParameterLogLevelArgs

    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

    FunctionJavaParameterMetricLevel, FunctionJavaParameterMetricLevelArgs

    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

    FunctionJavaParameterTraceLevel, FunctionJavaParameterTraceLevelArgs

    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

    FunctionJavaSecret, FunctionJavaSecretArgs

    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.

    FunctionJavaShowOutput, FunctionJavaShowOutputArgs

    FunctionJavaTargetPath, FunctionJavaTargetPathArgs

    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

    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