Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Snowflake

v0.2.1 published on Monday, Sep 27, 2021 by Pulumi

Function

Create a Function Resource

new Function(name: string, args: FunctionArgs, opts?: CustomResourceOptions);
@overload
def Function(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             arguments: Optional[Sequence[FunctionArgumentArgs]] = None,
             comment: Optional[str] = None,
             database: Optional[str] = None,
             language: Optional[str] = None,
             name: Optional[str] = None,
             null_input_behavior: Optional[str] = None,
             return_behavior: Optional[str] = None,
             return_type: Optional[str] = None,
             schema: Optional[str] = None,
             statement: Optional[str] = None)
@overload
def Function(resource_name: str,
             args: FunctionArgs,
             opts: Optional[ResourceOptions] = None)
func NewFunction(ctx *Context, name string, args FunctionArgs, opts ...ResourceOption) (*Function, error)
public Function(string name, FunctionArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args FunctionArgs
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 FunctionArgs
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 FunctionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FunctionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

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

Database string
The database in which to create the function. Don’t use the | character.
ReturnType string
The return type of the function
Schema string
The schema in which to create the function. Don’t use the | character.
Statement string
Specifies the javascript / java / sql code used to create the function.
Arguments List<FunctionArgumentArgs>
List of the arguments for the function
Comment string
Specifies a comment for the function.
Language string
The language of the statement
Name string
Specifies the identifier for the function; does not have to be unique for the schema in which the function is created. Don’t use the | character.
NullInputBehavior string
Specifies the behavior of the function when called with null inputs.
ReturnBehavior string
Specifies the behavior of the function when returning results
Database string
The database in which to create the function. Don’t use the | character.
ReturnType string
The return type of the function
Schema string
The schema in which to create the function. Don’t use the | character.
Statement string
Specifies the javascript / java / sql code used to create the function.
Arguments []FunctionArgumentArgs
List of the arguments for the function
Comment string
Specifies a comment for the function.
Language string
The language of the statement
Name string
Specifies the identifier for the function; does not have to be unique for the schema in which the function is created. Don’t use the | character.
NullInputBehavior string
Specifies the behavior of the function when called with null inputs.
ReturnBehavior string
Specifies the behavior of the function when returning results
database string
The database in which to create the function. Don’t use the | character.
returnType string
The return type of the function
schema string
The schema in which to create the function. Don’t use the | character.
statement string
Specifies the javascript / java / sql code used to create the function.
arguments FunctionArgumentArgs[]
List of the arguments for the function
comment string
Specifies a comment for the function.
language string
The language of the statement
name string
Specifies the identifier for the function; does not have to be unique for the schema in which the function is created. Don’t use the | character.
nullInputBehavior string
Specifies the behavior of the function when called with null inputs.
returnBehavior string
Specifies the behavior of the function when returning results
database str
The database in which to create the function. Don’t use the | character.
return_type str
The return type of the function
schema str
The schema in which to create the function. Don’t use the | character.
statement str
Specifies the javascript / java / sql code used to create the function.
arguments Sequence[FunctionArgumentArgs]
List of the arguments for the function
comment str
Specifies a comment for the function.
language str
The language of the statement
name str
Specifies the identifier for the function; does not have to be unique for the schema in which the function is created. Don’t use the | character.
null_input_behavior str
Specifies the behavior of the function when called with null inputs.
return_behavior str
Specifies the behavior of the function when returning results

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing Function Resource

Get an existing Function 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?: FunctionState, opts?: CustomResourceOptions): Function
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arguments: Optional[Sequence[FunctionArgumentArgs]] = None,
        comment: Optional[str] = None,
        database: Optional[str] = None,
        language: Optional[str] = None,
        name: Optional[str] = None,
        null_input_behavior: Optional[str] = None,
        return_behavior: Optional[str] = None,
        return_type: Optional[str] = None,
        schema: Optional[str] = None,
        statement: Optional[str] = None) -> Function
func GetFunction(ctx *Context, name string, id IDInput, state *FunctionState, opts ...ResourceOption) (*Function, error)
public static Function Get(string name, Input<string> id, FunctionState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Arguments List<FunctionArgumentArgs>
List of the arguments for the function
Comment string
Specifies a comment for the function.
Database string
The database in which to create the function. Don’t use the | character.
Language string
The language of the statement
Name string
Specifies the identifier for the function; does not have to be unique for the schema in which the function is created. Don’t use the | character.
NullInputBehavior string
Specifies the behavior of the function when called with null inputs.
ReturnBehavior string
Specifies the behavior of the function when returning results
ReturnType string
The return type of the function
Schema string
The schema in which to create the function. Don’t use the | character.
Statement string
Specifies the javascript / java / sql code used to create the function.
Arguments []FunctionArgumentArgs
List of the arguments for the function
Comment string
Specifies a comment for the function.
Database string
The database in which to create the function. Don’t use the | character.
Language string
The language of the statement
Name string
Specifies the identifier for the function; does not have to be unique for the schema in which the function is created. Don’t use the | character.
NullInputBehavior string
Specifies the behavior of the function when called with null inputs.
ReturnBehavior string
Specifies the behavior of the function when returning results
ReturnType string
The return type of the function
Schema string
The schema in which to create the function. Don’t use the | character.
Statement string
Specifies the javascript / java / sql code used to create the function.
arguments FunctionArgumentArgs[]
List of the arguments for the function
comment string
Specifies a comment for the function.
database string
The database in which to create the function. Don’t use the | character.
language string
The language of the statement
name string
Specifies the identifier for the function; does not have to be unique for the schema in which the function is created. Don’t use the | character.
nullInputBehavior string
Specifies the behavior of the function when called with null inputs.
returnBehavior string
Specifies the behavior of the function when returning results
returnType string
The return type of the function
schema string
The schema in which to create the function. Don’t use the | character.
statement string
Specifies the javascript / java / sql code used to create the function.
arguments Sequence[FunctionArgumentArgs]
List of the arguments for the function
comment str
Specifies a comment for the function.
database str
The database in which to create the function. Don’t use the | character.
language str
The language of the statement
name str
Specifies the identifier for the function; does not have to be unique for the schema in which the function is created. Don’t use the | character.
null_input_behavior str
Specifies the behavior of the function when called with null inputs.
return_behavior str
Specifies the behavior of the function when returning results
return_type str
The return type of the function
schema str
The schema in which to create the function. Don’t use the | character.
statement str
Specifies the javascript / java / sql code used to create the function.

Supporting Types

FunctionArgument

Name string
The argument name
Type string
The argument type
Name string
The argument name
Type string
The argument type
name string
The argument name
type string
The argument type
name str
The argument name
type str
The argument type

Package Details

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