Skip to content

Latest commit

 

History

History
2161 lines (1340 loc) · 85.3 KB

table.typescript.md

File metadata and controls

2161 lines (1340 loc) · 85.3 KB
Raw

table Submodule

Constructs

Table

Represents a {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table databricks_table}.

Initializers 

import { table } from '@cdktf/provider-databricks'

new table.Table(scope: Construct, id: string, config: TableConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config TableConfig 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".
putColumn No description.
resetComment No description.
resetId No description.
resetOwner No description.
resetProperties No description.
resetStorageCredentialName No description.
resetStorageLocation No description.
resetViewDefinition 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".

putColumn 
public putColumn(value: IResolvable | TableColumn[]): void
valueRequired
resetComment 
public resetComment(): void
resetId 
public resetId(): void
resetOwner 
public resetOwner(): void
resetProperties 
public resetProperties(): void
resetStorageCredentialName 
public resetStorageCredentialName(): void
resetStorageLocation 
public resetStorageLocation(): void
resetViewDefinition 
public resetViewDefinition(): 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 Table resource upon running "cdktf plan ".
isConstruct 
import { table } from '@cdktf/provider-databricks'

table.Table.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 { table } from '@cdktf/provider-databricks'

table.Table.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformResource 
import { table } from '@cdktf/provider-databricks'

table.Table.isTerraformResource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { table } from '@cdktf/provider-databricks'

table.Table.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing Table that should be imported.

Refer to the {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#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 Table 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.
column TableColumnList No description.
catalogNameInput string No description.
columnInput cdktf.IResolvable | TableColumn[] No description.
commentInput string No description.
dataSourceFormatInput string No description.
idInput string No description.
nameInput string No description.
ownerInput string No description.
propertiesInput {[ key: string ]: string} No description.
schemaNameInput string No description.
storageCredentialNameInput string No description.
storageLocationInput string No description.
tableTypeInput string No description.
viewDefinitionInput string No description.
catalogName string No description.
comment string No description.
dataSourceFormat string No description.
id string No description.
name string No description.
owner string No description.
properties {[ key: string ]: string} No description.
schemaName string No description.
storageCredentialName string No description.
storageLocation string No description.
tableType string No description.
viewDefinition 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[]
columnRequired 
public readonly column: TableColumnList;
catalogNameInputOptional 
public readonly catalogNameInput: string;
  • Type: string
columnInputOptional 
public readonly columnInput: IResolvable | TableColumn[];
commentInputOptional 
public readonly commentInput: string;
  • Type: string
dataSourceFormatInputOptional 
public readonly dataSourceFormatInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
ownerInputOptional 
public readonly ownerInput: string;
  • Type: string
propertiesInputOptional 
public readonly propertiesInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
schemaNameInputOptional 
public readonly schemaNameInput: string;
  • Type: string
storageCredentialNameInputOptional 
public readonly storageCredentialNameInput: string;
  • Type: string
storageLocationInputOptional 
public readonly storageLocationInput: string;
  • Type: string
tableTypeInputOptional 
public readonly tableTypeInput: string;
  • Type: string
viewDefinitionInputOptional 
public readonly viewDefinitionInput: string;
  • Type: string
catalogNameRequired 
public readonly catalogName: string;
  • Type: string
commentRequired 
public readonly comment: string;
  • Type: string
dataSourceFormatRequired 
public readonly dataSourceFormat: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
ownerRequired 
public readonly owner: string;
  • Type: string
propertiesRequired 
public readonly properties: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
schemaNameRequired 
public readonly schemaName: string;
  • Type: string
storageCredentialNameRequired 
public readonly storageCredentialName: string;
  • Type: string
storageLocationRequired 
public readonly storageLocation: string;
  • Type: string
tableTypeRequired 
public readonly tableType: string;
  • Type: string
viewDefinitionRequired 
public readonly viewDefinition: string;
  • Type: string

Constants

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

Structs

TableColumn

Initializer 

import { table } from '@cdktf/provider-databricks'

const tableColumn: table.TableColumn = { ... }

Properties

Name Type Description
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#name Table#name}.
position number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#position Table#position}.
typeName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#type_name Table#type_name}.
typeText string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#type_text Table#type_text}.
comment string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#comment Table#comment}.
nullable boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#nullable Table#nullable}.
partitionIndex number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#partition_index Table#partition_index}.
typeIntervalType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#type_interval_type Table#type_interval_type}.
typeJson string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#type_json Table#type_json}.
typePrecision number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#type_precision Table#type_precision}.
typeScale number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#type_scale Table#type_scale}.
nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#name Table#name}.

positionRequired 
public readonly position: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#position Table#position}.

typeNameRequired 
public readonly typeName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#type_name Table#type_name}.

typeTextRequired 
public readonly typeText: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#type_text Table#type_text}.

commentOptional 
public readonly comment: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#comment Table#comment}.

nullableOptional 
public readonly nullable: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#nullable Table#nullable}.

partitionIndexOptional 
public readonly partitionIndex: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#partition_index Table#partition_index}.

typeIntervalTypeOptional 
public readonly typeIntervalType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#type_interval_type Table#type_interval_type}.

typeJsonOptional 
public readonly typeJson: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#type_json Table#type_json}.

typePrecisionOptional 
public readonly typePrecision: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#type_precision Table#type_precision}.

typeScaleOptional 
public readonly typeScale: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#type_scale Table#type_scale}.

TableConfig

Initializer 

import { table } from '@cdktf/provider-databricks'

const tableConfig: table.TableConfig = { ... }

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.
catalogName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#catalog_name Table#catalog_name}.
column cdktf.IResolvable | TableColumn[] column block.
dataSourceFormat string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#data_source_format Table#data_source_format}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#name Table#name}.
schemaName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#schema_name Table#schema_name}.
tableType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#table_type Table#table_type}.
comment string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#comment Table#comment}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#id Table#id}.
owner string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#owner Table#owner}.
properties {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#properties Table#properties}.
storageCredentialName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#storage_credential_name Table#storage_credential_name}.
storageLocation string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#storage_location Table#storage_location}.
viewDefinition string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#view_definition Table#view_definition}.
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[]
catalogNameRequired 
public readonly catalogName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#catalog_name Table#catalog_name}.

columnRequired 
public readonly column: IResolvable | TableColumn[];

column block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#column Table#column}

dataSourceFormatRequired 
public readonly dataSourceFormat: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#data_source_format Table#data_source_format}.

nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#name Table#name}.

schemaNameRequired 
public readonly schemaName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#schema_name Table#schema_name}.

tableTypeRequired 
public readonly tableType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#table_type Table#table_type}.

commentOptional 
public readonly comment: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#comment Table#comment}.

idOptional 
public readonly id: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#id Table#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.

ownerOptional 
public readonly owner: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#owner Table#owner}.

propertiesOptional 
public readonly properties: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#properties Table#properties}.

storageCredentialNameOptional 
public readonly storageCredentialName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#storage_credential_name Table#storage_credential_name}.

storageLocationOptional 
public readonly storageLocation: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#storage_location Table#storage_location}.

viewDefinitionOptional 
public readonly viewDefinition: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/resources/table#view_definition Table#view_definition}.

Classes

TableColumnList

Initializers 

import { table } from '@cdktf/provider-databricks'

new table.TableColumnList(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): TableColumnOutputReference
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 | TableColumn[] 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 | TableColumn[];

TableColumnOutputReference

Initializers 

import { table } from '@cdktf/provider-databricks'

new table.TableColumnOutputReference(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.
resetComment No description.
resetNullable No description.
resetPartitionIndex No description.
resetTypeIntervalType No description.
resetTypeJson No description.
resetTypePrecision No description.
resetTypeScale No description.
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.

resetComment 
public resetComment(): void
resetNullable 
public resetNullable(): void
resetPartitionIndex 
public resetPartitionIndex(): void
resetTypeIntervalType 
public resetTypeIntervalType(): void
resetTypeJson 
public resetTypeJson(): void
resetTypePrecision 
public resetTypePrecision(): void
resetTypeScale 
public resetTypeScale(): 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.
commentInput string No description.
nameInput string No description.
nullableInput boolean | cdktf.IResolvable No description.
partitionIndexInput number No description.
positionInput number No description.
typeIntervalTypeInput string No description.
typeJsonInput string No description.
typeNameInput string No description.
typePrecisionInput number No description.
typeScaleInput number No description.
typeTextInput string No description.
comment string No description.
name string No description.
nullable boolean | cdktf.IResolvable No description.
partitionIndex number No description.
position number No description.
typeIntervalType string No description.
typeJson string No description.
typeName string No description.
typePrecision number No description.
typeScale number No description.
typeText string No description.
internalValue cdktf.IResolvable | TableColumn 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
commentInputOptional 
public readonly commentInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
nullableInputOptional 
public readonly nullableInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
partitionIndexInputOptional 
public readonly partitionIndexInput: number;
  • Type: number
positionInputOptional 
public readonly positionInput: number;
  • Type: number
typeIntervalTypeInputOptional 
public readonly typeIntervalTypeInput: string;
  • Type: string
typeJsonInputOptional 
public readonly typeJsonInput: string;
  • Type: string
typeNameInputOptional 
public readonly typeNameInput: string;
  • Type: string
typePrecisionInputOptional 
public readonly typePrecisionInput: number;
  • Type: number
typeScaleInputOptional 
public readonly typeScaleInput: number;
  • Type: number
typeTextInputOptional 
public readonly typeTextInput: string;
  • Type: string
commentRequired 
public readonly comment: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
nullableRequired 
public readonly nullable: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
partitionIndexRequired 
public readonly partitionIndex: number;
  • Type: number
positionRequired 
public readonly position: number;
  • Type: number
typeIntervalTypeRequired 
public readonly typeIntervalType: string;
  • Type: string
typeJsonRequired 
public readonly typeJson: string;
  • Type: string
typeNameRequired 
public readonly typeName: string;
  • Type: string
typePrecisionRequired 
public readonly typePrecision: number;
  • Type: number
typeScaleRequired 
public readonly typeScale: number;
  • Type: number
typeTextRequired 
public readonly typeText: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | TableColumn;