externalFunction.go.md

externalFunction Submodule

Constructs

ExternalFunction

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

Initializers

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externalfunction"

externalfunction.NewExternalFunction(scope Construct, id *string, config ExternalFunctionConfig) ExternalFunction

Name	Type	Description
scope	github.com/aws/constructs-go/constructs/v10.Construct	The scope in which to define this construct.
id	*string	The scoped construct ID.
config	ExternalFunctionConfig	No description.

---

scope^Required

• Type: github.com/aws/constructs-go/constructs/v10.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

func ToString() *string

Returns a string representation of this construct.

AddOverride

func AddOverride(path *string, value interface{})

path^Required

• Type: *string

---

value^Required

• Type: interface{}

---

OverrideLogicalId

func OverrideLogicalId(newLogicalId *string)

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

func ResetOverrideLogicalId()

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

ToHclTerraform

func ToHclTerraform() interface{}

ToMetadata

func ToMetadata() interface{}

ToTerraform

func ToTerraform() interface{}

Adds this resource to the terraform JSON output.

AddMoveTarget

func AddMoveTarget(moveTarget *string)

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

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

HasResourceMove

func HasResourceMove() interface{}

ImportFrom

func ImportFrom(id *string, provider TerraformProvider)

id^Required

• Type: *string

---

provider^Optional

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

---

InterpolationForAttribute

func InterpolationForAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

MoveFromId

func MoveFromId(id *string)

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

func MoveTo(moveTarget *string, index interface{})

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: interface{}

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

---

MoveToId

func MoveToId(id *string)

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

func PutArg(value interface{})

value^Required

• Type: interface{}

---

PutHeader

func PutHeader(value interface{})

value^Required

• Type: interface{}

---

ResetArg

func ResetArg()

ResetComment

func ResetComment()

ResetCompression

func ResetCompression()

ResetContextHeaders

func ResetContextHeaders()

ResetHeader

func ResetHeader()

ResetId

func ResetId()

ResetMaxBatchRows

func ResetMaxBatchRows()

ResetNullInputBehavior

func ResetNullInputBehavior()

ResetRequestTranslator

func ResetRequestTranslator()

ResetResponseTranslator

func ResetResponseTranslator()

ResetReturnNullAllowed

func ResetReturnNullAllowed()

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 "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externalfunction"

externalfunction.ExternalFunction_IsConstruct(x interface{}) *bool

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: interface{}

Any object.

---

IsTerraformElement

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externalfunction"

externalfunction.ExternalFunction_IsTerraformElement(x interface{}) *bool

x^Required

• Type: interface{}

---

IsTerraformResource

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externalfunction"

externalfunction.ExternalFunction_IsTerraformResource(x interface{}) *bool

x^Required

• Type: interface{}

---

GenerateConfigForImport

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externalfunction"

externalfunction.ExternalFunction_GenerateConfigForImport(scope Construct, importToId *string, importFromId *string, provider TerraformProvider) ImportableResource

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

scope^Required

• Type: github.com/aws/constructs-go/constructs/v10.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.4/docs/resources/external_function#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

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

---

Properties

Name	Type	Description
Node	github.com/aws/constructs-go/constructs/v10.Node	The tree node.
CdktfStack	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack	No description.
Fqn	*string	No description.
FriendlyUniqueId	*string	No description.
TerraformMetaArguments	*map[string]interface{}	No description.
TerraformResourceType	*string	No description.
TerraformGeneratorMetadata	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata	No description.
Connection	interface{}	No description.
Count	interface{}	No description.
DependsOn	*[]*string	No description.
ForEach	github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator	No description.
Lifecycle	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle	No description.
Provider	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider	No description.
Provisioners	*[]interface{}	No description.
Arg	ExternalFunctionArgList	No description.
CreatedOn	*string	No description.
FullyQualifiedName	*string	No description.
Header	ExternalFunctionHeaderList	No description.
ApiIntegrationInput	*string	No description.
ArgInput	interface{}	No description.
CommentInput	*string	No description.
CompressionInput	*string	No description.
ContextHeadersInput	*[]*string	No description.
DatabaseInput	*string	No description.
HeaderInput	interface{}	No description.
IdInput	*string	No description.
MaxBatchRowsInput	*f64	No description.
NameInput	*string	No description.
NullInputBehaviorInput	*string	No description.
RequestTranslatorInput	*string	No description.
ResponseTranslatorInput	*string	No description.
ReturnBehaviorInput	*string	No description.
ReturnNullAllowedInput	interface{}	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	*f64	No description.
Name	*string	No description.
NullInputBehavior	*string	No description.
RequestTranslator	*string	No description.
ResponseTranslator	*string	No description.
ReturnBehavior	*string	No description.
ReturnNullAllowed	interface{}	No description.
ReturnType	*string	No description.
Schema	*string	No description.
UrlOfProxyAndResource	*string	No description.

---

Node^Required

func Node() Node

• Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

---

CdktfStack^Required

func CdktfStack() TerraformStack

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformStack

---

Fqn^Required

func Fqn() *string

• Type: *string

---

FriendlyUniqueId^Required

func FriendlyUniqueId() *string

• Type: *string

---

TerraformMetaArguments^Required

func TerraformMetaArguments() *map[string]interface{}

• Type: *map[string]interface{}

---

TerraformResourceType^Required

func TerraformResourceType() *string

• Type: *string

---

TerraformGeneratorMetadata^Optional

func TerraformGeneratorMetadata() TerraformProviderGeneratorMetadata

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

func Connection() interface{}

• Type: interface{}

---

Count^Optional

func Count() interface{}

• Type: interface{}

---

DependsOn^Optional

func DependsOn() *[]*string

• Type: *[]*string

---

ForEach^Optional

func ForEach() ITerraformIterator

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

---

Lifecycle^Optional

func Lifecycle() TerraformResourceLifecycle

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

---

Provider^Optional

func Provider() TerraformProvider

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

---

Provisioners^Optional

func Provisioners() *[]interface{}

• Type: *[]interface{}

---

Arg^Required

func Arg() ExternalFunctionArgList

• Type: ExternalFunctionArgList

---

CreatedOn^Required

func CreatedOn() *string

• Type: *string

---

FullyQualifiedName^Required

func FullyQualifiedName() *string

• Type: *string

---

Header^Required

func Header() ExternalFunctionHeaderList

• Type: ExternalFunctionHeaderList

---

ApiIntegrationInput^Optional

func ApiIntegrationInput() *string

• Type: *string

---

ArgInput^Optional

func ArgInput() interface{}

• Type: interface{}

---

CommentInput^Optional

func CommentInput() *string

• Type: *string

---

CompressionInput^Optional

func CompressionInput() *string

• Type: *string

---

ContextHeadersInput^Optional

func ContextHeadersInput() *[]*string

• Type: *[]*string

---

DatabaseInput^Optional

func DatabaseInput() *string

• Type: *string

---

HeaderInput^Optional

func HeaderInput() interface{}

• Type: interface{}

---

IdInput^Optional

func IdInput() *string

• Type: *string

---

MaxBatchRowsInput^Optional

func MaxBatchRowsInput() *f64

• Type: *f64

---

NameInput^Optional

func NameInput() *string

• Type: *string

---

NullInputBehaviorInput^Optional

func NullInputBehaviorInput() *string

• Type: *string

---

RequestTranslatorInput^Optional

func RequestTranslatorInput() *string

• Type: *string

---

ResponseTranslatorInput^Optional

func ResponseTranslatorInput() *string

• Type: *string

---

ReturnBehaviorInput^Optional

func ReturnBehaviorInput() *string

• Type: *string

---

ReturnNullAllowedInput^Optional

func ReturnNullAllowedInput() interface{}

• Type: interface{}

---

ReturnTypeInput^Optional

func ReturnTypeInput() *string

• Type: *string

---

SchemaInput^Optional

func SchemaInput() *string

• Type: *string

---

UrlOfProxyAndResourceInput^Optional

func UrlOfProxyAndResourceInput() *string

• Type: *string

---

ApiIntegration^Required

func ApiIntegration() *string

• Type: *string

---

Comment^Required

func Comment() *string

• Type: *string

---

Compression^Required

func Compression() *string

• Type: *string

---

ContextHeaders^Required

func ContextHeaders() *[]*string

• Type: *[]*string

---

Database^Required

func Database() *string

• Type: *string

---

Id^Required

func Id() *string

• Type: *string

---

MaxBatchRows^Required

func MaxBatchRows() *f64

• Type: *f64

---

Name^Required

func Name() *string

• Type: *string

---

NullInputBehavior^Required

func NullInputBehavior() *string

• Type: *string

---

RequestTranslator^Required

func RequestTranslator() *string

• Type: *string

---

ResponseTranslator^Required

func ResponseTranslator() *string

• Type: *string

---

ReturnBehavior^Required

func ReturnBehavior() *string

• Type: *string

---

ReturnNullAllowed^Required

func ReturnNullAllowed() interface{}

• Type: interface{}

---

ReturnType^Required

func ReturnType() *string

• Type: *string

---

Schema^Required

func Schema() *string

• Type: *string

---

UrlOfProxyAndResource^Required

func UrlOfProxyAndResource() *string

• Type: *string

---

Constants

Name	Type	Description
TfResourceType	*string	No description.

---

TfResourceType^Required

func TfResourceType() *string

• Type: *string

---

Structs

ExternalFunctionArg

Initializer

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externalfunction"

&externalfunction.ExternalFunctionArg {
	Name: *string,
	Type: *string,
}

Properties

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

---

Name^Required

Name *string

• Type: *string

Argument name.

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

---

Type^Required

Type *string

• Type: *string

Argument type, e.g. VARCHAR.

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

---

ExternalFunctionConfig

Initializer

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externalfunction"

&externalfunction.ExternalFunctionConfig {
	Connection: interface{},
	Count: interface{},
	DependsOn: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable,
	ForEach: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator,
	Lifecycle: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle,
	Provider: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider,
	Provisioners: *[]interface{},
	ApiIntegration: *string,
	Database: *string,
	Name: *string,
	ReturnBehavior: *string,
	ReturnType: *string,
	Schema: *string,
	UrlOfProxyAndResource: *string,
	Arg: interface{},
	Comment: *string,
	Compression: *string,
	ContextHeaders: *[]*string,
	Header: interface{},
	Id: *string,
	MaxBatchRows: *f64,
	NullInputBehavior: *string,
	RequestTranslator: *string,
	ResponseTranslator: *string,
	ReturnNullAllowed: interface{},
}

Properties

Name	Type	Description
Connection	interface{}	No description.
Count	interface{}	No description.
DependsOn	*[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable	No description.
ForEach	github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator	No description.
Lifecycle	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle	No description.
Provider	github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider	No description.
Provisioners	*[]interface{}	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	interface{}	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	interface{}	header block.
Id	*string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/docs/resources/external_function#id ExternalFunction#id}.
MaxBatchRows	*f64	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	interface{}	Indicates whether the function can return NULL values (true) or must return only NON-NULL values (false).

---

Connection^Optional

Connection interface{}

• Type: interface{}

---

Count^Optional

Count interface{}

• Type: interface{}

---

DependsOn^Optional

DependsOn *[]ITerraformDependable

• Type: *[]github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformDependable

---

ForEach^Optional

ForEach ITerraformIterator

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.ITerraformIterator

---

Lifecycle^Optional

Lifecycle TerraformResourceLifecycle

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformResourceLifecycle

---

Provider^Optional

Provider TerraformProvider

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.TerraformProvider

---

Provisioners^Optional

Provisioners *[]interface{}

• Type: *[]interface{}

---

ApiIntegration^Required

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.4/docs/resources/external_function#api_integration ExternalFunction#api_integration}

---

Database^Required

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.4/docs/resources/external_function#database ExternalFunction#database}

---

Name^Required

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.4/docs/resources/external_function#name ExternalFunction#name}

---

ReturnBehavior^Required

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.4/docs/resources/external_function#return_behavior ExternalFunction#return_behavior}

---

ReturnType^Required

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.4/docs/resources/external_function#return_type ExternalFunction#return_type}

---

Schema^Required

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.4/docs/resources/external_function#schema ExternalFunction#schema}

---

UrlOfProxyAndResource^Required

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.4/docs/resources/external_function#url_of_proxy_and_resource ExternalFunction#url_of_proxy_and_resource}

---

Arg^Optional

Arg interface{}

• Type: interface{}

arg block.

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

---

Comment^Optional

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.4/docs/resources/external_function#comment ExternalFunction#comment}

---

Compression^Optional

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.4/docs/resources/external_function#compression ExternalFunction#compression}

---

ContextHeaders^Optional

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.4/docs/resources/external_function#context_headers ExternalFunction#context_headers}

---

Header^Optional

Header interface{}

• Type: interface{}

header block.

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

---

Id^Optional

Id *string

• Type: *string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.4/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

MaxBatchRows *f64

• Type: *f64

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.4/docs/resources/external_function#max_batch_rows ExternalFunction#max_batch_rows}

---

NullInputBehavior^Optional

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.4/docs/resources/external_function#null_input_behavior ExternalFunction#null_input_behavior}

---

RequestTranslator^Optional

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.4/docs/resources/external_function#request_translator ExternalFunction#request_translator}

---

ResponseTranslator^Optional

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.4/docs/resources/external_function#response_translator ExternalFunction#response_translator}

---

ReturnNullAllowed^Optional

ReturnNullAllowed interface{}

• Type: interface{}

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.4/docs/resources/external_function#return_null_allowed ExternalFunction#return_null_allowed}

---

ExternalFunctionHeader

Initializer

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externalfunction"

&externalfunction.ExternalFunctionHeader {
	Name: *string,
	Value: *string,
}

Properties

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

---

Name^Required

Name *string

• Type: *string

Header name.

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

---

Value^Required

Value *string

• Type: *string

Header value.

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

---

Classes

ExternalFunctionArgList

Initializers

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externalfunction"

externalfunction.NewExternalFunctionArgList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) ExternalFunctionArgList

Name	Type	Description
terraformResource	github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	*string	The attribute on the parent resource this class is referencing.
wrapsSet	*bool	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: *string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: *bool

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

func 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

func ComputeFqn() *string

Resolve

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_context^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

---

ToString

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get

func Get(index *f64) ExternalFunctionArgOutputReference

index^Required

• Type: *f64

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	interface{}	No description.

---

CreationStack^Required

func 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

func Fqn() *string

• Type: *string

---

InternalValue^Optional

func InternalValue() interface{}

• Type: interface{}

---

ExternalFunctionArgOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externalfunction"

externalfunction.NewExternalFunctionArgOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string, complexObjectIndex *f64, complexObjectIsFromSet *bool) ExternalFunctionArgOutputReference

Name	Type	Description
terraformResource	github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	*string	The attribute on the parent resource this class is referencing.
complexObjectIndex	*f64	the index of this item in the list.
complexObjectIsFromSet	*bool	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: *string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: *f64

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: *bool

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

func ComputeFqn() *string

GetAnyMapAttribute

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

InterpolationForAttribute

func InterpolationForAttribute(property *string) IResolvable

property^Required

• Type: *string

---

Resolve

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_context^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

---

ToString

func 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	interface{}	No description.

---

CreationStack^Required

func 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

func Fqn() *string

• Type: *string

---

NameInput^Optional

func NameInput() *string

• Type: *string

---

TypeInput^Optional

func TypeInput() *string

• Type: *string

---

Name^Required

func Name() *string

• Type: *string

---

Type^Required

func Type() *string

• Type: *string

---

InternalValue^Optional

func InternalValue() interface{}

• Type: interface{}

---

ExternalFunctionHeaderList

Initializers

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externalfunction"

externalfunction.NewExternalFunctionHeaderList(terraformResource IInterpolatingParent, terraformAttribute *string, wrapsSet *bool) ExternalFunctionHeaderList

Name	Type	Description
terraformResource	github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	*string	The attribute on the parent resource this class is referencing.
wrapsSet	*bool	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: *string

The attribute on the parent resource this class is referencing.

---

wrapsSet^Required

• Type: *bool

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

func 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

func ComputeFqn() *string

Resolve

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_context^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

---

ToString

func ToString() *string

Return a string representation of this resolvable object.

Returns a reversible string representation.

Get

func Get(index *f64) ExternalFunctionHeaderOutputReference

index^Required

• Type: *f64

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	interface{}	No description.

---

CreationStack^Required

func 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

func Fqn() *string

• Type: *string

---

InternalValue^Optional

func InternalValue() interface{}

• Type: interface{}

---

ExternalFunctionHeaderOutputReference

Initializers

import "github.com/cdktf/cdktf-provider-snowflake-go/snowflake/v12/externalfunction"

externalfunction.NewExternalFunctionHeaderOutputReference(terraformResource IInterpolatingParent, terraformAttribute *string, complexObjectIndex *f64, complexObjectIsFromSet *bool) ExternalFunctionHeaderOutputReference

Name	Type	Description
terraformResource	github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	*string	The attribute on the parent resource this class is referencing.
complexObjectIndex	*f64	the index of this item in the list.
complexObjectIsFromSet	*bool	whether the list is wrapping a set (will add tolist() to be able to access an item via an index).

---

terraformResource^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: *string

The attribute on the parent resource this class is referencing.

---

complexObjectIndex^Required

• Type: *f64

the index of this item in the list.

---

complexObjectIsFromSet^Required

• Type: *bool

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

func ComputeFqn() *string

GetAnyMapAttribute

func GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}

terraformAttribute^Required

• Type: *string

---

GetBooleanAttribute

func GetBooleanAttribute(terraformAttribute *string) IResolvable

terraformAttribute^Required

• Type: *string

---

GetBooleanMapAttribute

func GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool

terraformAttribute^Required

• Type: *string

---

GetListAttribute

func GetListAttribute(terraformAttribute *string) *[]*string

terraformAttribute^Required

• Type: *string

---

GetNumberAttribute

func GetNumberAttribute(terraformAttribute *string) *f64

terraformAttribute^Required

• Type: *string

---

GetNumberListAttribute

func GetNumberListAttribute(terraformAttribute *string) *[]*f64

terraformAttribute^Required

• Type: *string

---

GetNumberMapAttribute

func GetNumberMapAttribute(terraformAttribute *string) *map[string]*f64

terraformAttribute^Required

• Type: *string

---

GetStringAttribute

func GetStringAttribute(terraformAttribute *string) *string

terraformAttribute^Required

• Type: *string

---

GetStringMapAttribute

func GetStringMapAttribute(terraformAttribute *string) *map[string]*string

terraformAttribute^Required

• Type: *string

---

InterpolationForAttribute

func InterpolationForAttribute(property *string) IResolvable

property^Required

• Type: *string

---

Resolve

func Resolve(_context IResolveContext) interface{}

Produce the Token's value at resolution time.

_context^Required

• Type: github.com/hashicorp/terraform-cdk-go/cdktf.IResolveContext

---

ToString

func 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	interface{}	No description.

---

CreationStack^Required

func 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

func Fqn() *string

• Type: *string

---

NameInput^Optional

func NameInput() *string

• Type: *string

---

ValueInput^Optional

func ValueInput() *string

• Type: *string

---

Name^Required

func Name() *string

• Type: *string

---

Value^Required

func Value() *string

• Type: *string

---

InternalValue^Optional

func InternalValue() interface{}

• Type: interface{}

---