Skip to content

Recipient

laktory.models.resources.databricks.Recipient ¤

Bases: BaseModel, PulumiResource, TerraformResource

Databricks Recipient for Delta Sharing

A recipient is an entity that can receive shared data from a Databricks workspace. Recipients can be configured with authentication details to enable Delta Sharing.

Examples:


PARAMETER DESCRIPTION
authentication_type

The authentication type for the recipient

TYPE: Literal['TOKEN', 'DATABRICKS'] | VariableType

comment

Comment about the recipient

TYPE: str | VariableType DEFAULT: None

data_recipient_global_metastore_id

Global metastore id associated with the recipient. Required when authentication_type is DATABRICKS

TYPE: str | VariableType DEFAULT: None

expiration_time

Expiration timestamp of the token in epoch milliseconds.

TYPE: int | VariableType DEFAULT: None

ip_access_list

IP access list for the recipient

TYPE: RecipientIpAccessList | VariableType DEFAULT: None

name

The name of the recipient

TYPE: str | VariableType

owner

The owner of the recipient

TYPE: str | VariableType DEFAULT: None

properties_kvpairs

Additional properties as key-value pairs

TYPE: dict | VariableType DEFAULT: None

region

Cloud region of the recipient's Unity Catalog Metastore. This field is only present when the authentication_type is DATABRICKS.

TYPE: str | VariableType DEFAULT: None

sharing_code

The one-time sharing code provided by the data recipient.

TYPE: str | VariableType DEFAULT: None

tokens

List of Recipient Tokens. This field is only present when the authentication_type is TOKEN.

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


laktory.models.resources.databricks.recipient.RecipientIpAccessList ¤

Bases: BaseModel

Allowed IP Address

PARAMETER DESCRIPTION
allowed_ip_addresses

Allowed IP Addresses in CIDR notation. Limit of 100.

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


laktory.models.resources.databricks.recipient.RecipientPropertyKvPairs ¤

Bases: BaseModel

Additional properties for recipient

PARAMETER DESCRIPTION
properties

a map of string key-value pairs with recipient's properties. Properties with name starting with databricks. are reserved.

TYPE: dict[str | VariableType, str | VariableType] | VariableType


laktory.models.resources.databricks.recipient.RecipientToken ¤

Bases: BaseModel

Recipient Token

PARAMETER DESCRIPTION
activation_url

Full activation URL to retrieve the access token. It will be empty if the token is already retrieved.

TYPE: str | VariableType DEFAULT: None

created_at

Time at which this recipient was created, in epoch milliseconds.

TYPE: int | VariableType DEFAULT: None

created_by

Username of recipient creator.

TYPE: str | VariableType DEFAULT: None

expiration_time

Expiration timestamp of the token in epoch milliseconds.

TYPE: int | VariableType DEFAULT: None

id

Unique ID of the recipient token.

TYPE: str | VariableType DEFAULT: None

updated_at

Time at which this recipient was updated, in epoch milliseconds.

TYPE: int | VariableType DEFAULT: None

updated_by

Username of recipient Token updater.

TYPE: str | VariableType DEFAULT: None