cluster_policies

Creates, updates, deletes, gets or lists a cluster_policies resource.

Overview

Name	cluster_policies
Type	Resource
Id	databricks_workspace.compute.cluster_policies

Fields

The following fields are returned by SELECT queries:

list

Request completed successfully.

Name	Datatype	Description
name	string
policy_family_id	string
policy_id	string
creator_user_name	string
created_at_timestamp	integer
definition	object
description	string
is_default	boolean
libraries	array
max_clusters_per_user	integer
policy_family_definition_overrides	object

get

Request completed successfully.

Name	Datatype	Description
name	string
policy_family_id	string
policy_id	string
creator_user_name	string
created_at_timestamp	integer
definition	object
description	string
is_default	boolean
libraries	array
max_clusters_per_user	integer
policy_family_definition_overrides	object

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	deployment_name		Returns a list of policies accessible by the requesting user.
get	select	deployment_name		Get a cluster policy entity. Creation and editing is available to admins only.
create	insert	deployment_name		Creates a new policy with prescribed settings.
edit	replace	deployment_name		Update an existing policy for cluster. This operation may make some clusters governed by the previous policy invalid.
delete	delete	deployment_name		Delete a policy for a cluster. Clusters governed by this policy can still run, but cannot be edited.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

SELECT examples

list

Returns a list of policies accessible by the requesting user.

SELECT
name,
policy_family_id,
policy_id,
creator_user_name,
created_at_timestamp,
definition,
description,
is_default,
libraries,
max_clusters_per_user,
policy_family_definition_overrides
FROM databricks_workspace.compute.cluster_policies
WHERE deployment_name = '{{ deployment_name }}' -- required;

get

Get a cluster policy entity. Creation and editing is available to admins only.

SELECT
name,
policy_family_id,
policy_id,
creator_user_name,
created_at_timestamp,
definition,
description,
is_default,
libraries,
max_clusters_per_user,
policy_family_definition_overrides
FROM databricks_workspace.compute.cluster_policies
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

create

Creates a new policy with prescribed settings.

INSERT INTO databricks_workspace.compute.cluster_policies (
data__name,
data__definition,
data__description,
data__policy_family_id,
data__policy_family_definition_overrides,
data__max_clusters_per_user,
data__libraries,
deployment_name
)
SELECT 
'{{ name }}',
'{{ definition }}',
'{{ description }}',
'{{ policy_family_id }}',
'{{ policy_family_definition_overrides }}',
{{ max_clusters_per_user }},
'{{ libraries }}',
'{{ deployment_name }}'
RETURNING
policy_id
;

Manifest

# Description fields are for documentation purposes
- name: cluster_policies
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the cluster_policies resource.
    - name: name
      value: string
    - name: definition
      value: JSON
    - name: description
      value: string
    - name: policy_family_id
      value: string
    - name: policy_family_definition_overrides
      value: JSON
    - name: max_clusters_per_user
      value: integer
    - name: libraries
      value: Array of object

REPLACE examples

edit

Update an existing policy for cluster. This operation may make some clusters governed by the previous policy invalid.

REPLACE databricks_workspace.compute.cluster_policies
SET 
data__policy_id = '{{ policy_id }}',
data__name = '{{ name }}',
data__definition = '{{ definition }}',
data__description = '{{ description }}',
data__policy_family_id = '{{ policy_family_id }}',
data__policy_family_definition_overrides = '{{ policy_family_definition_overrides }}',
data__max_clusters_per_user = '{{ max_clusters_per_user }}',
data__libraries = '{{ libraries }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required;

DELETE examples

delete

Delete a policy for a cluster. Clusters governed by this policy can still run, but cannot be edited.

DELETE FROM databricks_workspace.compute.cluster_policies
WHERE deployment_name = '{{ deployment_name }}' --required;