WorkspaceSettingV2

laktory.models.resources.databricks.WorkspaceSettingV2

Bases: SettingV2Mixin, WorkspaceSettingV2Base

Databricks workspace setting (settings v2)

One workspace setting, identified by its name, with a value matching its type: boolean_val, string_val, integer_val or a typed value (e.g. workspace_label, automatic_cluster_update_workspace, personal_compute). The settings and their types are listed by the settings metadata API (GET /api/2.1/settings-metadata). Removing the resource doesn't reset the setting: the provider only drops it from the Terraform state, leaving the last value. Apply the default value before removing it to revert a change.

Typed values (e.g. workspace_label, automatic_cluster_update_workspace, restrict_workspace_admins) must set every subfield, as returned by GET /api/2.1/settings/{name}: with provider 1.137.0, a subfield left out and filled in by Databricks fails the apply with "Provider produced inconsistent result".

Examples:

import io

from laktory import models

setting_yaml = '''
name: workspace_label
workspace_label:
  label: dev
  color: blue
'''
setting = models.resources.databricks.WorkspaceSettingV2.model_validate_yaml(
    io.StringIO(setting_yaml)
)

References

• Databricks settings API
• Terraform databricks_workspace_setting_v2

BASE	DESCRIPTION
aibi_dashboard_embedding_access_policy	Setting value for aibi_dashboard_embedding_access_policy setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_access_policy for final setting value TYPE: WorkspaceSettingV2AibiDashboardEmbeddingAccessPolicy | None | VariableType DEFAULT: None
aibi_dashboard_embedding_approved_domains	Setting value for aibi_dashboard_embedding_approved_domains setting. This is the setting value set by consumers, check effective_aibi_dashboard_embedding_approved_domains for final setting value TYPE: WorkspaceSettingV2AibiDashboardEmbeddingApprovedDomains | None | VariableType DEFAULT: None
allowed_apps_user_api_scopes	Setting value for allowed_apps_user_api_scopes setting. This is the setting value set by consumers, check effective_allowed_apps_user_api_scopes for final setting value TYPE: WorkspaceSettingV2AllowedAppsUserApiScopes | None | VariableType DEFAULT: None
automatic_cluster_update_workspace	Setting value for automatic_cluster_update_workspace setting. This is the setting value set by consumers, check effective_automatic_cluster_update_workspace for final setting value TYPE: WorkspaceSettingV2AutomaticClusterUpdateWorkspace | None | VariableType DEFAULT: None
boolean_val	Setting value for boolean type setting. This is the setting value set by consumers, check effective_boolean_val for final setting value TYPE: WorkspaceSettingV2BooleanVal | None | VariableType DEFAULT: None
collaboration_platform_connectivity	Setting value for collaboration_platform_connectivity setting. This is the setting value set by consumers, check effective_collaboration_platform_connectivity for final setting value TYPE: WorkspaceSettingV2CollaborationPlatformConnectivity | None | VariableType DEFAULT: None
integer_val	Setting value for integer type setting. This is the setting value set by consumers, check effective_integer_val for final setting value TYPE: WorkspaceSettingV2IntegerVal | None | VariableType DEFAULT: None
name	Name of the setting TYPE: str | VariableType
operational_email_custom_recipient	Setting value for operational_email_custom_recipient setting. This is the setting value set by consumers, check effective_operational_email_custom_recipient for final setting value TYPE: WorkspaceSettingV2OperationalEmailCustomRecipient | None | VariableType DEFAULT: None
personal_compute	Setting value for personal_compute setting. This is the setting value set by consumers, check effective_personal_compute for final setting value TYPE: WorkspaceSettingV2PersonalCompute | None | VariableType DEFAULT: None
provider_config	Configure the provider for management through account provider TYPE: WorkspaceSettingV2ProviderConfig | None | VariableType DEFAULT: None
restrict_workspace_admins	Setting value for restrict_workspace_admins setting. This is the setting value set by consumers, check effective_restrict_workspace_admins for final setting value TYPE: WorkspaceSettingV2RestrictWorkspaceAdmins | None | VariableType DEFAULT: None
string_val	Setting value for string type setting. This is the setting value set by consumers, check effective_string_val for final setting value TYPE: WorkspaceSettingV2StringVal | None | VariableType DEFAULT: None
workspace_label	Setting value for workspace_label setting. This is the setting value set by consumers, check effective_workspace_label for final setting value TYPE: WorkspaceSettingV2WorkspaceLabel | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2AibiDashboardEmbeddingAccessPolicy

Bases: BaseModel

PARAMETER	DESCRIPTION
access_policy_type	Possible values are: ALLOW_ALL_DOMAINS, ALLOW_APPROVED_DOMAINS, DENY_ALL_DOMAINS TYPE: str | VariableType

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2AibiDashboardEmbeddingApprovedDomains

Bases: BaseModel

PARAMETER	DESCRIPTION
approved_domains	TYPE: list[str] | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2AllowedAppsUserApiScopes

Bases: BaseModel

PARAMETER	DESCRIPTION
allowed_scopes	TYPE: list[str] | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2AutomaticClusterUpdateWorkspace

Bases: BaseModel

PARAMETER	DESCRIPTION
can_toggle	TYPE: bool | None | VariableType DEFAULT: None
enabled	TYPE: bool | None | VariableType DEFAULT: None
enablement_details	TYPE: WorkspaceSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails | None | VariableType DEFAULT: None
maintenance_window	TYPE: WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow | None | VariableType DEFAULT: None
restart_even_if_no_updates_available	TYPE: bool | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2AutomaticClusterUpdateWorkspaceEnablementDetails

Bases: BaseModel

PARAMETER	DESCRIPTION
forced_for_compliance_mode	The feature is force enabled if compliance mode is active TYPE: bool | None | VariableType DEFAULT: None
unavailable_for_disabled_entitlement	The feature is unavailable if the corresponding entitlement disabled (see getShieldEntitlementEnable) TYPE: bool | None | VariableType DEFAULT: None
unavailable_for_non_enterprise_tier	The feature is unavailable if the customer doesn't have enterprise tier TYPE: bool | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindow

Bases: BaseModel

PARAMETER	DESCRIPTION
week_day_based_schedule	TYPE: WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedSchedule

Bases: BaseModel

PARAMETER	DESCRIPTION
day_of_week	Possible values are: FRIDAY, MONDAY, SATURDAY, SUNDAY, THURSDAY, TUESDAY, WEDNESDAY TYPE: str | None | VariableType DEFAULT: None
frequency	Possible values are: EVERY_WEEK, FIRST_AND_THIRD_OF_MONTH, FIRST_OF_MONTH, FOURTH_OF_MONTH, SECOND_AND_FOURTH_OF_MONTH, SECOND_OF_MONTH, THIRD_OF_MONTH * window_start_time (ClusterAutoRestartMessageMaintenanceWindowWindowStartTime, optional) TYPE: str | None | VariableType DEFAULT: None
window_start_time	TYPE: WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2AutomaticClusterUpdateWorkspaceMaintenanceWindowWeekDayBasedScheduleWindowStartTime

Bases: BaseModel

PARAMETER	DESCRIPTION
hours	TYPE: int | None | VariableType DEFAULT: None
minutes	TYPE: int | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2BooleanVal

Bases: BaseModel

PARAMETER	DESCRIPTION
value	Represents a generic string value TYPE: bool | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2CollaborationPlatformConnectivity

Bases: BaseModel

PARAMETER	DESCRIPTION
connectivity	Possible values are: ALLOW_ALL, ALLOW_SLACK, ALLOW_TEAMS, DENY_ALL TYPE: str | VariableType

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2IntegerVal

Bases: BaseModel

PARAMETER	DESCRIPTION
value	Represents a generic string value TYPE: int | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2OperationalEmailCustomRecipient

Bases: BaseModel

PARAMETER	DESCRIPTION
email	TYPE: str | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2PersonalCompute

Bases: BaseModel

PARAMETER	DESCRIPTION
value	Represents a generic string value TYPE: str | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2ProviderConfig

Bases: BaseModel

PARAMETER	DESCRIPTION
workspace_id	Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with TYPE: str | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2RestrictWorkspaceAdmins

Bases: BaseModel

PARAMETER	DESCRIPTION
disable_gov_tag_creation	When true, workspace admins cannot create governance tags. ALLOW_ALL status does not override this; they are independent TYPE: bool | None | VariableType DEFAULT: None
status	Possible values are: ALLOW_ALL, RESTRICT_TOKENS_AND_JOB_RUN_AS TYPE: str | VariableType

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2StringVal

Bases: BaseModel

PARAMETER	DESCRIPTION
value	Represents a generic string value TYPE: str | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.workspacesettingv2.WorkspaceSettingV2WorkspaceLabel

Bases: BaseModel

PARAMETER	DESCRIPTION
color	TYPE: str | None | VariableType DEFAULT: None
label	TYPE: str | None | VariableType DEFAULT: None