Skip to content

Group

laktory.models.resources.databricks.Group ¤

Bases: GroupBase

Databricks group

Examples:

import io

from laktory import models

group_yaml = '''
display_name: role-engineers
member_ids:
- ${resources.user-john.id}
- ${resources.sp-neptune.id}
'''
group = models.resources.databricks.Group.model_validate_yaml(
    io.StringIO(group_yaml)
)
References
BASE DESCRIPTION
acl_principal_id

identifier for use in databricks_access_control_rule_set, e.g. groups/Some Group

TYPE: str | None | VariableType DEFAULT: None

allow_cluster_create

This is a field to allow the group to have cluster create privileges. More fine grained permissions could be assigned with databricks_permissions and cluster_id argument. Everyone without allow_cluster_create argument set, but with permission to use Cluster Policy would be able to create clusters, but within boundaries of that specific policy

TYPE: bool | None | VariableType DEFAULT: None

allow_instance_pool_create

This is a field to allow the group to have instance pool create privileges. More fine grained permissions could be assigned with databricks_permissions and instance_pool_id argument

TYPE: bool | None | VariableType DEFAULT: None

api

Specifies whether to use account-level or workspace-level API. Valid values are account and workspace. When not set, the API level is inferred from the provider host

TYPE: str | None | VariableType DEFAULT: None

databricks_sql_access

This is a field to allow the group to have access to Databricks SQL UI, Databricks One and through databricks_sql_endpoint

TYPE: bool | None | VariableType DEFAULT: None

display_name

This is the display name for the given group

TYPE: str | VariableType

external_id

ID of the group in an external identity provider

TYPE: str | None | VariableType DEFAULT: None

force

Ignore cannot create group: Group with name X already exists. errors and implicitly import the specific group into Terraform state, enforcing entitlements defined in the instance of resource. This functionality is experimental and is designed to simplify corner cases, like Azure Active Directory synchronisation

TYPE: bool | None | VariableType DEFAULT: None

url

TYPE: str | None | VariableType DEFAULT: None

workspace_access

This is a field to allow the group to have access to a Databricks Workspace UI and Databricks One

TYPE: bool | None | VariableType DEFAULT: None

workspace_consume

This is a field to allow the group to have access only to Databricks One. Couldn't be used with workspace_access or databricks_sql_access

TYPE: bool | None | VariableType DEFAULT: None

LAKTORY DESCRIPTION
member_ids

A list of all member ids of the group. Can be users, groups or service principals

TYPE: list[str | VariableType] | VariableType DEFAULT: []

workspace_permission_assignments

Workspace access privileges

TYPE: list[MwsPermissionAssignment | VariableType] | VariableType DEFAULT: None

ATTRIBUTE DESCRIPTION
additional_core_resources
  • workspace permission assignments

TYPE: list

resource_key

display name or id

TYPE: str

additional_core_resources property ¤

  • workspace permission assignments

resource_key property ¤

display name or id


laktory.models.resources.databricks.group.GroupLookup ¤

Bases: ResourceLookup

PARAMETER DESCRIPTION
display_name

Display name of the group. Only support when using Terraform backend

TYPE: str | VariableType DEFAULT: None

id

Id of the group.

TYPE: str | VariableType DEFAULT: None