Represents a {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/object_parameter snowflake_object_parameter}.
import { objectParameter } from '@cdktf/provider-snowflake'
new objectParameter.ObjectParameter(scope: Construct, id: string, config: ObjectParameterConfig)
Name | Type | Description |
---|---|---|
scope |
constructs.Construct |
The scope in which to define this construct. |
id |
string |
The scoped construct ID. |
config |
ObjectParameterConfig |
No description. |
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: ObjectParameterConfig
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". |
putObjectIdentifier |
No description. |
resetId |
No description. |
resetObjectIdentifier |
No description. |
resetObjectType |
No description. |
resetOnAccount |
No description. |
public toString(): string
Returns a string representation of this construct.
public addOverride(path: string, value: any): void
- Type: string
- Type: any
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
public toHclTerraform(): any
public toMetadata(): any
public toTerraform(): any
Adds this resource to the terraform JSON output.
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.
- Type: string
The string move target that will correspond to this resource.
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
public importFrom(id: string, provider?: TerraformProvider): void
- Type: string
- Type: cdktf.TerraformProvider
public interpolationForAttribute(terraformAttribute: string): IResolvable
- Type: string
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
public moveTo(moveTarget: string, index?: string | number): void
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
public putObjectIdentifier(value: IResolvable | ObjectParameterObjectIdentifier[]): void
- Type: cdktf.IResolvable | ObjectParameterObjectIdentifier[]
public resetId(): void
public resetObjectIdentifier(): void
public resetObjectType(): void
public resetOnAccount(): void
Name | Description |
---|---|
isConstruct |
Checks if x is a construct. |
isTerraformElement |
No description. |
isTerraformResource |
No description. |
generateConfigForImport |
Generates CDKTF code for importing a ObjectParameter resource upon running "cdktf plan ". |
import { objectParameter } from '@cdktf/provider-snowflake'
objectParameter.ObjectParameter.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.
- Type: any
Any object.
import { objectParameter } from '@cdktf/provider-snowflake'
objectParameter.ObjectParameter.isTerraformElement(x: any)
- Type: any
import { objectParameter } from '@cdktf/provider-snowflake'
objectParameter.ObjectParameter.isTerraformResource(x: any)
- Type: any
import { objectParameter } from '@cdktf/provider-snowflake'
objectParameter.ObjectParameter.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a ObjectParameter resource upon running "cdktf plan ".
- Type: constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the ObjectParameter to import.
- Type: string
The id of the existing ObjectParameter that should be imported.
Refer to the {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/object_parameter#import import section} in the documentation of this resource for the id to use
- Type: cdktf.TerraformProvider
? Optional instance of the provider where the ObjectParameter to import is found.
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. |
objectIdentifier |
ObjectParameterObjectIdentifierList |
No description. |
idInput |
string |
No description. |
keyInput |
string |
No description. |
objectIdentifierInput |
cdktf.IResolvable | ObjectParameterObjectIdentifier[] |
No description. |
objectTypeInput |
string |
No description. |
onAccountInput |
boolean | cdktf.IResolvable |
No description. |
valueInput |
string |
No description. |
id |
string |
No description. |
key |
string |
No description. |
objectType |
string |
No description. |
onAccount |
boolean | cdktf.IResolvable |
No description. |
value |
string |
No description. |
public readonly node: Node;
- Type: constructs.Node
The tree node.
public readonly cdktfStack: TerraformStack;
- Type: cdktf.TerraformStack
public readonly fqn: string;
- Type: string
public readonly friendlyUniqueId: string;
- Type: string
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
- Type: string
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
- Type: cdktf.TerraformProviderGeneratorMetadata
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: string[];
- Type: string[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly objectIdentifier: ObjectParameterObjectIdentifierList;
public readonly idInput: string;
- Type: string
public readonly keyInput: string;
- Type: string
public readonly objectIdentifierInput: IResolvable | ObjectParameterObjectIdentifier[];
- Type: cdktf.IResolvable | ObjectParameterObjectIdentifier[]
public readonly objectTypeInput: string;
- Type: string
public readonly onAccountInput: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly valueInput: string;
- Type: string
public readonly id: string;
- Type: string
public readonly key: string;
- Type: string
public readonly objectType: string;
- Type: string
public readonly onAccount: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
public readonly value: string;
- Type: string
Name | Type | Description |
---|---|---|
tfResourceType |
string |
No description. |
public readonly tfResourceType: string;
- Type: string
import { objectParameter } from '@cdktf/provider-snowflake'
const objectParameterConfig: objectParameter.ObjectParameterConfig = { ... }
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. |
key |
string |
Name of object parameter. Valid values are those in object parameters. |
value |
string |
Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation. |
id |
string |
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/object_parameter#id ObjectParameter#id}. |
objectIdentifier |
cdktf.IResolvable | ObjectParameterObjectIdentifier[] |
object_identifier block. |
objectType |
string |
Type of object to which the parameter applies. |
onAccount |
boolean | cdktf.IResolvable |
If true, the object parameter will be set on the account level. |
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
- Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
public readonly count: number | TerraformCount;
- Type: number | cdktf.TerraformCount
public readonly dependsOn: ITerraformDependable[];
- Type: cdktf.ITerraformDependable[]
public readonly forEach: ITerraformIterator;
- Type: cdktf.ITerraformIterator
public readonly lifecycle: TerraformResourceLifecycle;
- Type: cdktf.TerraformResourceLifecycle
public readonly provider: TerraformProvider;
- Type: cdktf.TerraformProvider
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
public readonly key: string;
- Type: string
Name of object parameter. Valid values are those in object parameters.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/object_parameter#key ObjectParameter#key}
public readonly value: string;
- Type: string
Value of object parameter, as a string. Constraints are the same as those for the parameters in Snowflake documentation.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/object_parameter#value ObjectParameter#value}
public readonly id: string;
- Type: string
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/object_parameter#id ObjectParameter#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.
public readonly objectIdentifier: IResolvable | ObjectParameterObjectIdentifier[];
- Type: cdktf.IResolvable | ObjectParameterObjectIdentifier[]
object_identifier block.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/object_parameter#object_identifier ObjectParameter#object_identifier}
public readonly objectType: string;
- Type: string
Type of object to which the parameter applies.
Valid values are those in object types. If no value is provided, then the resource will default to setting the object parameter at account level.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/object_parameter#object_type ObjectParameter#object_type}
public readonly onAccount: boolean | IResolvable;
- Type: boolean | cdktf.IResolvable
If true, the object parameter will be set on the account level.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/object_parameter#on_account ObjectParameter#on_account}
import { objectParameter } from '@cdktf/provider-snowflake'
const objectParameterObjectIdentifier: objectParameter.ObjectParameterObjectIdentifier = { ... }
Name | Type | Description |
---|---|---|
name |
string |
Name of the object to set the parameter for. |
database |
string |
Name of the database that the object was created in. |
schema |
string |
Name of the schema that the object was created in. |
public readonly name: string;
- Type: string
Name of the object to set the parameter for.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/object_parameter#name ObjectParameter#name}
public readonly database: string;
- Type: string
Name of the database that the object was created in.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/object_parameter#database ObjectParameter#database}
public readonly schema: string;
- Type: string
Name of the schema that the object was created in.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/snowflake-labs/snowflake/1.0.1/docs/resources/object_parameter#schema ObjectParameter#schema}
import { objectParameter } from '@cdktf/provider-snowflake'
new objectParameter.ObjectParameterObjectIdentifierList(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). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
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.
- Type: string
public computeFqn(): string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public get(index: number): ObjectParameterObjectIdentifierOutputReference
- Type: number
the index of the item to return.
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 | ObjectParameterObjectIdentifier[] |
No description. |
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.
public readonly fqn: string;
- Type: string
public readonly internalValue: IResolvable | ObjectParameterObjectIdentifier[];
- Type: cdktf.IResolvable | ObjectParameterObjectIdentifier[]
import { objectParameter } from '@cdktf/provider-snowflake'
new objectParameter.ObjectParameterObjectIdentifierOutputReference(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). |
- Type: cdktf.IInterpolatingParent
The parent resource.
- Type: string
The attribute on the parent resource this class is referencing.
- Type: number
the index of this item in the list.
- Type: boolean
whether the list is wrapping a set (will add tolist() to be able to access an item via an index).
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. |
resetDatabase |
No description. |
resetSchema |
No description. |
public computeFqn(): string
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
- Type: string
public getBooleanAttribute(terraformAttribute: string): IResolvable
- Type: string
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
- Type: string
public getListAttribute(terraformAttribute: string): string[]
- Type: string
public getNumberAttribute(terraformAttribute: string): number
- Type: string
public getNumberListAttribute(terraformAttribute: string): number[]
- Type: string
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
- Type: string
public getStringAttribute(terraformAttribute: string): string
- Type: string
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
- Type: string
public interpolationForAttribute(property: string): IResolvable
- Type: string
public resolve(_context: IResolveContext): any
Produce the Token's value at resolution time.
- Type: cdktf.IResolveContext
public toString(): string
Return a string representation of this resolvable object.
Returns a reversible string representation.
public resetDatabase(): void
public resetSchema(): void
Name | Type | Description |
---|---|---|
creationStack |
string[] |
The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn |
string |
No description. |
databaseInput |
string |
No description. |
nameInput |
string |
No description. |
schemaInput |
string |
No description. |
database |
string |
No description. |
name |
string |
No description. |
schema |
string |
No description. |
internalValue |
cdktf.IResolvable | ObjectParameterObjectIdentifier |
No description. |
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.
public readonly fqn: string;
- Type: string
public readonly databaseInput: string;
- Type: string
public readonly nameInput: string;
- Type: string
public readonly schemaInput: string;
- Type: string
public readonly database: string;
- Type: string
public readonly name: string;
- Type: string
public readonly schema: string;
- Type: string
public readonly internalValue: IResolvable | ObjectParameterObjectIdentifier;
- Type: cdktf.IResolvable | ObjectParameterObjectIdentifier