Skip to content

Latest commit

 

History

History
2771 lines (1730 loc) · 142 KB

dataDatabricksCatalog.typescript.md

File metadata and controls

2771 lines (1730 loc) · 142 KB
Raw

dataDatabricksCatalog Submodule

Constructs

DataDatabricksCatalog

Represents a {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog databricks_catalog}.

Initializers 

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

new dataDatabricksCatalog.DataDatabricksCatalog(scope: Construct, id: string, config: DataDatabricksCatalogConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataDatabricksCatalogConfig 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 Adds this resource to the terraform JSON output.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
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.
putCatalogInfo No description.
resetCatalogInfo No description.
resetId 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

Adds this resource to the terraform JSON output.

toMetadata 
public toMetadata(): any
toTerraform 
public toTerraform(): any

Adds this resource to the terraform JSON output.

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(terraformAttribute: string): IResolvable
terraformAttributeRequired
  • Type: string
putCatalogInfo 
public putCatalogInfo(value: DataDatabricksCatalogCatalogInfo): void
valueRequired
resetCatalogInfo 
public resetCatalogInfo(): void
resetId 
public resetId(): void

Static Functions

Name Description
isConstruct Checks if x is a construct.
isTerraformElement No description.
isTerraformDataSource No description.
generateConfigForImport Generates CDKTF code for importing a DataDatabricksCatalog resource upon running "cdktf plan ".
isConstruct 
import { dataDatabricksCatalog } from '@cdktf/provider-databricks'

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

dataDatabricksCatalog.DataDatabricksCatalog.isTerraformElement(x: any)
xRequired
  • Type: any
isTerraformDataSource 
import { dataDatabricksCatalog } from '@cdktf/provider-databricks'

dataDatabricksCatalog.DataDatabricksCatalog.isTerraformDataSource(x: any)
xRequired
  • Type: any
generateConfigForImport 
import { dataDatabricksCatalog } from '@cdktf/provider-databricks'

dataDatabricksCatalog.DataDatabricksCatalog.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing DataDatabricksCatalog that should be imported.

Refer to the {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#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 DataDatabricksCatalog 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.
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.
catalogInfo DataDatabricksCatalogCatalogInfoOutputReference No description.
catalogInfoInput DataDatabricksCatalogCatalogInfo No description.
idInput string No description.
nameInput string No description.
id string No description.
name 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
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
catalogInfoRequired 
public readonly catalogInfo: DataDatabricksCatalogCatalogInfoOutputReference;
catalogInfoInputOptional 
public readonly catalogInfoInput: DataDatabricksCatalogCatalogInfo;
idInputOptional 
public readonly idInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string

Constants

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

Structs

DataDatabricksCatalogCatalogInfo

Initializer 

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

const dataDatabricksCatalogCatalogInfo: dataDatabricksCatalog.DataDatabricksCatalogCatalogInfo = { ... }

Properties

Name Type Description
browseOnly boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#browse_only DataDatabricksCatalog#browse_only}.
catalogType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#catalog_type DataDatabricksCatalog#catalog_type}.
comment string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#comment DataDatabricksCatalog#comment}.
connectionName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#connection_name DataDatabricksCatalog#connection_name}.
createdAt number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#created_at DataDatabricksCatalog#created_at}.
createdBy string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#created_by DataDatabricksCatalog#created_by}.
effectivePredictiveOptimizationFlag DataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlag effective_predictive_optimization_flag block.
enablePredictiveOptimization string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#enable_predictive_optimization DataDatabricksCatalog#enable_predictive_optimization}.
fullName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#full_name DataDatabricksCatalog#full_name}.
isolationMode string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#isolation_mode DataDatabricksCatalog#isolation_mode}.
metastoreId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#metastore_id DataDatabricksCatalog#metastore_id}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#name DataDatabricksCatalog#name}.
options {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#options DataDatabricksCatalog#options}.
owner string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#owner DataDatabricksCatalog#owner}.
properties {[ key: string ]: string} Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#properties DataDatabricksCatalog#properties}.
providerName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#provider_name DataDatabricksCatalog#provider_name}.
provisioningInfo DataDatabricksCatalogCatalogInfoProvisioningInfo provisioning_info block.
securableKind string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#securable_kind DataDatabricksCatalog#securable_kind}.
securableType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#securable_type DataDatabricksCatalog#securable_type}.
shareName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#share_name DataDatabricksCatalog#share_name}.
storageLocation string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#storage_location DataDatabricksCatalog#storage_location}.
storageRoot string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#storage_root DataDatabricksCatalog#storage_root}.
updatedAt number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#updated_at DataDatabricksCatalog#updated_at}.
updatedBy string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#updated_by DataDatabricksCatalog#updated_by}.
browseOnlyOptional 
public readonly browseOnly: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#browse_only DataDatabricksCatalog#browse_only}.

catalogTypeOptional 
public readonly catalogType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#catalog_type DataDatabricksCatalog#catalog_type}.

commentOptional 
public readonly comment: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#comment DataDatabricksCatalog#comment}.

connectionNameOptional 
public readonly connectionName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#connection_name DataDatabricksCatalog#connection_name}.

createdAtOptional 
public readonly createdAt: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#created_at DataDatabricksCatalog#created_at}.

createdByOptional 
public readonly createdBy: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#created_by DataDatabricksCatalog#created_by}.

effectivePredictiveOptimizationFlagOptional 
public readonly effectivePredictiveOptimizationFlag: DataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlag;

effective_predictive_optimization_flag block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#effective_predictive_optimization_flag DataDatabricksCatalog#effective_predictive_optimization_flag}

enablePredictiveOptimizationOptional 
public readonly enablePredictiveOptimization: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#enable_predictive_optimization DataDatabricksCatalog#enable_predictive_optimization}.

fullNameOptional 
public readonly fullName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#full_name DataDatabricksCatalog#full_name}.

isolationModeOptional 
public readonly isolationMode: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#isolation_mode DataDatabricksCatalog#isolation_mode}.

metastoreIdOptional 
public readonly metastoreId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#metastore_id DataDatabricksCatalog#metastore_id}.

nameOptional 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#name DataDatabricksCatalog#name}.

optionsOptional 
public readonly options: {[ key: string ]: string};
  • Type: {[ key: string ]: string}

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#options DataDatabricksCatalog#options}.

ownerOptional 
public readonly owner: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#owner DataDatabricksCatalog#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/data-sources/catalog#properties DataDatabricksCatalog#properties}.

providerNameOptional 
public readonly providerName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#provider_name DataDatabricksCatalog#provider_name}.

provisioningInfoOptional 
public readonly provisioningInfo: DataDatabricksCatalogCatalogInfoProvisioningInfo;

provisioning_info block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#provisioning_info DataDatabricksCatalog#provisioning_info}

securableKindOptional 
public readonly securableKind: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#securable_kind DataDatabricksCatalog#securable_kind}.

securableTypeOptional 
public readonly securableType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#securable_type DataDatabricksCatalog#securable_type}.

shareNameOptional 
public readonly shareName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#share_name DataDatabricksCatalog#share_name}.

storageLocationOptional 
public readonly storageLocation: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#storage_location DataDatabricksCatalog#storage_location}.

storageRootOptional 
public readonly storageRoot: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#storage_root DataDatabricksCatalog#storage_root}.

updatedAtOptional 
public readonly updatedAt: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#updated_at DataDatabricksCatalog#updated_at}.

updatedByOptional 
public readonly updatedBy: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#updated_by DataDatabricksCatalog#updated_by}.

DataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlag

Initializer 

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

const dataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlag: dataDatabricksCatalog.DataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlag = { ... }

Properties

Name Type Description
value string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#value DataDatabricksCatalog#value}.
inheritedFromName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#inherited_from_name DataDatabricksCatalog#inherited_from_name}.
inheritedFromType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#inherited_from_type DataDatabricksCatalog#inherited_from_type}.
valueRequired 
public readonly value: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#value DataDatabricksCatalog#value}.

inheritedFromNameOptional 
public readonly inheritedFromName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#inherited_from_name DataDatabricksCatalog#inherited_from_name}.

inheritedFromTypeOptional 
public readonly inheritedFromType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#inherited_from_type DataDatabricksCatalog#inherited_from_type}.

DataDatabricksCatalogCatalogInfoProvisioningInfo

Initializer 

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

const dataDatabricksCatalogCatalogInfoProvisioningInfo: dataDatabricksCatalog.DataDatabricksCatalogCatalogInfoProvisioningInfo = { ... }

Properties

Name Type Description
state string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#state DataDatabricksCatalog#state}.
stateOptional 
public readonly state: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#state DataDatabricksCatalog#state}.

DataDatabricksCatalogConfig

Initializer 

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

const dataDatabricksCatalogConfig: dataDatabricksCatalog.DataDatabricksCatalogConfig = { ... }

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.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#name DataDatabricksCatalog#name}.
catalogInfo DataDatabricksCatalogCatalogInfo catalog_info block.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#id DataDatabricksCatalog#id}.
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[]
nameRequired 
public readonly name: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#name DataDatabricksCatalog#name}.

catalogInfoOptional 
public readonly catalogInfo: DataDatabricksCatalogCatalogInfo;

catalog_info block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/catalog#catalog_info DataDatabricksCatalog#catalog_info}

idOptional 
public readonly id: string;
  • Type: string

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

Classes

DataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlagOutputReference

Initializers 

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

new dataDatabricksCatalog.DataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlagOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

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.
resetInheritedFromName No description.
resetInheritedFromType 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.

resetInheritedFromName 
public resetInheritedFromName(): void
resetInheritedFromType 
public resetInheritedFromType(): 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.
inheritedFromNameInput string No description.
inheritedFromTypeInput string No description.
valueInput string No description.
inheritedFromName string No description.
inheritedFromType string No description.
value string No description.
internalValue DataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlag 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
inheritedFromNameInputOptional 
public readonly inheritedFromNameInput: string;
  • Type: string
inheritedFromTypeInputOptional 
public readonly inheritedFromTypeInput: string;
  • Type: string
valueInputOptional 
public readonly valueInput: string;
  • Type: string
inheritedFromNameRequired 
public readonly inheritedFromName: string;
  • Type: string
inheritedFromTypeRequired 
public readonly inheritedFromType: string;
  • Type: string
valueRequired 
public readonly value: string;
  • Type: string
internalValueOptional 
public readonly internalValue: DataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlag;

DataDatabricksCatalogCatalogInfoOutputReference

Initializers 

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

new dataDatabricksCatalog.DataDatabricksCatalogCatalogInfoOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

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.
putEffectivePredictiveOptimizationFlag No description.
putProvisioningInfo No description.
resetBrowseOnly No description.
resetCatalogType No description.
resetComment No description.
resetConnectionName No description.
resetCreatedAt No description.
resetCreatedBy No description.
resetEffectivePredictiveOptimizationFlag No description.
resetEnablePredictiveOptimization No description.
resetFullName No description.
resetIsolationMode No description.
resetMetastoreId No description.
resetName No description.
resetOptions No description.
resetOwner No description.
resetProperties No description.
resetProviderName No description.
resetProvisioningInfo No description.
resetSecurableKind No description.
resetSecurableType No description.
resetShareName No description.
resetStorageLocation No description.
resetStorageRoot No description.
resetUpdatedAt No description.
resetUpdatedBy 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.

putEffectivePredictiveOptimizationFlag 
public putEffectivePredictiveOptimizationFlag(value: DataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlag): void
valueRequired
putProvisioningInfo 
public putProvisioningInfo(value: DataDatabricksCatalogCatalogInfoProvisioningInfo): void
valueRequired
resetBrowseOnly 
public resetBrowseOnly(): void
resetCatalogType 
public resetCatalogType(): void
resetComment 
public resetComment(): void
resetConnectionName 
public resetConnectionName(): void
resetCreatedAt 
public resetCreatedAt(): void
resetCreatedBy 
public resetCreatedBy(): void
resetEffectivePredictiveOptimizationFlag 
public resetEffectivePredictiveOptimizationFlag(): void
resetEnablePredictiveOptimization 
public resetEnablePredictiveOptimization(): void
resetFullName 
public resetFullName(): void
resetIsolationMode 
public resetIsolationMode(): void
resetMetastoreId 
public resetMetastoreId(): void
resetName 
public resetName(): void
resetOptions 
public resetOptions(): void
resetOwner 
public resetOwner(): void
resetProperties 
public resetProperties(): void
resetProviderName 
public resetProviderName(): void
resetProvisioningInfo 
public resetProvisioningInfo(): void
resetSecurableKind 
public resetSecurableKind(): void
resetSecurableType 
public resetSecurableType(): void
resetShareName 
public resetShareName(): void
resetStorageLocation 
public resetStorageLocation(): void
resetStorageRoot 
public resetStorageRoot(): void
resetUpdatedAt 
public resetUpdatedAt(): void
resetUpdatedBy 
public resetUpdatedBy(): 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.
effectivePredictiveOptimizationFlag DataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlagOutputReference No description.
provisioningInfo DataDatabricksCatalogCatalogInfoProvisioningInfoOutputReference No description.
browseOnlyInput boolean | cdktf.IResolvable No description.
catalogTypeInput string No description.
commentInput string No description.
connectionNameInput string No description.
createdAtInput number No description.
createdByInput string No description.
effectivePredictiveOptimizationFlagInput DataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlag No description.
enablePredictiveOptimizationInput string No description.
fullNameInput string No description.
isolationModeInput string No description.
metastoreIdInput string No description.
nameInput string No description.
optionsInput {[ key: string ]: string} No description.
ownerInput string No description.
propertiesInput {[ key: string ]: string} No description.
providerNameInput string No description.
provisioningInfoInput DataDatabricksCatalogCatalogInfoProvisioningInfo No description.
securableKindInput string No description.
securableTypeInput string No description.
shareNameInput string No description.
storageLocationInput string No description.
storageRootInput string No description.
updatedAtInput number No description.
updatedByInput string No description.
browseOnly boolean | cdktf.IResolvable No description.
catalogType string No description.
comment string No description.
connectionName string No description.
createdAt number No description.
createdBy string No description.
enablePredictiveOptimization string No description.
fullName string No description.
isolationMode string No description.
metastoreId string No description.
name string No description.
options {[ key: string ]: string} No description.
owner string No description.
properties {[ key: string ]: string} No description.
providerName string No description.
securableKind string No description.
securableType string No description.
shareName string No description.
storageLocation string No description.
storageRoot string No description.
updatedAt number No description.
updatedBy string No description.
internalValue DataDatabricksCatalogCatalogInfo 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
effectivePredictiveOptimizationFlagRequired 
public readonly effectivePredictiveOptimizationFlag: DataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlagOutputReference;
provisioningInfoRequired 
public readonly provisioningInfo: DataDatabricksCatalogCatalogInfoProvisioningInfoOutputReference;
browseOnlyInputOptional 
public readonly browseOnlyInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
catalogTypeInputOptional 
public readonly catalogTypeInput: string;
  • Type: string
commentInputOptional 
public readonly commentInput: string;
  • Type: string
connectionNameInputOptional 
public readonly connectionNameInput: string;
  • Type: string
createdAtInputOptional 
public readonly createdAtInput: number;
  • Type: number
createdByInputOptional 
public readonly createdByInput: string;
  • Type: string
effectivePredictiveOptimizationFlagInputOptional 
public readonly effectivePredictiveOptimizationFlagInput: DataDatabricksCatalogCatalogInfoEffectivePredictiveOptimizationFlag;
enablePredictiveOptimizationInputOptional 
public readonly enablePredictiveOptimizationInput: string;
  • Type: string
fullNameInputOptional 
public readonly fullNameInput: string;
  • Type: string
isolationModeInputOptional 
public readonly isolationModeInput: string;
  • Type: string
metastoreIdInputOptional 
public readonly metastoreIdInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
optionsInputOptional 
public readonly optionsInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
ownerInputOptional 
public readonly ownerInput: string;
  • Type: string
propertiesInputOptional 
public readonly propertiesInput: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
providerNameInputOptional 
public readonly providerNameInput: string;
  • Type: string
provisioningInfoInputOptional 
public readonly provisioningInfoInput: DataDatabricksCatalogCatalogInfoProvisioningInfo;
securableKindInputOptional 
public readonly securableKindInput: string;
  • Type: string
securableTypeInputOptional 
public readonly securableTypeInput: string;
  • Type: string
shareNameInputOptional 
public readonly shareNameInput: string;
  • Type: string
storageLocationInputOptional 
public readonly storageLocationInput: string;
  • Type: string
storageRootInputOptional 
public readonly storageRootInput: string;
  • Type: string
updatedAtInputOptional 
public readonly updatedAtInput: number;
  • Type: number
updatedByInputOptional 
public readonly updatedByInput: string;
  • Type: string
browseOnlyRequired 
public readonly browseOnly: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
catalogTypeRequired 
public readonly catalogType: string;
  • Type: string
commentRequired 
public readonly comment: string;
  • Type: string
connectionNameRequired 
public readonly connectionName: string;
  • Type: string
createdAtRequired 
public readonly createdAt: number;
  • Type: number
createdByRequired 
public readonly createdBy: string;
  • Type: string
enablePredictiveOptimizationRequired 
public readonly enablePredictiveOptimization: string;
  • Type: string
fullNameRequired 
public readonly fullName: string;
  • Type: string
isolationModeRequired 
public readonly isolationMode: string;
  • Type: string
metastoreIdRequired 
public readonly metastoreId: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
optionsRequired 
public readonly options: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
ownerRequired 
public readonly owner: string;
  • Type: string
propertiesRequired 
public readonly properties: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
providerNameRequired 
public readonly providerName: string;
  • Type: string
securableKindRequired 
public readonly securableKind: string;
  • Type: string
securableTypeRequired 
public readonly securableType: string;
  • Type: string
shareNameRequired 
public readonly shareName: string;
  • Type: string
storageLocationRequired 
public readonly storageLocation: string;
  • Type: string
storageRootRequired 
public readonly storageRoot: string;
  • Type: string
updatedAtRequired 
public readonly updatedAt: number;
  • Type: number
updatedByRequired 
public readonly updatedBy: string;
  • Type: string
internalValueOptional 
public readonly internalValue: DataDatabricksCatalogCatalogInfo;

DataDatabricksCatalogCatalogInfoProvisioningInfoOutputReference

Initializers 

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

new dataDatabricksCatalog.DataDatabricksCatalogCatalogInfoProvisioningInfoOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)
Name Type Description
terraformResource cdktf.IInterpolatingParent The parent resource.
terraformAttribute string The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: string

The attribute on the parent resource this class is referencing.

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.
resetState 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.

resetState 
public resetState(): 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.
stateInput string No description.
state string No description.
internalValue DataDatabricksCatalogCatalogInfoProvisioningInfo 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
stateInputOptional 
public readonly stateInput: string;
  • Type: string
stateRequired 
public readonly state: string;
  • Type: string
internalValueOptional 
public readonly internalValue: DataDatabricksCatalogCatalogInfoProvisioningInfo;