MwsWorkspaces

laktory.models.resources.databricks.MwsWorkspaces

Bases: MwsWorkspacesBase

Databricks Mws Workspaces

Examples:

import io

from laktory import models

workspace_yaml = '''
account_id: ${vars.databricks_account_id}
workspace_name: my-workspace
aws_region: us-east-1
credentials_id: ${resources.mws-credentials-this.credentials_id}
storage_configuration_id: ${resources.mws-storage-configurations-this.storage_configuration_id}
'''
workspace = models.resources.databricks.MwsWorkspaces.model_validate_yaml(
    io.StringIO(workspace_yaml)
)

References

• Databricks MWS Workspaces

BASE	DESCRIPTION
account_id	Account Id that could be found in the top right corner of Accounts Console TYPE: str | VariableType
aws_region	(AWS only) region of VPC TYPE: str | None | VariableType DEFAULT: None
cloud	TYPE: str | None | VariableType DEFAULT: None
cloud_resource_container	(GCP only) A block that specifies GCP workspace configurations, consisting of following blocks: TYPE: MwsWorkspacesCloudResourceContainer | None | VariableType DEFAULT: None
compute_mode	The compute mode for the workspace. When unset, a classic workspace is created, and both credentials_id and storage_configuration_id must be specified. When set to SERVERLESS, the resulting workspace is a serverless workspace, and credentials_id and storage_configuration_id must not be set. The only allowed value for this is SERVERLESS. Changing this field requires recreation of the workspace TYPE: str | None | VariableType DEFAULT: None
creation_time	(Integer) time when workspace was created TYPE: int | None | VariableType DEFAULT: None
credentials_id	(AWS only, Optional) credentials_id from credentials. This must not be specified when compute_mode is set to SERVERLESS TYPE: str | None | VariableType DEFAULT: None
custom_tags	(Map) Custom Tags (if present) added to workspace TYPE: dict[str, str] | None | VariableType DEFAULT: None
customer_managed_key_id	TYPE: str | None | VariableType DEFAULT: None
deployment_name	part of URL as in https://<prefix>-<deployment-name>.cloud.databricks.com. Deployment name cannot be used until a deployment name prefix is defined. Please contact your Databricks representative. Once a new deployment prefix is added/updated, it only will affect the new workspaces created TYPE: str | None | VariableType DEFAULT: None
expected_workspace_status	The expected status of the workspace. When unset, it defaults to RUNNING. When set to PROVISIONING, workspace provisioning will pause and not enter RUNNING status. The only allowed values for this is RUNNING and PROVISIONING TYPE: str | None | VariableType DEFAULT: None
external_customer_info	TYPE: MwsWorkspacesExternalCustomerInfo | None | VariableType DEFAULT: None
gcp_managed_network_config	TYPE: MwsWorkspacesGcpManagedNetworkConfig | None | VariableType DEFAULT: None
gke_config	TYPE: MwsWorkspacesGkeConfig | None | VariableType DEFAULT: None
is_no_public_ip_enabled	TYPE: bool | None | VariableType DEFAULT: None
location	(GCP only) region of the subnet TYPE: str | None | VariableType DEFAULT: None
managed_services_customer_managed_key_id	customer_managed_key_id from customer managed keys with use_cases set to MANAGED_SERVICES. This is used to encrypt the workspace's notebook and secret data in the control plane TYPE: str | None | VariableType DEFAULT: None
network_connectivity_config_id	TYPE: str | None | VariableType DEFAULT: None
network_id	(Optional) network_id from networks TYPE: str | None | VariableType DEFAULT: None
pricing_tier	The pricing tier of the workspace TYPE: str | None | VariableType DEFAULT: None
private_access_settings_id	Canonical unique identifier of databricks_mws_private_access_settings in Databricks Account TYPE: str | None | VariableType DEFAULT: None
storage_configuration_id	(AWS only, Optional) storage_configuration_id from storage configuration. This must not be specified when compute_mode is set to SERVERLESS TYPE: str | None | VariableType DEFAULT: None
storage_customer_managed_key_id	customer_managed_key_id from customer managed keys with use_cases set to STORAGE. This is used to encrypt the DBFS Storage & Cluster Volumes TYPE: str | None | VariableType DEFAULT: None
timeouts	TYPE: MwsWorkspacesTimeouts | None | VariableType DEFAULT: None
token	TYPE: MwsWorkspacesToken | None | VariableType DEFAULT: None
workspace_id	(String) workspace id TYPE: int | None | VariableType DEFAULT: None
workspace_name	name of the workspace, will appear on UI TYPE: str | VariableType
workspace_status	(String) workspace status TYPE: str | None | VariableType DEFAULT: None
workspace_status_message	(String) updates on workspace status TYPE: str | None | VariableType DEFAULT: None
workspace_url	(String) URL of the workspace TYPE: str | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.mwsworkspaces.MwsWorkspacesCloudResourceContainer

Bases: BaseModel

PARAMETER	DESCRIPTION
gcp	A block that consists of the following field: TYPE: MwsWorkspacesCloudResourceContainerGcp | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.mwsworkspaces.MwsWorkspacesCloudResourceContainerGcp

Bases: BaseModel

PARAMETER	DESCRIPTION
project_id	The Google Cloud project ID, which the workspace uses to instantiate cloud resources for your workspace TYPE: str | VariableType

---

laktory.models.resources.databricks.mwsworkspaces.MwsWorkspacesExternalCustomerInfo

Bases: BaseModel

PARAMETER	DESCRIPTION
authoritative_user_email	TYPE: str | VariableType
authoritative_user_full_name	TYPE: str | VariableType
customer_name	TYPE: str | VariableType

---

laktory.models.resources.databricks.mwsworkspaces.MwsWorkspacesGcpManagedNetworkConfig

Bases: BaseModel

PARAMETER	DESCRIPTION
gke_cluster_pod_ip_range	TYPE: str | None | VariableType DEFAULT: None
gke_cluster_service_ip_range	TYPE: str | None | VariableType DEFAULT: None
subnet_cidr	TYPE: str | VariableType

---

laktory.models.resources.databricks.mwsworkspaces.MwsWorkspacesGkeConfig

Bases: BaseModel

PARAMETER	DESCRIPTION
connectivity_type	TYPE: str | None | VariableType DEFAULT: None
master_ip_range	TYPE: str | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.mwsworkspaces.MwsWorkspacesTimeouts

Bases: BaseModel

PARAMETER	DESCRIPTION
create	TYPE: str | None | VariableType DEFAULT: None
read	TYPE: str | None | VariableType DEFAULT: None
update_	TYPE: str | None | VariableType DEFAULT: None

---

laktory.models.resources.databricks.mwsworkspaces.MwsWorkspacesToken

Bases: BaseModel

PARAMETER	DESCRIPTION
comment	Comment, that will appear in 'User Settings / Access Tokens' page on Workspace UI. By default it's 'Terraform PAT' TYPE: str | None | VariableType DEFAULT: None
lifetime_seconds	Token expiry lifetime. By default its 2592000 (30 days) TYPE: int | None | VariableType DEFAULT: None
token_id	TYPE: str | None | VariableType DEFAULT: None
token_value	TYPE: str | None | VariableType DEFAULT: None