dashboard.csharp.md

dashboard Submodule

Constructs

Dashboard

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

Initializers

using HashiCorp.Cdktf.Providers.Databricks;

new Dashboard(Construct Scope, string Id, DashboardConfig Config);

Name	Type	Description
Scope	Constructs.Construct	The scope in which to define this construct.
Id	string	The scoped construct ID.
Config	DashboardConfig	No description.

---

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

Id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

Config^Required

• Type: DashboardConfig

---

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

private string ToString()

Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

Path^Required

• Type: string

---

Value^Required

• Type: object

---

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)

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

NewLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

ResetOverrideLogicalId

private void ResetOverrideLogicalId()

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

ToHclTerraform

private object ToHclTerraform()

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget

private void AddMoveTarget(string MoveTarget)

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

MoveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

GetAnyMapAttribute

private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetNumberMapAttribute

private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

GetStringMapAttribute

private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

HasResourceMove

private object HasResourceMove()

ImportFrom

private void ImportFrom(string Id, TerraformProvider Provider = null)

Id^Required

• Type: string

---

Provider^Optional

• Type: HashiCorp.Cdktf.TerraformProvider

---

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

---

MoveFromId

private void MoveFromId(string Id)

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.

Id^Required

• Type: string

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

---

MoveTo

private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTarget^Required

• Type: string

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

---

Index^Optional

• Type: object

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

---

MoveToId

private void MoveToId(string Id)

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

Id^Required

• Type: string

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

---

ResetCreateTime

private void ResetCreateTime()

ResetDashboardChangeDetected

private void ResetDashboardChangeDetected()

ResetDashboardId

private void ResetDashboardId()

ResetEmbedCredentials

private void ResetEmbedCredentials()

ResetEtag

private void ResetEtag()

ResetFilePath

private void ResetFilePath()

ResetId

private void ResetId()

ResetLifecycleState

private void ResetLifecycleState()

ResetMd5

private void ResetMd5()

ResetPath

private void ResetPath()

ResetSerializedDashboard

private void ResetSerializedDashboard()

ResetUpdateTime

private void ResetUpdateTime()

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

using HashiCorp.Cdktf.Providers.Databricks;

Dashboard.IsConstruct(object X);

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.

X^Required

• Type: object

Any object.

---

IsTerraformElement

using HashiCorp.Cdktf.Providers.Databricks;

Dashboard.IsTerraformElement(object X);

X^Required

• Type: object

---

IsTerraformResource

using HashiCorp.Cdktf.Providers.Databricks;

Dashboard.IsTerraformResource(object X);

X^Required

• Type: object

---

GenerateConfigForImport

using HashiCorp.Cdktf.Providers.Databricks;

Dashboard.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a Dashboard resource upon running "cdktf plan ".

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

---

ImportToId^Required

• Type: string

The construct id used in the generated config for the Dashboard to import.

---

ImportFromId^Required

• Type: string

The id of the existing Dashboard that should be imported.

Refer to the {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#import import section} in the documentation of this resource for the id to use

---

Provider^Optional

• Type: HashiCorp.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	HashiCorp.Cdktf.TerraformStack	No description.
Fqn	string	No description.
FriendlyUniqueId	string	No description.
TerraformMetaArguments	System.Collections.Generic.IDictionary<string, object>	No description.
TerraformResourceType	string	No description.
TerraformGeneratorMetadata	HashiCorp.Cdktf.TerraformProviderGeneratorMetadata	No description.
Connection	object	No description.
Count	object	No description.
DependsOn	string[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
CreateTimeInput	string	No description.
DashboardChangeDetectedInput	object	No description.
DashboardIdInput	string	No description.
DisplayNameInput	string	No description.
EmbedCredentialsInput	object	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	object	No description.
DashboardId	string	No description.
DisplayName	string	No description.
EmbedCredentials	object	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.

---

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

---

CdktfStack^Required

public TerraformStack CdktfStack { get; }

• Type: HashiCorp.Cdktf.TerraformStack

---

Fqn^Required

public string Fqn { get; }

• Type: string

---

FriendlyUniqueId^Required

public string FriendlyUniqueId { get; }

• Type: string

---

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary<string, object>

---

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

---

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata

---

Connection^Optional

public object Connection { get; }

• Type: object

---

Count^Optional

public object Count { get; }

• Type: object

---

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; }

• Type: object[]

---

CreateTimeInput^Optional

public string CreateTimeInput { get; }

• Type: string

---

DashboardChangeDetectedInput^Optional

public object DashboardChangeDetectedInput { get; }

• Type: object

---

DashboardIdInput^Optional

public string DashboardIdInput { get; }

• Type: string

---

DisplayNameInput^Optional

public string DisplayNameInput { get; }

• Type: string

---

EmbedCredentialsInput^Optional

public object EmbedCredentialsInput { get; }

• Type: object

---

EtagInput^Optional

public string EtagInput { get; }

• Type: string

---

FilePathInput^Optional

public string FilePathInput { get; }

• Type: string

---

IdInput^Optional

public string IdInput { get; }

• Type: string

---

LifecycleStateInput^Optional

public string LifecycleStateInput { get; }

• Type: string

---

Md5Input^Optional

public string Md5Input { get; }

• Type: string

---

ParentPathInput^Optional

public string ParentPathInput { get; }

• Type: string

---

PathInput^Optional

public string PathInput { get; }

• Type: string

---

SerializedDashboardInput^Optional

public string SerializedDashboardInput { get; }

• Type: string

---

UpdateTimeInput^Optional

public string UpdateTimeInput { get; }

• Type: string

---

WarehouseIdInput^Optional

public string WarehouseIdInput { get; }

• Type: string

---

CreateTime^Required

public string CreateTime { get; }

• Type: string

---

DashboardChangeDetected^Required

public object DashboardChangeDetected { get; }

• Type: object

---

DashboardId^Required

public string DashboardId { get; }

• Type: string

---

DisplayName^Required

public string DisplayName { get; }

• Type: string

---

EmbedCredentials^Required

public object EmbedCredentials { get; }

• Type: object

---

Etag^Required

public string Etag { get; }

• Type: string

---

FilePath^Required

public string FilePath { get; }

• Type: string

---

Id^Required

public string Id { get; }

• Type: string

---

LifecycleState^Required

public string LifecycleState { get; }

• Type: string

---

Md5^Required

public string Md5 { get; }

• Type: string

---

ParentPath^Required

public string ParentPath { get; }

• Type: string

---

Path^Required

public string Path { get; }

• Type: string

---

SerializedDashboard^Required

public string SerializedDashboard { get; }

• Type: string

---

UpdateTime^Required

public string UpdateTime { get; }

• Type: string

---

WarehouseId^Required

public string WarehouseId { get; }

• Type: string

---

Constants

Name	Type	Description
TfResourceType	string	No description.

---

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

---

Structs

DashboardConfig

Initializer

using HashiCorp.Cdktf.Providers.Databricks;

new DashboardConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    string DisplayName,
    string ParentPath,
    string WarehouseId,
    string CreateTime = null,
    object DashboardChangeDetected = null,
    string DashboardId = null,
    object EmbedCredentials = null,
    string Etag = null,
    string FilePath = null,
    string Id = null,
    string LifecycleState = null,
    string Md5 = null,
    string Path = null,
    string SerializedDashboard = null,
    string UpdateTime = null
};

Properties

Name	Type	Description
Connection	object	No description.
Count	object	No description.
DependsOn	HashiCorp.Cdktf.ITerraformDependable[]	No description.
ForEach	HashiCorp.Cdktf.ITerraformIterator	No description.
Lifecycle	HashiCorp.Cdktf.TerraformResourceLifecycle	No description.
Provider	HashiCorp.Cdktf.TerraformProvider	No description.
Provisioners	object[]	No description.
DisplayName	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#display_name Dashboard#display_name}.
ParentPath	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#parent_path Dashboard#parent_path}.
WarehouseId	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#warehouse_id Dashboard#warehouse_id}.
CreateTime	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#create_time Dashboard#create_time}.
DashboardChangeDetected	object	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/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.62.1/docs/resources/dashboard#dashboard_id Dashboard#dashboard_id}.
EmbedCredentials	object	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#embed_credentials Dashboard#embed_credentials}.
Etag	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#etag Dashboard#etag}.
FilePath	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#file_path Dashboard#file_path}.
Id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#id Dashboard#id}.
LifecycleState	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#lifecycle_state Dashboard#lifecycle_state}.
Md5	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#md5 Dashboard#md5}.
Path	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#path Dashboard#path}.
SerializedDashboard	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#serialized_dashboard Dashboard#serialized_dashboard}.
UpdateTime	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/docs/resources/dashboard#update_time Dashboard#update_time}.

---

Connection^Optional

public object Connection { get; set; }

• Type: object

---

Count^Optional

public object Count { get; set; }

• Type: object

---

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: HashiCorp.Cdktf.ITerraformDependable[]

---

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: HashiCorp.Cdktf.ITerraformIterator

---

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: HashiCorp.Cdktf.TerraformResourceLifecycle

---

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: HashiCorp.Cdktf.TerraformProvider

---

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

---

DisplayName^Required

public string DisplayName { get; set; }

• Type: string

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

---

ParentPath^Required

public string ParentPath { get; set; }

• Type: string

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

---

WarehouseId^Required

public string WarehouseId { get; set; }

• Type: string

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

---

CreateTime^Optional

public string CreateTime { get; set; }

• Type: string

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

---

DashboardChangeDetected^Optional

public object DashboardChangeDetected { get; set; }

• Type: object

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

---

DashboardId^Optional

public string DashboardId { get; set; }

• Type: string

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

---

EmbedCredentials^Optional

public object EmbedCredentials { get; set; }

• Type: object

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

---

Etag^Optional

public string Etag { get; set; }

• Type: string

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

---

FilePath^Optional

public string FilePath { get; set; }

• Type: string

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

---

Id^Optional

public string Id { get; set; }

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/databricks/databricks/1.62.1/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.

---

LifecycleState^Optional

public string LifecycleState { get; set; }

• Type: string

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

---

Md5^Optional

public string Md5 { get; set; }

• Type: string

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

---

Path^Optional

public string Path { get; set; }

• Type: string

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

---

SerializedDashboard^Optional

public string SerializedDashboard { get; set; }

• Type: string

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

---

UpdateTime^Optional

public string UpdateTime { get; set; }

• Type: string

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

---