Skip to content

Latest commit

 

History

History
1372 lines (856 loc) · 55 KB

dashboard.typescript.md

File metadata and controls

1372 lines (856 loc) · 55 KB
Raw

dashboard Submodule

Constructs

Dashboard

Represents a {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard databricks_dashboard}.

Initializers 

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

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

The scope in which to define this construct.

idRequired
  • Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

configRequired

Methods

Name Description
toString Returns a string representation of this construct.
addOverride No description.
overrideLogicalId Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform No description.
toMetadata No description.
toTerraform Adds this resource to the terraform JSON output.
addMoveTarget Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute No description.
getBooleanAttribute No description.
getBooleanMapAttribute No description.
getListAttribute No description.
getNumberAttribute No description.
getNumberListAttribute No description.
getNumberMapAttribute No description.
getStringAttribute No description.
getStringMapAttribute No description.
hasResourceMove No description.
importFrom No description.
interpolationForAttribute No description.
moveFromId Move the resource corresponding to "id" to this resource.
moveTo Moves this resource to the target resource given by moveTarget.
moveToId Moves this resource to the resource corresponding to "id".
resetCreateTime No description.
resetDashboardChangeDetected No description.
resetDashboardId No description.
resetEmbedCredentials No description.
resetEtag No description.
resetFilePath No description.
resetId No description.
resetLifecycleState No description.
resetMd5 No description.
resetPath No description.
resetSerializedDashboard No description.
resetUpdateTime No description.
toString 
public toString(): string

Returns a string representation of this construct.

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

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

newLogicalIdRequired
  • Type: string

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

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

Adds this resource to the terraform JSON output.

addMoveTarget 
public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTargetRequired
  • Type: string

The string move target that will correspond to this resource.

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

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

moveTo 
public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: string

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

indexOptional
  • Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

moveToId 
public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: string

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

resetCreateTime 
public resetCreateTime(): void
resetDashboardChangeDetected 
public resetDashboardChangeDetected(): void
resetDashboardId 
public resetDashboardId(): void
resetEmbedCredentials 
public resetEmbedCredentials(): void
resetEtag 
public resetEtag(): void
resetFilePath 
public resetFilePath(): void
resetId 
public resetId(): void
resetLifecycleState 
public resetLifecycleState(): void
resetMd5 
public resetMd5(): void
resetPath 
public resetPath(): void
resetSerializedDashboard 
public resetSerializedDashboard(): void
resetUpdateTime 
public resetUpdateTime(): void

Static Functions

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

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

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

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

dashboard.Dashboard.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

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

importFromIdRequired
  • Type: string

The id of the existing Dashboard that should be imported.

Refer to the {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#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 Dashboard to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktfStack cdktf.TerraformStack No description.
fqn string No description.
friendlyUniqueId string No description.
terraformMetaArguments {[ key: string ]: any} No description.
terraformResourceType string No description.
terraformGeneratorMetadata cdktf.TerraformProviderGeneratorMetadata No description.
connection cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection No description.
count number | cdktf.TerraformCount No description.
dependsOn string[] No description.
forEach cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[] No description.
createTimeInput string No description.
dashboardChangeDetectedInput boolean | cdktf.IResolvable No description.
dashboardIdInput string No description.
displayNameInput string No description.
embedCredentialsInput boolean | cdktf.IResolvable No description.
etagInput string No description.
filePathInput string No description.
idInput string No description.
lifecycleStateInput string No description.
md5Input string No description.
parentPathInput string No description.
pathInput string No description.
serializedDashboardInput string No description.
updateTimeInput string No description.
warehouseIdInput string No description.
createTime string No description.
dashboardChangeDetected boolean | cdktf.IResolvable No description.
dashboardId string No description.
displayName string No description.
embedCredentials boolean | cdktf.IResolvable No description.
etag string No description.
filePath string No description.
id string No description.
lifecycleState string No description.
md5 string No description.
parentPath string No description.
path string No description.
serializedDashboard string No description.
updateTime string No description.
warehouseId string No description.
nodeRequired 
public readonly node: Node;
  • Type: constructs.Node

The tree node.

cdktfStackRequired 
public readonly cdktfStack: TerraformStack;
  • Type: cdktf.TerraformStack
fqnRequired 
public readonly fqn: string;
  • Type: string
friendlyUniqueIdRequired 
public readonly friendlyUniqueId: string;
  • Type: string
terraformMetaArgumentsRequired 
public readonly terraformMetaArguments: {[ key: string ]: any};
  • Type: {[ key: string ]: any}
terraformResourceTypeRequired 
public readonly terraformResourceType: string;
  • Type: string
terraformGeneratorMetadataOptional 
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
  • Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection
countOptional 
public readonly count: number | TerraformCount;
  • Type: number | cdktf.TerraformCount
dependsOnOptional 
public readonly dependsOn: string[];
  • Type: string[]
forEachOptional 
public readonly forEach: ITerraformIterator;
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
public readonly lifecycle: TerraformResourceLifecycle;
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
public readonly provider: TerraformProvider;
  • Type: cdktf.TerraformProvider
provisionersOptional 
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
  • Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]
createTimeInputOptional 
public readonly createTimeInput: string;
  • Type: string
dashboardChangeDetectedInputOptional 
public readonly dashboardChangeDetectedInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
dashboardIdInputOptional 
public readonly dashboardIdInput: string;
  • Type: string
displayNameInputOptional 
public readonly displayNameInput: string;
  • Type: string
embedCredentialsInputOptional 
public readonly embedCredentialsInput: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
etagInputOptional 
public readonly etagInput: string;
  • Type: string
filePathInputOptional 
public readonly filePathInput: string;
  • Type: string
idInputOptional 
public readonly idInput: string;
  • Type: string
lifecycleStateInputOptional 
public readonly lifecycleStateInput: string;
  • Type: string
md5InputOptional 
public readonly md5Input: string;
  • Type: string
parentPathInputOptional 
public readonly parentPathInput: string;
  • Type: string
pathInputOptional 
public readonly pathInput: string;
  • Type: string
serializedDashboardInputOptional 
public readonly serializedDashboardInput: string;
  • Type: string
updateTimeInputOptional 
public readonly updateTimeInput: string;
  • Type: string
warehouseIdInputOptional 
public readonly warehouseIdInput: string;
  • Type: string
createTimeRequired 
public readonly createTime: string;
  • Type: string
dashboardChangeDetectedRequired 
public readonly dashboardChangeDetected: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
dashboardIdRequired 
public readonly dashboardId: string;
  • Type: string
displayNameRequired 
public readonly displayName: string;
  • Type: string
embedCredentialsRequired 
public readonly embedCredentials: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable
etagRequired 
public readonly etag: string;
  • Type: string
filePathRequired 
public readonly filePath: string;
  • Type: string
idRequired 
public readonly id: string;
  • Type: string
lifecycleStateRequired 
public readonly lifecycleState: string;
  • Type: string
md5Required 
public readonly md5: string;
  • Type: string
parentPathRequired 
public readonly parentPath: string;
  • Type: string
pathRequired 
public readonly path: string;
  • Type: string
serializedDashboardRequired 
public readonly serializedDashboard: string;
  • Type: string
updateTimeRequired 
public readonly updateTime: string;
  • Type: string
warehouseIdRequired 
public readonly warehouseId: string;
  • Type: string

Constants

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

Structs

DashboardConfig

Initializer 

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

const dashboardConfig: dashboard.DashboardConfig = { ... }

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.
displayName string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#display_name Dashboard#display_name}.
parentPath string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#parent_path Dashboard#parent_path}.
warehouseId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#warehouse_id Dashboard#warehouse_id}.
createTime string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#create_time Dashboard#create_time}.
dashboardChangeDetected boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#dashboard_change_detected Dashboard#dashboard_change_detected}.
dashboardId string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#dashboard_id Dashboard#dashboard_id}.
embedCredentials boolean | cdktf.IResolvable Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#embed_credentials Dashboard#embed_credentials}.
etag string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#etag Dashboard#etag}.
filePath string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#file_path Dashboard#file_path}.
id string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#id Dashboard#id}.
lifecycleState string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#lifecycle_state Dashboard#lifecycle_state}.
md5 string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#md5 Dashboard#md5}.
path string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#path Dashboard#path}.
serializedDashboard string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#serialized_dashboard Dashboard#serialized_dashboard}.
updateTime string Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#update_time Dashboard#update_time}.
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[]
displayNameRequired 
public readonly displayName: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#display_name Dashboard#display_name}.

parentPathRequired 
public readonly parentPath: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#parent_path Dashboard#parent_path}.

warehouseIdRequired 
public readonly warehouseId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#warehouse_id Dashboard#warehouse_id}.

createTimeOptional 
public readonly createTime: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#create_time Dashboard#create_time}.

dashboardChangeDetectedOptional 
public readonly dashboardChangeDetected: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#dashboard_change_detected Dashboard#dashboard_change_detected}.

dashboardIdOptional 
public readonly dashboardId: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#dashboard_id Dashboard#dashboard_id}.

embedCredentialsOptional 
public readonly embedCredentials: boolean | IResolvable;
  • Type: boolean | cdktf.IResolvable

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#embed_credentials Dashboard#embed_credentials}.

etagOptional 
public readonly etag: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#etag Dashboard#etag}.

filePathOptional 
public readonly filePath: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#file_path Dashboard#file_path}.

idOptional 
public readonly id: string;
  • Type: string

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

lifecycleStateOptional 
public readonly lifecycleState: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#lifecycle_state Dashboard#lifecycle_state}.

md5Optional 
public readonly md5: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#md5 Dashboard#md5}.

pathOptional 
public readonly path: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#path Dashboard#path}.

serializedDashboardOptional 
public readonly serializedDashboard: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#serialized_dashboard Dashboard#serialized_dashboard}.

updateTimeOptional 
public readonly updateTime: string;
  • Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.61.0/docs/resources/dashboard#update_time Dashboard#update_time}.