Skip to content

Latest commit

 

History

History
2016 lines (1242 loc) · 79.3 KB

procedure.typescript.md

File metadata and controls

2016 lines (1242 loc) · 79.3 KB
Raw

procedure Submodule

Constructs

Procedure

Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure snowflake_procedure}.

Initializers 

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

new procedure.Procedure(scope: Construct, id: string, config: ProcedureConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config ProcedureConfig No description.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

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".
putArguments No description.
resetArguments No description.
resetComment No description.
resetExecuteAs No description.
resetHandler No description.
resetId No description.
resetImports No description.
resetLanguage No description.
resetNullInputBehavior No description.
resetPackages No description.
resetReturnBehavior No description.
resetRuntimeVersion No description.
resetSecure No description.
toString 
public toString(): string

Returns a string representation of this construct.

addOverride 
public addOverride(path: string, value: any): void
pathRequired
  • Type: string
valueRequired
  • Type: any
overrideLogicalId 
public overrideLogicalId(newLogicalId: string): void

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

newLogicalIdRequired
  • 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.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

getAnyMapAttribute 
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
hasResourceMove 
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom 
public importFrom(id: string, provider?: TerraformProvider): void
idRequired
  • Type: string
providerOptional
  • Type: cdktf.TerraformProvider
interpolationForAttribute 
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • 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.

idRequired
  • 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.

moveTargetRequired
  • Type: string

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

indexOptional
  • 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".

idRequired
  • Type: string

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

putArguments 
public putArguments(value: IResolvable | ProcedureArguments[]): void
valueRequired
resetArguments 
public resetArguments(): void
resetComment 
public resetComment(): void
resetExecuteAs 
public resetExecuteAs(): void
resetHandler 
public resetHandler(): void
resetId 
public resetId(): void
resetImports 
public resetImports(): void
resetLanguage 
public resetLanguage(): void
resetNullInputBehavior 
public resetNullInputBehavior(): void
resetPackages 
public resetPackages(): void
resetReturnBehavior 
public resetReturnBehavior(): void
resetRuntimeVersion 
public resetRuntimeVersion(): void
resetSecure 
public resetSecure(): 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 Procedure resource upon running "cdktf plan ".
isConstruct 
import { procedure } from '@cdktf/provider-snowflake'

procedure.Procedure.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.

xRequired
  • Type: any

Any object.

isTerraformElement 
import { procedure } from '@cdktf/provider-snowflake'

procedure.Procedure.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { procedure } from '@cdktf/provider-snowflake'

procedure.Procedure.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { procedure } from '@cdktf/provider-snowflake'

procedure.Procedure.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: string

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

importFromIdRequired
  • Type: string

The id of the existing Procedure that should be imported.

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

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the Procedure 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.
arguments ProcedureArgumentsList No description.
argumentsInput cdktf.IResolvable | ProcedureArguments[] No description.
commentInput string No description.
databaseInput string No description.
executeAsInput string No description.
handlerInput string No description.
idInput string No description.
importsInput string[] No description.
languageInput string No description.
nameInput string No description.
nullInputBehaviorInput string No description.
packagesInput string[] No description.
returnBehaviorInput string No description.
returnTypeInput string No description.
runtimeVersionInput string No description.
schemaInput string No description.
secureInput boolean | cdktf.IResolvable No description.
statementInput string No description.
comment string No description.
database string No description.
executeAs string No description.
handler string No description.
id string No description.
imports string[] No description.
language string No description.
name string No description.
nullInputBehavior string No description.
packages string[] No description.
returnBehavior string No description.
returnType string No description.
runtimeVersion string No description.
schema string No description.
secure boolean | cdktf.IResolvable No description.
statement string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
argumentsRequired 
public readonly arguments: ProcedureArgumentsList;
argumentsInputOptional 
public readonly argumentsInput: IResolvable | ProcedureArguments[];
commentInputOptional 
public readonly commentInput: string;
  • Type: string
databaseInputOptional 
public readonly databaseInput: string;
  • Type: string
executeAsInputOptional 
public readonly executeAsInput: string;
  • Type: string
handlerInputOptional 
public readonly handlerInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
importsInputOptional 
public readonly importsInput: string[];
  • Type: string[]
languageInputOptional 
public readonly languageInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
nullInputBehaviorInputOptional 
public readonly nullInputBehaviorInput: string;
  • Type: string
packagesInputOptional 
public readonly packagesInput: string[];
  • Type: string[]
returnBehaviorInputOptional 
public readonly returnBehaviorInput: string;
  • Type: string
returnTypeInputOptional 
public readonly returnTypeInput: string;
  • Type: string
runtimeVersionInputOptional 
public readonly runtimeVersionInput: string;
  • Type: string
schemaInputOptional 
public readonly schemaInput: string;
  • Type: string
secureInputOptional 
public readonly secureInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
statementInputOptional 
public readonly statementInput: string;
  • Type: string
commentRequired 
public readonly comment: string;
  • Type: string
databaseRequired 
public readonly database: string;
  • Type: string
executeAsRequired 
public readonly executeAs: string;
  • Type: string
handlerRequired 
public readonly handler: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
importsRequired 
public readonly imports: string[];
  • Type: string[]
languageRequired 
public readonly language: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
nullInputBehaviorRequired 
public readonly nullInputBehavior: string;
  • Type: string
packagesRequired 
public readonly packages: string[];
  • Type: string[]
returnBehaviorRequired 
public readonly returnBehavior: string;
  • Type: string
returnTypeRequired 
public readonly returnType: string;
  • Type: string
runtimeVersionRequired 
public readonly runtimeVersion: string;
  • Type: string
schemaRequired 
public readonly schema: string;
  • Type: string
secureRequired 
public readonly secure: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
statementRequired 
public readonly statement: string;
  • Type: string

Constants

Name Type Description
tfResourceType string No description.
tfResourceTypeRequired 
public readonly tfResourceType: string;
  • Type: string

Structs

ProcedureArguments

Initializer 

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

const procedureArguments: procedure.ProcedureArguments = { ... }

Properties

Name Type Description
name string The argument name.
type string The argument type.
nameRequired 
public readonly name: string;
  • Type: string

The argument name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#name Procedure#name}

typeRequired 
public readonly type: string;
  • Type: string

The argument type.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#type Procedure#type}

ProcedureConfig

Initializer 

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

const procedureConfig: procedure.ProcedureConfig = { ... }

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.
database string The database in which to create the procedure. Don't use the | character.
name string Specifies the identifier for the procedure;
returnType string The return type of the procedure.
schema string The schema in which to create the procedure. Don't use the | character.
statement string Specifies the code used to create the procedure.
arguments cdktf.IResolvable | ProcedureArguments[] arguments block.
comment string Specifies a comment for the procedure.
executeAs string Sets execution context.
handler string The handler method for Java / Python procedures.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#id Procedure#id}.
imports string[] Imports for Java / Python procedures.
language string Specifies the language of the stored procedure code.
nullInputBehavior string Specifies the behavior of the procedure when called with null inputs.
packages string[] List of package imports to use for Java / Python procedures.
returnBehavior string Specifies the behavior of the function when returning results.
runtimeVersion string Required for Python procedures. Specifies Python runtime version.
secure boolean | cdktf.IResolvable Specifies that the procedure is secure.
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: ITerraformDependable[];
  • Type: cdktf.ITerraformDependable[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
databaseRequired 
public readonly database: string;
  • Type: string

The database in which to create the procedure. Don't use the | character.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#database Procedure#database}

nameRequired 
public readonly name: string;
  • Type: string

Specifies the identifier for the procedure;

does not have to be unique for the schema in which the procedure is created. Don't use the | character.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#name Procedure#name}

returnTypeRequired 
public readonly returnType: string;
  • Type: string

The return type of the procedure.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#return_type Procedure#return_type}

schemaRequired 
public readonly schema: string;
  • Type: string

The schema in which to create the procedure. Don't use the | character.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#schema Procedure#schema}

statementRequired 
public readonly statement: string;
  • Type: string

Specifies the code used to create the procedure.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#statement Procedure#statement}

argumentsOptional 
public readonly arguments: IResolvable | ProcedureArguments[];

arguments block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#arguments Procedure#arguments}

commentOptional 
public readonly comment: string;
  • Type: string

Specifies a comment for the procedure.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#comment Procedure#comment}

executeAsOptional 
public readonly executeAs: string;
  • Type: string

Sets execution context.

Allowed values are CALLER and OWNER (consult a proper section in the docs). For more information see caller's rights and owner's rights.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#execute_as Procedure#execute_as}

handlerOptional 
public readonly handler: string;
  • Type: string

The handler method for Java / Python procedures.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#handler Procedure#handler}

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#id Procedure#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.

importsOptional 
public readonly imports: string[];
  • Type: string[]

Imports for Java / Python procedures.

For Java this a list of jar files, for Python this is a list of Python files.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#imports Procedure#imports}

languageOptional 
public readonly language: string;
  • Type: string

Specifies the language of the stored procedure code.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#language Procedure#language}

nullInputBehaviorOptional 
public readonly nullInputBehavior: string;
  • Type: string

Specifies the behavior of the procedure when called with null inputs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#null_input_behavior Procedure#null_input_behavior}

packagesOptional 
public readonly packages: string[];
  • Type: string[]

List of package imports to use for Java / Python procedures.

For Java, package imports should be of the form: package_name:version_number, where package_name is snowflake_domain:package. For Python use it should be: ('numpy','pandas','xgboost==1.5.0').

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#packages Procedure#packages}

returnBehaviorOptional 
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/0.91.0/docs/resources/procedure#return_behavior Procedure#return_behavior}

runtimeVersionOptional 
public readonly runtimeVersion: string;
  • Type: string

Required for Python procedures. Specifies Python runtime version.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#runtime_version Procedure#runtime_version}

secureOptional 
public readonly secure: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Specifies that the procedure is secure.

For more information about secure procedures, see Protecting Sensitive Information with Secure UDFs and Stored Procedures.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/0.91.0/docs/resources/procedure#secure Procedure#secure}

Classes

ProcedureArgumentsList

Initializers 

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

new procedure.ProcedureArgumentsList(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).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

wrapsSetRequired
  • 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.

mapKeyAttributeNameRequired
  • Type: string
computeFqn 
public computeFqn(): string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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): ProcedureArgumentsOutputReference
indexRequired
  • 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 | ProcedureArguments[] No description.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | ProcedureArguments[];

ProcedureArgumentsOutputReference

Initializers 

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

new procedure.ProcedureArgumentsOutputReference(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).
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

complexObjectIndexRequired
  • Type: number

the index of this item in the list.

complexObjectIsFromSetRequired
  • 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}
terraformAttributeRequired
  • Type: string
getBooleanAttribute 
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
getBooleanMapAttribute 
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttributeRequired
  • Type: string
getListAttribute 
public getListAttribute(terraformAttribute: string): string[]
terraformAttributeRequired
  • Type: string
getNumberAttribute 
public getNumberAttribute(terraformAttribute: string): number
terraformAttributeRequired
  • Type: string
getNumberListAttribute 
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttributeRequired
  • Type: string
getNumberMapAttribute 
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttributeRequired
  • Type: string
getStringAttribute 
public getStringAttribute(terraformAttribute: string): string
terraformAttributeRequired
  • Type: string
getStringMapAttribute 
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttributeRequired
  • Type: string
interpolationForAttribute 
public interpolationForAttribute(property: string): IResolvable
propertyRequired
  • Type: string
resolve 
public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_contextRequired
  • 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 | ProcedureArguments No description.
creationStackRequired 
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.

fqnRequired 
public readonly fqn: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
typeInputOptional 
public readonly typeInput: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
typeRequired 
public readonly type: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | ProcedureArguments;