functionResource.typescript.md

functionResource Submodule

Constructs

FunctionResource

Represents a {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function postgresql_function}.

Initializers

import { functionResource } from '@cdktf/provider-postgresql'

new functionResource.FunctionResource(scope: Construct, id: string, config: FunctionResourceConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	FunctionResourceConfig	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: FunctionResourceConfig

---

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.
resetArg	No description.
resetDatabase	No description.
resetDropCascade	No description.
resetId	No description.
resetLanguage	No description.
resetParallel	No description.
resetReturns	No description.
resetSchema	No description.
resetSecurityDefiner	No description.
resetStrict	No description.
resetVolatility	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 | FunctionResourceArg[]): void

value^Required

• Type: cdktf.IResolvable | FunctionResourceArg[]

---

resetArg

public resetArg(): void

resetDatabase

public resetDatabase(): void

resetDropCascade

public resetDropCascade(): void

resetId

public resetId(): void

resetLanguage

public resetLanguage(): void

resetParallel

public resetParallel(): void

resetReturns

public resetReturns(): void

resetSchema

public resetSchema(): void

resetSecurityDefiner

public resetSecurityDefiner(): void

resetStrict

public resetStrict(): void

resetVolatility

public resetVolatility(): 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 FunctionResource resource upon running "cdktf plan ".

---

isConstruct

import { functionResource } from '@cdktf/provider-postgresql'

functionResource.FunctionResource.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 { functionResource } from '@cdktf/provider-postgresql'

functionResource.FunctionResource.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { functionResource } from '@cdktf/provider-postgresql'

functionResource.FunctionResource.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { functionResource } from '@cdktf/provider-postgresql'

functionResource.FunctionResource.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a FunctionResource 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 FunctionResource to import.

---

importFromId^Required

• Type: string

The id of the existing FunctionResource that should be imported.

Refer to the {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/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 FunctionResource 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	FunctionResourceArgList	No description.
argInput	cdktf.IResolvable | FunctionResourceArg[]	No description.
bodyInput	string	No description.
databaseInput	string	No description.
dropCascadeInput	boolean | cdktf.IResolvable	No description.
idInput	string	No description.
languageInput	string	No description.
nameInput	string	No description.
parallelInput	string	No description.
returnsInput	string	No description.
schemaInput	string	No description.
securityDefinerInput	boolean | cdktf.IResolvable	No description.
strictInput	boolean | cdktf.IResolvable	No description.
volatilityInput	string	No description.
body	string	No description.
database	string	No description.
dropCascade	boolean | cdktf.IResolvable	No description.
id	string	No description.
language	string	No description.
name	string	No description.
parallel	string	No description.
returns	string	No description.
schema	string	No description.
securityDefiner	boolean | cdktf.IResolvable	No description.
strict	boolean | cdktf.IResolvable	No description.
volatility	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: FunctionResourceArgList;

• Type: FunctionResourceArgList

---

argInput^Optional

public readonly argInput: IResolvable | FunctionResourceArg[];

• Type: cdktf.IResolvable | FunctionResourceArg[]

---

bodyInput^Optional

public readonly bodyInput: string;

• Type: string

---

databaseInput^Optional

public readonly databaseInput: string;

• Type: string

---

dropCascadeInput^Optional

public readonly dropCascadeInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

languageInput^Optional

public readonly languageInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

parallelInput^Optional

public readonly parallelInput: string;

• Type: string

---

returnsInput^Optional

public readonly returnsInput: string;

• Type: string

---

schemaInput^Optional

public readonly schemaInput: string;

• Type: string

---

securityDefinerInput^Optional

public readonly securityDefinerInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

strictInput^Optional

public readonly strictInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

volatilityInput^Optional

public readonly volatilityInput: string;

• Type: string

---

body^Required

public readonly body: string;

• Type: string

---

database^Required

public readonly database: string;

• Type: string

---

dropCascade^Required

public readonly dropCascade: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

id^Required

public readonly id: string;

• Type: string

---

language^Required

public readonly language: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

parallel^Required

public readonly parallel: string;

• Type: string

---

returns^Required

public readonly returns: string;

• Type: string

---

schema^Required

public readonly schema: string;

• Type: string

---

securityDefiner^Required

public readonly securityDefiner: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

strict^Required

public readonly strict: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

volatility^Required

public readonly volatility: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

FunctionResourceArg

Initializer

import { functionResource } from '@cdktf/provider-postgresql'

const functionResourceArg: functionResource.FunctionResourceArg = { ... }

Properties

Name	Type	Description
type	string	The argument type.
default	string	An expression to be used as default value if the parameter is not specified.
mode	string	The argument mode. One of: IN, OUT, INOUT, or VARIADIC.
name	string	The argument name. The name may be required for some languages or depending on the argument mode.

---

type^Required

public readonly type: string;

• Type: string

The argument type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#type FunctionResource#type}

---

default^Optional

public readonly default: string;

• Type: string

An expression to be used as default value if the parameter is not specified.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#default FunctionResource#default}

---

mode^Optional

public readonly mode: string;

• Type: string

The argument mode. One of: IN, OUT, INOUT, or VARIADIC.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#mode FunctionResource#mode}

---

name^Optional

public readonly name: string;

• Type: string

The argument name. The name may be required for some languages or depending on the argument mode.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#name FunctionResource#name}

---

FunctionResourceConfig

Initializer

import { functionResource } from '@cdktf/provider-postgresql'

const functionResourceConfig: functionResource.FunctionResourceConfig = { ... }

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.
body	string	Body of the function.
name	string	Name of the function.
arg	cdktf.IResolvable | FunctionResourceArg[]	arg block.
database	string	The database where the function is located. If not specified, the provider default database is used.
dropCascade	boolean | cdktf.IResolvable	Automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#id FunctionResource#id}.
language	string	Language of theof the function. One of: internal, sql, c, plpgsql.
parallel	string	If the function can be executed in parallel for a single query execution. One of: UNSAFE, RESTRICTED, SAFE.
returns	string	Function return type. If not specified, it will be calculated based on the output arguments.
schema	string	Schema where the function is located. If not specified, the provider default schema is used.
securityDefiner	boolean | cdktf.IResolvable	If the function should execute with the permissions of the function owner instead of the permissions of the caller.
strict	boolean | cdktf.IResolvable	If the function should always return NULL if any of it's inputs is NULL.
volatility	string	Volatility of the function. One of: VOLATILE, STABLE, IMMUTABLE.

---

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[]

---

body^Required

public readonly body: string;

• Type: string

Body of the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#body FunctionResource#body}

---

name^Required

public readonly name: string;

• Type: string

Name of the function.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#name FunctionResource#name}

---

arg^Optional

public readonly arg: IResolvable | FunctionResourceArg[];

• Type: cdktf.IResolvable | FunctionResourceArg[]

arg block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#arg FunctionResource#arg}

---

database^Optional

public readonly database: string;

• Type: string

The database where the function is located. If not specified, the provider default database is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#database FunctionResource#database}

---

dropCascade^Optional

public readonly dropCascade: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Automatically drop objects that depend on the function (such as operators or triggers), and in turn all objects that depend on those objects.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#drop_cascade FunctionResource#drop_cascade}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#id FunctionResource#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.

---

language^Optional

public readonly language: string;

• Type: string

Language of theof the function. One of: internal, sql, c, plpgsql.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#language FunctionResource#language}

---

parallel^Optional

public readonly parallel: string;

• Type: string

If the function can be executed in parallel for a single query execution. One of: UNSAFE, RESTRICTED, SAFE.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#parallel FunctionResource#parallel}

---

returns^Optional

public readonly returns: string;

• Type: string

Function return type. If not specified, it will be calculated based on the output arguments.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#returns FunctionResource#returns}

---

schema^Optional

public readonly schema: string;

• Type: string

Schema where the function is located. If not specified, the provider default schema is used.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#schema FunctionResource#schema}

---

securityDefiner^Optional

public readonly securityDefiner: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

If the function should execute with the permissions of the function owner instead of the permissions of the caller.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#security_definer FunctionResource#security_definer}

---

strict^Optional

public readonly strict: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

If the function should always return NULL if any of it's inputs is NULL.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#strict FunctionResource#strict}

---

volatility^Optional

public readonly volatility: string;

• Type: string

Volatility of the function. One of: VOLATILE, STABLE, IMMUTABLE.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/cyrilgdn/postgresql/1.25.0/docs/resources/function#volatility FunctionResource#volatility}

---

Classes

FunctionResourceArgList

Initializers

import { functionResource } from '@cdktf/provider-postgresql'

new functionResource.FunctionResourceArgList(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): FunctionResourceArgOutputReference

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 | FunctionResourceArg[]	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 | FunctionResourceArg[];

• Type: cdktf.IResolvable | FunctionResourceArg[]

---

FunctionResourceArgOutputReference

Initializers

import { functionResource } from '@cdktf/provider-postgresql'

new functionResource.FunctionResourceArgOutputReference(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.
resetDefault	No description.
resetMode	No description.
resetName	No description.

---

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.

resetDefault

public resetDefault(): void

resetMode

public resetMode(): void

resetName

public resetName(): void

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.
defaultInput	string	No description.
modeInput	string	No description.
nameInput	string	No description.
typeInput	string	No description.
default	string	No description.
mode	string	No description.
name	string	No description.
type	string	No description.
internalValue	cdktf.IResolvable | FunctionResourceArg	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

---

defaultInput^Optional

public readonly defaultInput: string;

• Type: string

---

modeInput^Optional

public readonly modeInput: string;

• Type: string

---

nameInput^Optional

public readonly nameInput: string;

• Type: string

---

typeInput^Optional

public readonly typeInput: string;

• Type: string

---

default^Required

public readonly default: string;

• Type: string

---

mode^Required

public readonly mode: 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 | FunctionResourceArg;

• Type: cdktf.IResolvable | FunctionResourceArg

---