Skip to content

ExternalLocation

laktory.models.resources.databricks.ExternalLocation ¤

Bases: ExternalLocationBase

Databricks External Location

Examples:

import io

from laktory import models

location_yaml = '''
name: landing
credential_name: prod-azure-mi
url: abfss://landing@lakehouse-storage.dfs.core.windows.net/
comment: External location for raw landing data
grants:
- principal: account users
  privileges:
  - READ_FILES
- principal: role-data-engineers
  privileges:
  - READ_FILES
  - WRITE_FILES
'''
location = models.resources.databricks.ExternalLocation.model_validate_yaml(
    io.StringIO(location_yaml)
)
References
BASE DESCRIPTION
comment

TYPE: str | None | VariableType DEFAULT: None

credential_name

TYPE: str | VariableType

effective_file_event_queue

TYPE: ExternalLocationEffectiveFileEventQueue | None | VariableType DEFAULT: None

enable_file_events

TYPE: bool | None | VariableType DEFAULT: None

encryption_details

TYPE: ExternalLocationEncryptionDetails | None | VariableType DEFAULT: None

fallback

TYPE: bool | None | VariableType DEFAULT: None

file_event_queue

TYPE: ExternalLocationFileEventQueue | None | VariableType DEFAULT: None

force_destroy

TYPE: bool | None | VariableType DEFAULT: None

force_update

TYPE: bool | None | VariableType DEFAULT: None

isolation_mode

TYPE: str | None | VariableType DEFAULT: None

metastore_id

TYPE: str | None | VariableType DEFAULT: None

name

TYPE: str | VariableType

owner

TYPE: str | None | VariableType DEFAULT: None

read_only

TYPE: bool | None | VariableType DEFAULT: None

skip_validation

TYPE: bool | None | VariableType DEFAULT: None

url

TYPE: str | VariableType

LAKTORY DESCRIPTION
grant

Non-destructive grant for specific principal(s). Adds or updates privileges for the listed principal(s) and leaves grants for all other principals untouched. Use when access is managed from multiple sources (Laktory, Databricks UI, etc.). Mutually exclusive with grants.

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

grants

Authoritative grant list for all principals. Replaces every existing grant on this External Location - including those set outside Laktory - with only the entries listed here. Use only when Laktory owns all access management for this resource. Mutually exclusive with grant.

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

ATTRIBUTE DESCRIPTION
additional_core_resources
  • external location grants

TYPE: list

additional_core_resources property ¤

  • external location grants

laktory.models.resources.databricks.externallocation.ExternalLocationEffectiveFileEventQueue ¤

Bases: BaseModel

PARAMETER DESCRIPTION
managed_aqs

TYPE: ExternalLocationEffectiveFileEventQueueManagedAqs | None | VariableType DEFAULT: None

managed_pubsub

TYPE: ExternalLocationEffectiveFileEventQueueManagedPubsub | None | VariableType DEFAULT: None

managed_sqs

TYPE: ExternalLocationEffectiveFileEventQueueManagedSqs | None | VariableType DEFAULT: None

provided_aqs

TYPE: ExternalLocationEffectiveFileEventQueueProvidedAqs | None | VariableType DEFAULT: None

provided_pubsub

TYPE: ExternalLocationEffectiveFileEventQueueProvidedPubsub | None | VariableType DEFAULT: None

provided_sqs

TYPE: ExternalLocationEffectiveFileEventQueueProvidedSqs | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externallocation.ExternalLocationEffectiveFileEventQueueManagedAqs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
managed_resource_id

TYPE: str | None | VariableType DEFAULT: None

queue_url

TYPE: str | None | VariableType DEFAULT: None

resource_group

TYPE: str | None | VariableType DEFAULT: None

subscription_id

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externallocation.ExternalLocationEffectiveFileEventQueueManagedPubsub ¤

Bases: BaseModel

PARAMETER DESCRIPTION
managed_resource_id

TYPE: str | None | VariableType DEFAULT: None

subscription_name

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externallocation.ExternalLocationEffectiveFileEventQueueManagedSqs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
managed_resource_id

TYPE: str | None | VariableType DEFAULT: None

queue_url

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externallocation.ExternalLocationEffectiveFileEventQueueProvidedAqs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
managed_resource_id

TYPE: str | None | VariableType DEFAULT: None

queue_url

TYPE: str | None | VariableType DEFAULT: None

resource_group

TYPE: str | None | VariableType DEFAULT: None

subscription_id

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externallocation.ExternalLocationEffectiveFileEventQueueProvidedPubsub ¤

Bases: BaseModel

PARAMETER DESCRIPTION
managed_resource_id

TYPE: str | None | VariableType DEFAULT: None

subscription_name

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externallocation.ExternalLocationEffectiveFileEventQueueProvidedSqs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
managed_resource_id

TYPE: str | None | VariableType DEFAULT: None

queue_url

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externallocation.ExternalLocationEncryptionDetails ¤

Bases: BaseModel

PARAMETER DESCRIPTION
sse_encryption_details

TYPE: ExternalLocationEncryptionDetailsSseEncryptionDetails | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externallocation.ExternalLocationEncryptionDetailsSseEncryptionDetails ¤

Bases: BaseModel

PARAMETER DESCRIPTION
algorithm

TYPE: str | None | VariableType DEFAULT: None

aws_kms_key_arn

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externallocation.ExternalLocationFileEventQueue ¤

Bases: BaseModel

PARAMETER DESCRIPTION
managed_aqs

TYPE: ExternalLocationFileEventQueueManagedAqs | None | VariableType DEFAULT: None

managed_pubsub

TYPE: ExternalLocationFileEventQueueManagedPubsub | None | VariableType DEFAULT: None

managed_sqs

TYPE: ExternalLocationFileEventQueueManagedSqs | None | VariableType DEFAULT: None

provided_aqs

TYPE: ExternalLocationFileEventQueueProvidedAqs | None | VariableType DEFAULT: None

provided_pubsub

TYPE: ExternalLocationFileEventQueueProvidedPubsub | None | VariableType DEFAULT: None

provided_sqs

TYPE: ExternalLocationFileEventQueueProvidedSqs | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externallocation.ExternalLocationFileEventQueueManagedAqs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
queue_url

TYPE: str | None | VariableType DEFAULT: None

resource_group

TYPE: str | VariableType

subscription_id

TYPE: str | VariableType

laktory.models.resources.databricks.externallocation.ExternalLocationFileEventQueueManagedPubsub ¤

Bases: BaseModel

PARAMETER DESCRIPTION
subscription_name

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externallocation.ExternalLocationFileEventQueueManagedSqs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
queue_url

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externallocation.ExternalLocationFileEventQueueProvidedAqs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
queue_url

TYPE: str | VariableType

resource_group

TYPE: str | None | VariableType DEFAULT: None

subscription_id

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.externallocation.ExternalLocationFileEventQueueProvidedPubsub ¤

Bases: BaseModel

PARAMETER DESCRIPTION
subscription_name

TYPE: str | VariableType

laktory.models.resources.databricks.externallocation.ExternalLocationFileEventQueueProvidedSqs ¤

Bases: BaseModel

PARAMETER DESCRIPTION
queue_url

TYPE: str | VariableType

laktory.models.resources.databricks.externallocation.ExternalLocationLookup ¤

Bases: ResourceLookup

PARAMETER DESCRIPTION
name

Name of the external location

TYPE: str | VariableType