Snowflake v0.27.1, Jun 5 23

Snowflake v0.27.1 published on Monday, Jun 5, 2023 by Pulumi

snowflake.ExternalFunction

Explore with Pulumi AI

Snowflake v0.27.1 published on Monday, Jun 5, 2023 by Pulumi

pulumi/pulumi-snowflake

Import

format is database name | schema name | external function name | <list of function arg types, separated with ‘-'>

 $ pulumi import snowflake:index/externalFunction:ExternalFunction example 'dbName|schemaName|externalFunctionName|varchar-varchar-varchar'

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;

return await Deployment.RunAsync(() => 
{
    var testExtFunc = new Snowflake.ExternalFunction("testExtFunc", new()
    {
        ApiIntegration = "api_integration_name",
        Args = new[]
        {
            new Snowflake.Inputs.ExternalFunctionArgArgs
            {
                Name = "arg1",
                Type = "varchar",
            },
            new Snowflake.Inputs.ExternalFunctionArgArgs
            {
                Name = "arg2",
                Type = "varchar",
            },
        },
        Database = "my_test_db",
        ReturnBehavior = "IMMUTABLE",
        ReturnType = "variant",
        Schema = "my_test_schema",
        UrlOfProxyAndResource = "https://123456.execute-api.us-west-2.amazonaws.com/prod/test_func",
    });

});

package main

import (
	"github.com/pulumi/pulumi-snowflake/sdk/go/snowflake"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := snowflake.NewExternalFunction(ctx, "testExtFunc", &snowflake.ExternalFunctionArgs{
			ApiIntegration: pulumi.String("api_integration_name"),
			Args: snowflake.ExternalFunctionArgArray{
				&snowflake.ExternalFunctionArgArgs{
					Name: pulumi.String("arg1"),
					Type: pulumi.String("varchar"),
				},
				&snowflake.ExternalFunctionArgArgs{
					Name: pulumi.String("arg2"),
					Type: pulumi.String("varchar"),
				},
			},
			Database:              pulumi.String("my_test_db"),
			ReturnBehavior:        pulumi.String("IMMUTABLE"),
			ReturnType:            pulumi.String("variant"),
			Schema:                pulumi.String("my_test_schema"),
			UrlOfProxyAndResource: pulumi.String("https://123456.execute-api.us-west-2.amazonaws.com/prod/test_func"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.ExternalFunction;
import com.pulumi.snowflake.ExternalFunctionArgs;
import com.pulumi.snowflake.inputs.ExternalFunctionArgArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testExtFunc = new ExternalFunction("testExtFunc", ExternalFunctionArgs.builder()        
            .apiIntegration("api_integration_name")
            .args(            
                ExternalFunctionArgArgs.builder()
                    .name("arg1")
                    .type("varchar")
                    .build(),
                ExternalFunctionArgArgs.builder()
                    .name("arg2")
                    .type("varchar")
                    .build())
            .database("my_test_db")
            .returnBehavior("IMMUTABLE")
            .returnType("variant")
            .schema("my_test_schema")
            .urlOfProxyAndResource("https://123456.execute-api.us-west-2.amazonaws.com/prod/test_func")
            .build());

    }
}

import pulumi
import pulumi_snowflake as snowflake

test_ext_func = snowflake.ExternalFunction("testExtFunc",
    api_integration="api_integration_name",
    args=[
        snowflake.ExternalFunctionArgArgs(
            name="arg1",
            type="varchar",
        ),
        snowflake.ExternalFunctionArgArgs(
            name="arg2",
            type="varchar",
        ),
    ],
    database="my_test_db",
    return_behavior="IMMUTABLE",
    return_type="variant",
    schema="my_test_schema",
    url_of_proxy_and_resource="https://123456.execute-api.us-west-2.amazonaws.com/prod/test_func")

import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";

const testExtFunc = new snowflake.ExternalFunction("testExtFunc", {
    apiIntegration: "api_integration_name",
    args: [
        {
            name: "arg1",
            type: "varchar",
        },
        {
            name: "arg2",
            type: "varchar",
        },
    ],
    database: "my_test_db",
    returnBehavior: "IMMUTABLE",
    returnType: "variant",
    schema: "my_test_schema",
    urlOfProxyAndResource: "https://123456.execute-api.us-west-2.amazonaws.com/prod/test_func",
});

resources:
  testExtFunc:
    type: snowflake:ExternalFunction
    properties:
      apiIntegration: api_integration_name
      args:
        - name: arg1
          type: varchar
        - name: arg2
          type: varchar
      database: my_test_db
      returnBehavior: IMMUTABLE
      returnType: variant
      schema: my_test_schema
      urlOfProxyAndResource: https://123456.execute-api.us-west-2.amazonaws.com/prod/test_func

Create ExternalFunction Resource

new ExternalFunction(name: string, args: ExternalFunctionArgs, opts?: CustomResourceOptions);

@overload
def ExternalFunction(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     api_integration: Optional[str] = None,
                     args: Optional[Sequence[ExternalFunctionArgArgs]] = None,
                     comment: Optional[str] = None,
                     compression: Optional[str] = None,
                     context_headers: Optional[Sequence[str]] = None,
                     database: Optional[str] = None,
                     headers: Optional[Sequence[ExternalFunctionHeaderArgs]] = None,
                     max_batch_rows: Optional[int] = None,
                     name: Optional[str] = None,
                     null_input_behavior: Optional[str] = None,
                     request_translator: Optional[str] = None,
                     response_translator: Optional[str] = None,
                     return_behavior: Optional[str] = None,
                     return_null_allowed: Optional[bool] = None,
                     return_type: Optional[str] = None,
                     schema: Optional[str] = None,
                     url_of_proxy_and_resource: Optional[str] = None)
@overload
def ExternalFunction(resource_name: str,
                     args: ExternalFunctionArgs,
                     opts: Optional[ResourceOptions] = None)

func NewExternalFunction(ctx *Context, name string, args ExternalFunctionArgs, opts ...ResourceOption) (*ExternalFunction, error)

public ExternalFunction(string name, ExternalFunctionArgs args, CustomResourceOptions? opts = null)

public ExternalFunction(String name, ExternalFunctionArgs args)
public ExternalFunction(String name, ExternalFunctionArgs args, CustomResourceOptions options)

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

name string: The unique name of the resource.
args ExternalFunctionArgs: 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 ExternalFunctionArgs: 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 ExternalFunctionArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ExternalFunctionArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ExternalFunctionArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ExternalFunction Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ExternalFunction resource accepts the following input properties:

ApiIntegration string: The name of the API integration object that should be used to authenticate the call to the proxy service.
Database string: The database in which to create the external function.
ReturnBehavior string: Specifies the behavior of the function when returning results
ReturnType string: Specifies the data type returned by the external function.
Schema string: The schema in which to create the external function.
UrlOfProxyAndResource string: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.
Args List<ExternalFunctionArgArgs>: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
Comment string: A description of the external function.
Compression string: If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
ContextHeaders List<string>: Binds Snowflake context function results to HTTP headers.
Headers List<ExternalFunctionHeaderArgs>: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
MaxBatchRows int: This specifies the maximum number of rows in each batch sent to the proxy service.
Name string: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
NullInputBehavior string: Specifies the behavior of the external function when called with null inputs.
RequestTranslator string: This specifies the name of the request translator function
ResponseTranslator string: This specifies the name of the response translator function.
ReturnNullAllowed bool: Indicates whether the function can return NULL values or must return only NON-NULL values.

ApiIntegration string: The name of the API integration object that should be used to authenticate the call to the proxy service.
Database string: The database in which to create the external function.
ReturnBehavior string: Specifies the behavior of the function when returning results
ReturnType string: Specifies the data type returned by the external function.
Schema string: The schema in which to create the external function.
UrlOfProxyAndResource string: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.
Args []ExternalFunctionArgArgs: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
Comment string: A description of the external function.
Compression string: If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
ContextHeaders []string: Binds Snowflake context function results to HTTP headers.
Headers []ExternalFunctionHeaderArgs: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
MaxBatchRows int: This specifies the maximum number of rows in each batch sent to the proxy service.
Name string: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
NullInputBehavior string: Specifies the behavior of the external function when called with null inputs.
RequestTranslator string: This specifies the name of the request translator function
ResponseTranslator string: This specifies the name of the response translator function.
ReturnNullAllowed bool: Indicates whether the function can return NULL values or must return only NON-NULL values.

apiIntegration String: The name of the API integration object that should be used to authenticate the call to the proxy service.
database String: The database in which to create the external function.
returnBehavior String: Specifies the behavior of the function when returning results
returnType String: Specifies the data type returned by the external function.
schema String: The schema in which to create the external function.
urlOfProxyAndResource String: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.
args List<ExternalFunctionArgArgs>: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
comment String: A description of the external function.
compression String: If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
contextHeaders List<String>: Binds Snowflake context function results to HTTP headers.
headers List<ExternalFunctionHeaderArgs>: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
maxBatchRows Integer: This specifies the maximum number of rows in each batch sent to the proxy service.
name String: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
nullInputBehavior String: Specifies the behavior of the external function when called with null inputs.
requestTranslator String: This specifies the name of the request translator function
responseTranslator String: This specifies the name of the response translator function.
returnNullAllowed Boolean: Indicates whether the function can return NULL values or must return only NON-NULL values.

apiIntegration string: The name of the API integration object that should be used to authenticate the call to the proxy service.
database string: The database in which to create the external function.
returnBehavior string: Specifies the behavior of the function when returning results
returnType string: Specifies the data type returned by the external function.
schema string: The schema in which to create the external function.
urlOfProxyAndResource string: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.
args ExternalFunctionArgArgs[]: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
comment string: A description of the external function.
compression string: If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
contextHeaders string[]: Binds Snowflake context function results to HTTP headers.
headers ExternalFunctionHeaderArgs[]: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
maxBatchRows number: This specifies the maximum number of rows in each batch sent to the proxy service.
name string: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
nullInputBehavior string: Specifies the behavior of the external function when called with null inputs.
requestTranslator string: This specifies the name of the request translator function
responseTranslator string: This specifies the name of the response translator function.
returnNullAllowed boolean: Indicates whether the function can return NULL values or must return only NON-NULL values.

api_integration str: The name of the API integration object that should be used to authenticate the call to the proxy service.
database str: The database in which to create the external function.
return_behavior str: Specifies the behavior of the function when returning results
return_type str: Specifies the data type returned by the external function.
schema str: The schema in which to create the external function.
url_of_proxy_and_resource str: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.
args Sequence[ExternalFunctionArgArgs]: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
comment str: A description of the external function.
compression str: If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
context_headers Sequence[str]: Binds Snowflake context function results to HTTP headers.
headers Sequence[ExternalFunctionHeaderArgs]: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
max_batch_rows int: This specifies the maximum number of rows in each batch sent to the proxy service.
name str: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
null_input_behavior str: Specifies the behavior of the external function when called with null inputs.
request_translator str: This specifies the name of the request translator function
response_translator str: This specifies the name of the response translator function.
return_null_allowed bool: Indicates whether the function can return NULL values or must return only NON-NULL values.

apiIntegration String: The name of the API integration object that should be used to authenticate the call to the proxy service.
database String: The database in which to create the external function.
returnBehavior String: Specifies the behavior of the function when returning results
returnType String: Specifies the data type returned by the external function.
schema String: The schema in which to create the external function.
urlOfProxyAndResource String: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.
args List<Property Map>: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
comment String: A description of the external function.
compression String: If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
contextHeaders List<String>: Binds Snowflake context function results to HTTP headers.
headers List<Property Map>: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
maxBatchRows Number: This specifies the maximum number of rows in each batch sent to the proxy service.
name String: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
nullInputBehavior String: Specifies the behavior of the external function when called with null inputs.
requestTranslator String: This specifies the name of the request translator function
responseTranslator String: This specifies the name of the response translator function.
returnNullAllowed Boolean: Indicates whether the function can return NULL values or must return only NON-NULL values.

Outputs

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

CreatedOn string: Date and time when the external function was created.
Id string: The provider-assigned unique ID for this managed resource.

CreatedOn string: Date and time when the external function was created.
Id string: The provider-assigned unique ID for this managed resource.

createdOn String: Date and time when the external function was created.
id String: The provider-assigned unique ID for this managed resource.

createdOn string: Date and time when the external function was created.
id string: The provider-assigned unique ID for this managed resource.

created_on str: Date and time when the external function was created.
id str: The provider-assigned unique ID for this managed resource.

createdOn String: Date and time when the external function was created.
id String: The provider-assigned unique ID for this managed resource.

Look up Existing ExternalFunction Resource

Get an existing ExternalFunction 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?: ExternalFunctionState, opts?: CustomResourceOptions): ExternalFunction

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_integration: Optional[str] = None,
        args: Optional[Sequence[ExternalFunctionArgArgs]] = None,
        comment: Optional[str] = None,
        compression: Optional[str] = None,
        context_headers: Optional[Sequence[str]] = None,
        created_on: Optional[str] = None,
        database: Optional[str] = None,
        headers: Optional[Sequence[ExternalFunctionHeaderArgs]] = None,
        max_batch_rows: Optional[int] = None,
        name: Optional[str] = None,
        null_input_behavior: Optional[str] = None,
        request_translator: Optional[str] = None,
        response_translator: Optional[str] = None,
        return_behavior: Optional[str] = None,
        return_null_allowed: Optional[bool] = None,
        return_type: Optional[str] = None,
        schema: Optional[str] = None,
        url_of_proxy_and_resource: Optional[str] = None) -> ExternalFunction

func GetExternalFunction(ctx *Context, name string, id IDInput, state *ExternalFunctionState, opts ...ResourceOption) (*ExternalFunction, error)

public static ExternalFunction Get(string name, Input<string> id, ExternalFunctionState? state, CustomResourceOptions? opts = null)

public static ExternalFunction get(String name, Output<String> id, ExternalFunctionState 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:

ApiIntegration string: The name of the API integration object that should be used to authenticate the call to the proxy service.
Args List<ExternalFunctionArgArgs>: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
Comment string: A description of the external function.
Compression string: If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
ContextHeaders List<string>: Binds Snowflake context function results to HTTP headers.
CreatedOn string: Date and time when the external function was created.
Database string: The database in which to create the external function.
Headers List<ExternalFunctionHeaderArgs>: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
MaxBatchRows int: This specifies the maximum number of rows in each batch sent to the proxy service.
Name string: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
NullInputBehavior string: Specifies the behavior of the external function when called with null inputs.
RequestTranslator string: This specifies the name of the request translator function
ResponseTranslator string: This specifies the name of the response translator function.
ReturnBehavior string: Specifies the behavior of the function when returning results
ReturnNullAllowed bool: Indicates whether the function can return NULL values or must return only NON-NULL values.
ReturnType string: Specifies the data type returned by the external function.
Schema string: The schema in which to create the external function.
UrlOfProxyAndResource string: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.

ApiIntegration string: The name of the API integration object that should be used to authenticate the call to the proxy service.
Args []ExternalFunctionArgArgs: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
Comment string: A description of the external function.
Compression string: If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
ContextHeaders []string: Binds Snowflake context function results to HTTP headers.
CreatedOn string: Date and time when the external function was created.
Database string: The database in which to create the external function.
Headers []ExternalFunctionHeaderArgs: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
MaxBatchRows int: This specifies the maximum number of rows in each batch sent to the proxy service.
Name string: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
NullInputBehavior string: Specifies the behavior of the external function when called with null inputs.
RequestTranslator string: This specifies the name of the request translator function
ResponseTranslator string: This specifies the name of the response translator function.
ReturnBehavior string: Specifies the behavior of the function when returning results
ReturnNullAllowed bool: Indicates whether the function can return NULL values or must return only NON-NULL values.
ReturnType string: Specifies the data type returned by the external function.
Schema string: The schema in which to create the external function.
UrlOfProxyAndResource string: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.

apiIntegration String: The name of the API integration object that should be used to authenticate the call to the proxy service.
args List<ExternalFunctionArgArgs>: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
comment String: A description of the external function.
compression String: If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
contextHeaders List<String>: Binds Snowflake context function results to HTTP headers.
createdOn String: Date and time when the external function was created.
database String: The database in which to create the external function.
headers List<ExternalFunctionHeaderArgs>: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
maxBatchRows Integer: This specifies the maximum number of rows in each batch sent to the proxy service.
name String: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
nullInputBehavior String: Specifies the behavior of the external function when called with null inputs.
requestTranslator String: This specifies the name of the request translator function
responseTranslator String: This specifies the name of the response translator function.
returnBehavior String: Specifies the behavior of the function when returning results
returnNullAllowed Boolean: Indicates whether the function can return NULL values or must return only NON-NULL values.
returnType String: Specifies the data type returned by the external function.
schema String: The schema in which to create the external function.
urlOfProxyAndResource String: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.

apiIntegration string: The name of the API integration object that should be used to authenticate the call to the proxy service.
args ExternalFunctionArgArgs[]: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
comment string: A description of the external function.
compression string: If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
contextHeaders string[]: Binds Snowflake context function results to HTTP headers.
createdOn string: Date and time when the external function was created.
database string: The database in which to create the external function.
headers ExternalFunctionHeaderArgs[]: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
maxBatchRows number: This specifies the maximum number of rows in each batch sent to the proxy service.
name string: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
nullInputBehavior string: Specifies the behavior of the external function when called with null inputs.
requestTranslator string: This specifies the name of the request translator function
responseTranslator string: This specifies the name of the response translator function.
returnBehavior string: Specifies the behavior of the function when returning results
returnNullAllowed boolean: Indicates whether the function can return NULL values or must return only NON-NULL values.
returnType string: Specifies the data type returned by the external function.
schema string: The schema in which to create the external function.
urlOfProxyAndResource string: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.

api_integration str: The name of the API integration object that should be used to authenticate the call to the proxy service.
args Sequence[ExternalFunctionArgArgs]: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
comment str: A description of the external function.
compression str: If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
context_headers Sequence[str]: Binds Snowflake context function results to HTTP headers.
created_on str: Date and time when the external function was created.
database str: The database in which to create the external function.
headers Sequence[ExternalFunctionHeaderArgs]: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
max_batch_rows int: This specifies the maximum number of rows in each batch sent to the proxy service.
name str: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
null_input_behavior str: Specifies the behavior of the external function when called with null inputs.
request_translator str: This specifies the name of the request translator function
response_translator str: This specifies the name of the response translator function.
return_behavior str: Specifies the behavior of the function when returning results
return_null_allowed bool: Indicates whether the function can return NULL values or must return only NON-NULL values.
return_type str: Specifies the data type returned by the external function.
schema str: The schema in which to create the external function.
url_of_proxy_and_resource str: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.

apiIntegration String: The name of the API integration object that should be used to authenticate the call to the proxy service.
args List<Property Map>: Specifies the arguments/inputs for the external function. These should correspond to the arguments that the remote service expects.
comment String: A description of the external function.
compression String: If specified, the JSON payload is compressed when sent from Snowflake to the proxy service, and when sent back from the proxy service to Snowflake.
contextHeaders List<String>: Binds Snowflake context function results to HTTP headers.
createdOn String: Date and time when the external function was created.
database String: The database in which to create the external function.
headers List<Property Map>: Allows users to specify key-value metadata that is sent with every request as HTTP headers.
maxBatchRows Number: This specifies the maximum number of rows in each batch sent to the proxy service.
name String: Specifies the identifier for the external function. The identifier can contain the schema name and database name, as well as the function name. The function's signature (name and argument data types) must be unique within the schema.
nullInputBehavior String: Specifies the behavior of the external function when called with null inputs.
requestTranslator String: This specifies the name of the request translator function
responseTranslator String: This specifies the name of the response translator function.
returnBehavior String: Specifies the behavior of the function when returning results
returnNullAllowed Boolean: Indicates whether the function can return NULL values or must return only NON-NULL values.
returnType String: Specifies the data type returned by the external function.
schema String: The schema in which to create the external function.
urlOfProxyAndResource String: This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.

Supporting Types

ExternalFunctionArg

Name string: Argument name
Type string: Argument type, e.g. VARCHAR

Name string: Argument name
Type string: Argument type, e.g. VARCHAR

name String: Argument name
type String: Argument type, e.g. VARCHAR

name string: Argument name
type string: Argument type, e.g. VARCHAR

name str: Argument name
type str: Argument type, e.g. VARCHAR

name String: Argument name
type String: Argument type, e.g. VARCHAR

ExternalFunctionHeader

Name string: Header name
Value string: Header value

Name string: Header name
Value string: Header value

name String: Header name
value String: Header value

name string: Header name
value string: Header value

name str: Header name
value str: Header value

name String: Header name
value String: Header value

Package Details

Repository: Snowflake pulumi/pulumi-snowflake
License: Apache-2.0
Notes: This Pulumi package is based on the snowflake Terraform Provider.

Snowflake v0.27.1 published on Monday, Jun 5, 2023 by Pulumi

pulumi/pulumi-snowflake

snowflake.ExternalFunction

On this page

On this page

Import

Example Usage

Create ExternalFunction Resource

ExternalFunction Resource Properties

Inputs

Outputs

Look up Existing ExternalFunction Resource

Supporting Types

ExternalFunctionArg

ExternalFunctionHeader

Package Details

On this page

On this page