externalFunction.typescript.md

externalFunction Submodule

Constructs

ExternalFunction

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function snowflake_external_function}.

Initializers

import { externalFunction } from '@cdktf/provider-snowflake'

new externalFunction.ExternalFunction(scope: Construct, id: string, config: ExternalFunctionConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	ExternalFunctionConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: ExternalFunctionConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
putArg	No description.
putHeader	No description.
resetArg	No description.
resetComment	No description.
resetCompression	No description.
resetContextHeaders	No description.
resetHeader	No description.
resetId	No description.
resetMaxBatchRows	No description.
resetNullInputBehavior	No description.
resetRequestTranslator	No description.
resetResponseTranslator	No description.
resetReturnNullAllowed	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

putArg

public putArg(value: IResolvable | ExternalFunctionArg[]): void

value^Required

• Type: cdktf.IResolvable | ExternalFunctionArg[]

---

putHeader

public putHeader(value: IResolvable | ExternalFunctionHeader[]): void

value^Required

• Type: cdktf.IResolvable | ExternalFunctionHeader[]

---

resetArg

public resetArg(): void

resetComment

public resetComment(): void

resetCompression

public resetCompression(): void

resetContextHeaders

public resetContextHeaders(): void

resetHeader

public resetHeader(): void

resetId

public resetId(): void

resetMaxBatchRows

public resetMaxBatchRows(): void

resetNullInputBehavior

public resetNullInputBehavior(): void

resetRequestTranslator

public resetRequestTranslator(): void

resetResponseTranslator

public resetResponseTranslator(): void

resetReturnNullAllowed

public resetReturnNullAllowed(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a ExternalFunction resource upon running "cdktf plan ".

---

isConstruct

import { externalFunction } from '@cdktf/provider-snowflake'

externalFunction.ExternalFunction.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { externalFunction } from '@cdktf/provider-snowflake'

externalFunction.ExternalFunction.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { externalFunction } from '@cdktf/provider-snowflake'

externalFunction.ExternalFunction.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { externalFunction } from '@cdktf/provider-snowflake'

externalFunction.ExternalFunction.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a ExternalFunction resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the ExternalFunction to import.

---

importFromId^Required

• Type: string

The id of the existing ExternalFunction that should be imported.

Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the ExternalFunction to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
arg	ExternalFunctionArgList	No description.
createdOn	string	No description.
fullyQualifiedName	string	No description.
header	ExternalFunctionHeaderList	No description.
apiIntegrationInput	string	No description.
argInput	cdktf.IResolvable | ExternalFunctionArg[]	No description.
commentInput	string	No description.
compressionInput	string	No description.
contextHeadersInput	string[]	No description.
databaseInput	string	No description.
headerInput	cdktf.IResolvable | ExternalFunctionHeader[]	No description.
idInput	string	No description.
maxBatchRowsInput	number	No description.
nameInput	string	No description.
nullInputBehaviorInput	string	No description.
requestTranslatorInput	string	No description.
responseTranslatorInput	string	No description.
returnBehaviorInput	string	No description.
returnNullAllowedInput	boolean | cdktf.IResolvable	No description.
returnTypeInput	string	No description.
schemaInput	string	No description.
urlOfProxyAndResourceInput	string	No description.
apiIntegration	string	No description.
comment	string	No description.
compression	string	No description.
contextHeaders	string[]	No description.
database	string	No description.
id	string	No description.
maxBatchRows	number	No description.
name	string	No description.
nullInputBehavior	string	No description.
requestTranslator	string	No description.
responseTranslator	string	No description.
returnBehavior	string	No description.
returnNullAllowed	boolean | cdktf.IResolvable	No description.
returnType	string	No description.
schema	string	No description.
urlOfProxyAndResource	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

arg^Required

public readonly arg: ExternalFunctionArgList;

• Type: ExternalFunctionArgList

---

createdOn^Required

public readonly createdOn: string;

• Type: string

---

fullyQualifiedName^Required

public readonly fullyQualifiedName: string;

• Type: string

---

header^Required

public readonly header: ExternalFunctionHeaderList;

• Type: ExternalFunctionHeaderList

---

apiIntegrationInput^Optional

public readonly apiIntegrationInput: string;

• Type: string

---

argInput^Optional

public readonly argInput: IResolvable | ExternalFunctionArg[];

• Type: cdktf.IResolvable | ExternalFunctionArg[]

---

commentInput^Optional

public readonly commentInput: string;

• Type: string

---

compressionInput^Optional

public readonly compressionInput: string;

• Type: string

---

contextHeadersInput^Optional

public readonly contextHeadersInput: string[];

• Type: string[]

---

databaseInput^Optional

public readonly databaseInput: string;

• Type: string

---

headerInput^Optional

public readonly headerInput: IResolvable | ExternalFunctionHeader[];

• Type: cdktf.IResolvable | ExternalFunctionHeader[]

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

maxBatchRowsInput^Optional

public readonly maxBatchRowsInput: number;

• Type: number

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

nullInputBehaviorInput^Optional

public readonly nullInputBehaviorInput: string;

• Type: string

---

requestTranslatorInput^Optional

public readonly requestTranslatorInput: string;

• Type: string

---

responseTranslatorInput^Optional

public readonly responseTranslatorInput: string;

• Type: string

---

returnBehaviorInput^Optional

public readonly returnBehaviorInput: string;

• Type: string

---

returnNullAllowedInput^Optional

public readonly returnNullAllowedInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

returnTypeInput^Optional

public readonly returnTypeInput: string;

• Type: string

---

schemaInput^Optional

public readonly schemaInput: string;

• Type: string

---

urlOfProxyAndResourceInput^Optional

public readonly urlOfProxyAndResourceInput: string;

• Type: string

---

apiIntegration^Required

public readonly apiIntegration: string;

• Type: string

---

comment^Required

public readonly comment: string;

• Type: string

---

compression^Required

public readonly compression: string;

• Type: string

---

contextHeaders^Required

public readonly contextHeaders: string[];

• Type: string[]

---

database^Required

public readonly database: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

maxBatchRows^Required

public readonly maxBatchRows: number;

• Type: number

---

name^Required

public readonly name: string;

• Type: string

---

nullInputBehavior^Required

public readonly nullInputBehavior: string;

• Type: string

---

requestTranslator^Required

public readonly requestTranslator: string;

• Type: string

---

responseTranslator^Required

public readonly responseTranslator: string;

• Type: string

---

returnBehavior^Required

public readonly returnBehavior: string;

• Type: string

---

returnNullAllowed^Required

public readonly returnNullAllowed: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

returnType^Required

public readonly returnType: string;

• Type: string

---

schema^Required

public readonly schema: string;

• Type: string

---

urlOfProxyAndResource^Required

public readonly urlOfProxyAndResource: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ExternalFunctionArg

Initializer

import { externalFunction } from '@cdktf/provider-snowflake'

const externalFunctionArg: externalFunction.ExternalFunctionArg = { ... }

Properties

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

---

name^Required

public readonly name: string;

• Type: string

Argument name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#name ExternalFunction#name}

---

type^Required

public readonly type: string;

• Type: string

Argument type, e.g. VARCHAR.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#type ExternalFunction#type}

---

ExternalFunctionConfig

Initializer

import { externalFunction } from '@cdktf/provider-snowflake'

const externalFunctionConfig: externalFunction.ExternalFunctionConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
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.
name	string	Specifies the identifier for 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.
arg	cdktf.IResolvable | ExternalFunctionArg[]	arg block.
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.
header	cdktf.IResolvable | ExternalFunctionHeader[]	header block.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#id ExternalFunction#id}.
maxBatchRows	number	This specifies the maximum number of rows in each batch sent to the proxy service.
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 | cdktf.IResolvable	Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

apiIntegration^Required

public readonly apiIntegration: string;

• Type: string

The name of the API integration object that should be used to authenticate the call to the proxy service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#api_integration ExternalFunction#api_integration}

---

database^Required

public readonly database: string;

• Type: string

The database in which to create the external function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#database ExternalFunction#database}

---

name^Required

public readonly name: string;

• Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#name ExternalFunction#name}

---

returnBehavior^Required

public readonly returnBehavior: string;

• Type: string

Specifies the behavior of the function when returning results.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#return_behavior ExternalFunction#return_behavior}

---

returnType^Required

public readonly returnType: string;

• Type: string

Specifies the data type returned by the external function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#return_type ExternalFunction#return_type}

---

schema^Required

public readonly schema: string;

• Type: string

The schema in which to create the external function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#schema ExternalFunction#schema}

---

urlOfProxyAndResource^Required

public readonly urlOfProxyAndResource: string;

• Type: string

This is the invocation URL of the proxy service and resource through which Snowflake calls the remote service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#url_of_proxy_and_resource ExternalFunction#url_of_proxy_and_resource}

---

arg^Optional

public readonly arg: IResolvable | ExternalFunctionArg[];

• Type: cdktf.IResolvable | ExternalFunctionArg[]

arg block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#arg ExternalFunction#arg}

---

comment^Optional

public readonly comment: string;

• Type: string

A description of the external function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#comment ExternalFunction#comment}

---

compression^Optional

public readonly compression: string;

• Type: 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.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#compression ExternalFunction#compression}

---

contextHeaders^Optional

public readonly contextHeaders: string[];

• Type: string[]

Binds Snowflake context function results to HTTP headers.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#context_headers ExternalFunction#context_headers}

---

header^Optional

public readonly header: IResolvable | ExternalFunctionHeader[];

• Type: cdktf.IResolvable | ExternalFunctionHeader[]

header block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#header ExternalFunction#header}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#id ExternalFunction#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

maxBatchRows^Optional

public readonly maxBatchRows: number;

• Type: number

This specifies the maximum number of rows in each batch sent to the proxy service.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#max_batch_rows ExternalFunction#max_batch_rows}

---

nullInputBehavior^Optional

public readonly nullInputBehavior: string;

• Type: string

Specifies the behavior of the external function when called with null inputs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#null_input_behavior ExternalFunction#null_input_behavior}

---

requestTranslator^Optional

public readonly requestTranslator: string;

• Type: string

This specifies the name of the request translator function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#request_translator ExternalFunction#request_translator}

---

responseTranslator^Optional

public readonly responseTranslator: string;

• Type: string

This specifies the name of the response translator function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#response_translator ExternalFunction#response_translator}

---

returnNullAllowed^Optional

public readonly returnNullAllowed: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#return_null_allowed ExternalFunction#return_null_allowed}

---

ExternalFunctionHeader

Initializer

import { externalFunction } from '@cdktf/provider-snowflake'

const externalFunctionHeader: externalFunction.ExternalFunctionHeader = { ... }

Properties

Name	Type	Description
name	string	Header name.
value	string	Header value.

---

name^Required

public readonly name: string;

• Type: string

Header name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#name ExternalFunction#name}

---

value^Required

public readonly value: string;

• Type: string

Header value.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/external_function#value ExternalFunction#value}

---

Classes

ExternalFunctionArgList

Initializers

import { externalFunction } from '@cdktf/provider-snowflake'

new externalFunction.ExternalFunctionArgList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
wrapsSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
allWithMapKey	Creating an iterator for this complex list.
computeFqn	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
get	No description.

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): ExternalFunctionArgOutputReference

index^Required

• Type: number

the index of the item to return.

---

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
internalValue	cdktf.IResolvable | ExternalFunctionArg[]	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | ExternalFunctionArg[];

• Type: cdktf.IResolvable | ExternalFunctionArg[]

---

ExternalFunctionArgOutputReference

Initializers

import { externalFunction } from '@cdktf/provider-snowflake'

new externalFunction.ExternalFunctionArgOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
complexObjectIndex	number	the index of this item in the list.
complexObjectIsFromSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
nameInput	string	No description.
typeInput	string	No description.
name	string	No description.
type	string	No description.
internalValue	cdktf.IResolvable | ExternalFunctionArg	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

typeInput^Optional

public readonly typeInput: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

type^Required

public readonly type: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | ExternalFunctionArg;

• Type: cdktf.IResolvable | ExternalFunctionArg

---

ExternalFunctionHeaderList

Initializers

import { externalFunction } from '@cdktf/provider-snowflake'

new externalFunction.ExternalFunctionHeaderList(terraformResource: IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
wrapsSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
allWithMapKey	Creating an iterator for this complex list.
computeFqn	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
get	No description.

---

allWithMapKey

public allWithMapKey(mapKeyAttributeName: string): DynamicListTerraformIterator

Creating an iterator for this complex list.

The list will be converted into a map with the mapKeyAttributeName as the key.

mapKeyAttributeName^Required

• Type: string

---

computeFqn

public computeFqn(): string

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

get

public get(index: number): ExternalFunctionHeaderOutputReference

index^Required

• Type: number

the index of the item to return.

---

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
internalValue	cdktf.IResolvable | ExternalFunctionHeader[]	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | ExternalFunctionHeader[];

• Type: cdktf.IResolvable | ExternalFunctionHeader[]

---

ExternalFunctionHeaderOutputReference

Initializers

import { externalFunction } from '@cdktf/provider-snowflake'

new externalFunction.ExternalFunctionHeaderOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.
complexObjectIndex	number	the index of this item in the list.
complexObjectIsFromSet	boolean	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: number

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: boolean

whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
nameInput	string	No description.
valueInput	string	No description.
name	string	No description.
value	string	No description.
internalValue	cdktf.IResolvable | ExternalFunctionHeader	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

valueInput^Optional

public readonly valueInput: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

value^Required

public readonly value: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | ExternalFunctionHeader;

• Type: cdktf.IResolvable | ExternalFunctionHeader

---