Skip to content

Latest commit

 

History

History
2864 lines (1760 loc) · 136 KB

dataDatabricksShare.typescript.md

File metadata and controls

2864 lines (1760 loc) · 136 KB
Raw

dataDatabricksShare Submodule

Constructs

DataDatabricksShare

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

Initializers 

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

new dataDatabricksShare.DataDatabricksShare(scope: Construct, id: string, config?: DataDatabricksShareConfig)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id string The scoped construct ID.
config DataDatabricksShareConfig 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

configOptional

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.
putObject No description.
resetCreatedAt No description.
resetCreatedBy No description.
resetId No description.
resetName No description.
resetObject 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
putObject 
public putObject(value: IResolvable | DataDatabricksShareObject[]): void
valueRequired
resetCreatedAt 
public resetCreatedAt(): void
resetCreatedBy 
public resetCreatedBy(): void
resetId 
public resetId(): void
resetName 
public resetName(): void
resetObject 
public resetObject(): 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 DataDatabricksShare resource upon running "cdktf plan ".
isConstruct 
import { dataDatabricksShare } from '@cdktf/provider-databricks'

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

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

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

dataDatabricksShare.DataDatabricksShare.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing DataDatabricksShare that should be imported.

Refer to the {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#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 DataDatabricksShare 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.
object DataDatabricksShareObjectList No description.
createdAtInput number No description.
createdByInput string No description.
idInput string No description.
nameInput string No description.
objectInput cdktf.IResolvable | DataDatabricksShareObject[] No description.
createdAt number No description.
createdBy 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
objectRequired 
public readonly object: DataDatabricksShareObjectList;
createdAtInputOptional 
public readonly createdAtInput: number;
  • Type: number
createdByInputOptional 
public readonly createdByInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
objectInputOptional 
public readonly objectInput: IResolvable | DataDatabricksShareObject[];
createdAtRequired 
public readonly createdAt: number;
  • Type: number
createdByRequired 
public readonly createdBy: 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

DataDatabricksShareConfig

Initializer 

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

const dataDatabricksShareConfig: dataDatabricksShare.DataDatabricksShareConfig = { ... }

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.
createdAt number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#created_at DataDatabricksShare#created_at}.
createdBy string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#created_by DataDatabricksShare#created_by}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#id DataDatabricksShare#id}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#name DataDatabricksShare#name}.
object cdktf.IResolvable | DataDatabricksShareObject[] object block.
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[]
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/share#created_at DataDatabricksShare#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/share#created_by DataDatabricksShare#created_by}.

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/share#id DataDatabricksShare#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.

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/share#name DataDatabricksShare#name}.

objectOptional 
public readonly object: IResolvable | DataDatabricksShareObject[];

object block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#object DataDatabricksShare#object}

DataDatabricksShareObject

Initializer 

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

const dataDatabricksShareObject: dataDatabricksShare.DataDatabricksShareObject = { ... }

Properties

Name Type Description
dataObjectType string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#data_object_type DataDatabricksShare#data_object_type}.
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#name DataDatabricksShare#name}.
addedAt number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#added_at DataDatabricksShare#added_at}.
addedBy string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#added_by DataDatabricksShare#added_by}.
cdfEnabled boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#cdf_enabled DataDatabricksShare#cdf_enabled}.
comment string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#comment DataDatabricksShare#comment}.
historyDataSharingStatus string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#history_data_sharing_status DataDatabricksShare#history_data_sharing_status}.
partition cdktf.IResolvable | DataDatabricksShareObjectPartition[] partition block.
sharedAs string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#shared_as DataDatabricksShare#shared_as}.
startVersion number Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#start_version DataDatabricksShare#start_version}.
status string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#status DataDatabricksShare#status}.
dataObjectTypeRequired 
public readonly dataObjectType: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#data_object_type DataDatabricksShare#data_object_type}.

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/share#name DataDatabricksShare#name}.

addedAtOptional 
public readonly addedAt: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#added_at DataDatabricksShare#added_at}.

addedByOptional 
public readonly addedBy: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#added_by DataDatabricksShare#added_by}.

cdfEnabledOptional 
public readonly cdfEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#cdf_enabled DataDatabricksShare#cdf_enabled}.

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/share#comment DataDatabricksShare#comment}.

historyDataSharingStatusOptional 
public readonly historyDataSharingStatus: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#history_data_sharing_status DataDatabricksShare#history_data_sharing_status}.

partitionOptional 
public readonly partition: IResolvable | DataDatabricksShareObjectPartition[];

partition block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#partition DataDatabricksShare#partition}

sharedAsOptional 
public readonly sharedAs: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#shared_as DataDatabricksShare#shared_as}.

startVersionOptional 
public readonly startVersion: number;
  • Type: number

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#start_version DataDatabricksShare#start_version}.

statusOptional 
public readonly status: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#status DataDatabricksShare#status}.

DataDatabricksShareObjectPartition

Initializer 

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

const dataDatabricksShareObjectPartition: dataDatabricksShare.DataDatabricksShareObjectPartition = { ... }

Properties

Name Type Description
value cdktf.IResolvable | DataDatabricksShareObjectPartitionValue[] value block.
valueRequired 
public readonly value: IResolvable | DataDatabricksShareObjectPartitionValue[];

value block.

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

DataDatabricksShareObjectPartitionValue

Initializer 

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

const dataDatabricksShareObjectPartitionValue: dataDatabricksShare.DataDatabricksShareObjectPartitionValue = { ... }

Properties

Name Type Description
name string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#name DataDatabricksShare#name}.
op string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#op DataDatabricksShare#op}.
recipientPropertyKey string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#recipient_property_key DataDatabricksShare#recipient_property_key}.
value string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#value DataDatabricksShare#value}.
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/share#name DataDatabricksShare#name}.

opRequired 
public readonly op: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#op DataDatabricksShare#op}.

recipientPropertyKeyOptional 
public readonly recipientPropertyKey: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.47.0/docs/data-sources/share#recipient_property_key DataDatabricksShare#recipient_property_key}.

valueOptional 
public readonly value: string;
  • Type: string

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

Classes

DataDatabricksShareObjectList

Initializers 

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

new dataDatabricksShare.DataDatabricksShareObjectList(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): DataDatabricksShareObjectOutputReference
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 | DataDatabricksShareObject[] 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 | DataDatabricksShareObject[];

DataDatabricksShareObjectOutputReference

Initializers 

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

new dataDatabricksShare.DataDatabricksShareObjectOutputReference(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.
putPartition No description.
resetAddedAt No description.
resetAddedBy No description.
resetCdfEnabled No description.
resetComment No description.
resetHistoryDataSharingStatus No description.
resetPartition No description.
resetSharedAs No description.
resetStartVersion No description.
resetStatus 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.

putPartition 
public putPartition(value: IResolvable | DataDatabricksShareObjectPartition[]): void
valueRequired
resetAddedAt 
public resetAddedAt(): void
resetAddedBy 
public resetAddedBy(): void
resetCdfEnabled 
public resetCdfEnabled(): void
resetComment 
public resetComment(): void
resetHistoryDataSharingStatus 
public resetHistoryDataSharingStatus(): void
resetPartition 
public resetPartition(): void
resetSharedAs 
public resetSharedAs(): void
resetStartVersion 
public resetStartVersion(): void
resetStatus 
public resetStatus(): 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.
partition DataDatabricksShareObjectPartitionList No description.
addedAtInput number No description.
addedByInput string No description.
cdfEnabledInput boolean | cdktf.IResolvable No description.
commentInput string No description.
dataObjectTypeInput string No description.
historyDataSharingStatusInput string No description.
nameInput string No description.
partitionInput cdktf.IResolvable | DataDatabricksShareObjectPartition[] No description.
sharedAsInput string No description.
startVersionInput number No description.
statusInput string No description.
addedAt number No description.
addedBy string No description.
cdfEnabled boolean | cdktf.IResolvable No description.
comment string No description.
dataObjectType string No description.
historyDataSharingStatus string No description.
name string No description.
sharedAs string No description.
startVersion number No description.
status string No description.
internalValue cdktf.IResolvable | DataDatabricksShareObject 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
partitionRequired 
public readonly partition: DataDatabricksShareObjectPartitionList;
addedAtInputOptional 
public readonly addedAtInput: number;
  • Type: number
addedByInputOptional 
public readonly addedByInput: string;
  • Type: string
cdfEnabledInputOptional 
public readonly cdfEnabledInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
commentInputOptional 
public readonly commentInput: string;
  • Type: string
dataObjectTypeInputOptional 
public readonly dataObjectTypeInput: string;
  • Type: string
historyDataSharingStatusInputOptional 
public readonly historyDataSharingStatusInput: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
partitionInputOptional 
public readonly partitionInput: IResolvable | DataDatabricksShareObjectPartition[];
sharedAsInputOptional 
public readonly sharedAsInput: string;
  • Type: string
startVersionInputOptional 
public readonly startVersionInput: number;
  • Type: number
statusInputOptional 
public readonly statusInput: string;
  • Type: string
addedAtRequired 
public readonly addedAt: number;
  • Type: number
addedByRequired 
public readonly addedBy: string;
  • Type: string
cdfEnabledRequired 
public readonly cdfEnabled: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
commentRequired 
public readonly comment: string;
  • Type: string
dataObjectTypeRequired 
public readonly dataObjectType: string;
  • Type: string
historyDataSharingStatusRequired 
public readonly historyDataSharingStatus: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
sharedAsRequired 
public readonly sharedAs: string;
  • Type: string
startVersionRequired 
public readonly startVersion: number;
  • Type: number
statusRequired 
public readonly status: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | DataDatabricksShareObject;

DataDatabricksShareObjectPartitionList

Initializers 

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

new dataDatabricksShare.DataDatabricksShareObjectPartitionList(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): DataDatabricksShareObjectPartitionOutputReference
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 | DataDatabricksShareObjectPartition[] 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 | DataDatabricksShareObjectPartition[];

DataDatabricksShareObjectPartitionOutputReference

Initializers 

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

new dataDatabricksShare.DataDatabricksShareObjectPartitionOutputReference(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.
putValue 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.

putValue 
public putValue(value: IResolvable | DataDatabricksShareObjectPartitionValue[]): void
valueRequired

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.
value DataDatabricksShareObjectPartitionValueList No description.
valueInput cdktf.IResolvable | DataDatabricksShareObjectPartitionValue[] No description.
internalValue cdktf.IResolvable | DataDatabricksShareObjectPartition 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
valueRequired 
public readonly value: DataDatabricksShareObjectPartitionValueList;
valueInputOptional 
public readonly valueInput: IResolvable | DataDatabricksShareObjectPartitionValue[];
internalValueOptional 
public readonly internalValue: IResolvable | DataDatabricksShareObjectPartition;

DataDatabricksShareObjectPartitionValueList

Initializers 

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

new dataDatabricksShare.DataDatabricksShareObjectPartitionValueList(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): DataDatabricksShareObjectPartitionValueOutputReference
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 | DataDatabricksShareObjectPartitionValue[] 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 | DataDatabricksShareObjectPartitionValue[];

DataDatabricksShareObjectPartitionValueOutputReference

Initializers 

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

new dataDatabricksShare.DataDatabricksShareObjectPartitionValueOutputReference(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.
resetRecipientPropertyKey No description.
resetValue 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.

resetRecipientPropertyKey 
public resetRecipientPropertyKey(): void
resetValue 
public resetValue(): 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.
nameInput string No description.
opInput string No description.
recipientPropertyKeyInput string No description.
valueInput string No description.
name string No description.
op string No description.
recipientPropertyKey string No description.
value string No description.
internalValue cdktf.IResolvable | DataDatabricksShareObjectPartitionValue No description.
creationStackRequired 
public readonly creationStack: string[];
  • Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

fqnRequired 
public readonly fqn: string;
  • Type: string
nameInputOptional 
public readonly nameInput: string;
  • Type: string
opInputOptional 
public readonly opInput: string;
  • Type: string
recipientPropertyKeyInputOptional 
public readonly recipientPropertyKeyInput: string;
  • Type: string
valueInputOptional 
public readonly valueInput: string;
  • Type: string
nameRequired 
public readonly name: string;
  • Type: string
opRequired 
public readonly op: string;
  • Type: string
recipientPropertyKeyRequired 
public readonly recipientPropertyKey: string;
  • Type: string
valueRequired 
public readonly value: string;
  • Type: string
internalValueOptional 
public readonly internalValue: IResolvable | DataDatabricksShareObjectPartitionValue;