Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks
  3. API Docs
  4. ClusterPolicy
Databricks v1.50.2 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-databricks

databricks.ClusterPolicy

Explore with Pulumi AI

databricks logo
Databricks v1.50.2 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-databricks

    This resource creates a cluster policy, which limits the ability to create clusters based on a set of rules. The policy rules limit the attributes or attribute values available for cluster creation. cluster policies have ACLs that limit their use to specific users and groups. Only admin users can create, edit, and delete policies. Admin users also have access to all policies.

    Cluster policies let you:

    • Limit users to create clusters with prescribed settings.
    • Simplify the user interface and enable more users to create their own clusters (by fixing and hiding some values).
    • Control cost by limiting per cluster maximum cost (by setting limits on attributes whose values contribute to hourly price).

    Cluster policy permissions limit which policies a user can select in the Policy drop-down when the user creates a cluster:

    • If no policies have been created in the workspace, the Policy drop-down does not display.
    • A user who has cluster create permission can select the Free form policy and create fully-configurable clusters.
    • A user who has both cluster create permission and access to cluster policies can select the Free form policy and policies they have access to.
    • A user that has access to only cluster policies, can select the policies they have access to.

    Overriding the built-in cluster policies

    You can override built-in cluster policies by creating a databricks.ClusterPolicy resource with following attributes:

    • name - the name of the built-in cluster policy.
    • policy_family_id - the ID of the cluster policy family used for built-in cluster policy.
    • policy_family_definition_overrides - settings to override in the built-in cluster policy.

    You can obtain the list of defined cluster policies families using the databricks policy-families list command of the new Databricks CLI, or via list policy families REST API.

    import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const personalVmOverride = {
    autotermination_minutes: {
        type: "fixed",
        value: 220,
        hidden: true,
    },
    "custom_tags.Team": {
        type: "fixed",
        value: team,
    },
};
const personalVm = new databricks.ClusterPolicy("personal_vm", {
    policyFamilyId: "personal-vm",
    policyFamilyDefinitionOverrides: JSON.stringify(personalVmOverride),
    name: "Personal Compute",
});

    import pulumi
import json
import pulumi_databricks as databricks

personal_vm_override = {
    "autotermination_minutes": {
        "type": "fixed",
        "value": 220,
        "hidden": True,
    },
    "custom_tags.Team": {
        "type": "fixed",
        "value": team,
    },
}
personal_vm = databricks.ClusterPolicy("personal_vm",
    policy_family_id="personal-vm",
    policy_family_definition_overrides=json.dumps(personal_vm_override),
    name="Personal Compute")

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		personalVmOverride := map[string]interface{}{
			"autotermination_minutes": map[string]interface{}{
				"type":   "fixed",
				"value":  220,
				"hidden": true,
			},
			"custom_tags.Team": map[string]interface{}{
				"type":  "fixed",
				"value": team,
			},
		}
		tmpJSON0, err := json.Marshal(personalVmOverride)
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = databricks.NewClusterPolicy(ctx, "personal_vm", &databricks.ClusterPolicyArgs{
			PolicyFamilyId:                  pulumi.String("personal-vm"),
			PolicyFamilyDefinitionOverrides: pulumi.String(json0),
			Name:                            pulumi.String("Personal Compute"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var personalVmOverride = 
    {
        { "autotermination_minutes", 
        {
            { "type", "fixed" },
            { "value", 220 },
            { "hidden", true },
        } },
        { "custom_tags.Team", 
        {
            { "type", "fixed" },
            { "value", team },
        } },
    };

    var personalVm = new Databricks.ClusterPolicy("personal_vm", new()
    {
        PolicyFamilyId = "personal-vm",
        PolicyFamilyDefinitionOverrides = JsonSerializer.Serialize(personalVmOverride),
        Name = "Personal Compute",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.ClusterPolicy;
import com.pulumi.databricks.ClusterPolicyArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var personalVmOverride = %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);

        var personalVm = new ClusterPolicy("personalVm", ClusterPolicyArgs.builder()
            .policyFamilyId("personal-vm")
            .policyFamilyDefinitionOverrides(serializeJson(
                personalVmOverride))
            .name("Personal Compute")
            .build());

    }
}

    resources:
  personalVm:
    type: databricks:ClusterPolicy
    name: personal_vm
    properties:
      policyFamilyId: personal-vm
      policyFamilyDefinitionOverrides:
        fn::toJSON: ${personalVmOverride}
      name: Personal Compute
variables:
  personalVmOverride:
    autotermination_minutes:
      type: fixed
      value: 220
      hidden: true
    custom_tags.Team:
      type: fixed
      value: ${team}

    The following resources are often used in the same context:

    • Dynamic Passthrough Clusters for a Group guide.
    • End to end workspace management guide.
    • databricks.getClusters data to retrieve a list of databricks.Cluster ids.
    • databricks.Cluster to create Databricks Clusters.
    • databricks.getCurrentUser data to retrieve information about databricks.User or databricks_service_principal, that is calling Databricks REST API.
    • databricks.GlobalInitScript to manage global init scripts, which are run on all databricks.Cluster and databricks_job.
    • databricks.InstancePool to manage instance pools to reduce cluster start and auto-scaling times by maintaining a set of idle, ready-to-use instances.
    • databricks.InstanceProfile to manage AWS EC2 instance profiles that users can launch databricks.Cluster and access data, like databricks_mount.
    • databricks.IpAccessList to allow access from predefined IP ranges.
    • databricks.Library to install a library on databricks_cluster.
    • databricks.getNodeType data to get the smallest node type for databricks.Cluster that fits search criteria, like amount of RAM or number of cores.
    • databricks.Permissions to manage access control in Databricks workspace.
    • databricks.getSparkVersion data to get Databricks Runtime (DBR) version that could be used for spark_version parameter in databricks.Cluster and other resources.
    • databricks.UserInstanceProfile to attach databricks.InstanceProfile (AWS) to databricks_user.
    • databricks.WorkspaceConf to manage workspace configuration for expert usage.

    Create ClusterPolicy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClusterPolicy(name: string, args?: ClusterPolicyArgs, opts?: CustomResourceOptions);
    @overload
def ClusterPolicy(resource_name: str,
                  args: Optional[ClusterPolicyArgs] = None,
                  opts: Optional[ResourceOptions] = None)

@overload
def ClusterPolicy(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  definition: Optional[str] = None,
                  description: Optional[str] = None,
                  libraries: Optional[Sequence[ClusterPolicyLibraryArgs]] = None,
                  max_clusters_per_user: Optional[int] = None,
                  name: Optional[str] = None,
                  policy_family_definition_overrides: Optional[str] = None,
                  policy_family_id: Optional[str] = None)
    func NewClusterPolicy(ctx *Context, name string, args *ClusterPolicyArgs, opts ...ResourceOption) (*ClusterPolicy, error)
    public ClusterPolicy(string name, ClusterPolicyArgs? args = null, CustomResourceOptions? opts = null)
    public ClusterPolicy(String name, ClusterPolicyArgs args)
public ClusterPolicy(String name, ClusterPolicyArgs args, CustomResourceOptions options)

    type: databricks:ClusterPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ClusterPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterPolicyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterPolicyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var clusterPolicyResource = new Databricks.ClusterPolicy("clusterPolicyResource", new()
{
    Definition = "string",
    Description = "string",
    Libraries = new[]
    {
        new Databricks.Inputs.ClusterPolicyLibraryArgs
        {
            Cran = new Databricks.Inputs.ClusterPolicyLibraryCranArgs
            {
                Package = "string",
                Repo = "string",
            },
            Egg = "string",
            Jar = "string",
            Maven = new Databricks.Inputs.ClusterPolicyLibraryMavenArgs
            {
                Coordinates = "string",
                Exclusions = new[]
                {
                    "string",
                },
                Repo = "string",
            },
            Pypi = new Databricks.Inputs.ClusterPolicyLibraryPypiArgs
            {
                Package = "string",
                Repo = "string",
            },
            Requirements = "string",
            Whl = "string",
        },
    },
    MaxClustersPerUser = 0,
    Name = "string",
    PolicyFamilyDefinitionOverrides = "string",
    PolicyFamilyId = "string",
});

    example, err := databricks.NewClusterPolicy(ctx, "clusterPolicyResource", &databricks.ClusterPolicyArgs{
	Definition:  pulumi.String("string"),
	Description: pulumi.String("string"),
	Libraries: databricks.ClusterPolicyLibraryArray{
		&databricks.ClusterPolicyLibraryArgs{
			Cran: &databricks.ClusterPolicyLibraryCranArgs{
				Package: pulumi.String("string"),
				Repo:    pulumi.String("string"),
			},
			Egg: pulumi.String("string"),
			Jar: pulumi.String("string"),
			Maven: &databricks.ClusterPolicyLibraryMavenArgs{
				Coordinates: pulumi.String("string"),
				Exclusions: pulumi.StringArray{
					pulumi.String("string"),
				},
				Repo: pulumi.String("string"),
			},
			Pypi: &databricks.ClusterPolicyLibraryPypiArgs{
				Package: pulumi.String("string"),
				Repo:    pulumi.String("string"),
			},
			Requirements: pulumi.String("string"),
			Whl:          pulumi.String("string"),
		},
	},
	MaxClustersPerUser:              pulumi.Int(0),
	Name:                            pulumi.String("string"),
	PolicyFamilyDefinitionOverrides: pulumi.String("string"),
	PolicyFamilyId:                  pulumi.String("string"),
})

    var clusterPolicyResource = new ClusterPolicy("clusterPolicyResource", ClusterPolicyArgs.builder()
    .definition("string")
    .description("string")
    .libraries(ClusterPolicyLibraryArgs.builder()
        .cran(ClusterPolicyLibraryCranArgs.builder()
            .package_("string")
            .repo("string")
            .build())
        .egg("string")
        .jar("string")
        .maven(ClusterPolicyLibraryMavenArgs.builder()
            .coordinates("string")
            .exclusions("string")
            .repo("string")
            .build())
        .pypi(ClusterPolicyLibraryPypiArgs.builder()
            .package_("string")
            .repo("string")
            .build())
        .requirements("string")
        .whl("string")
        .build())
    .maxClustersPerUser(0)
    .name("string")
    .policyFamilyDefinitionOverrides("string")
    .policyFamilyId("string")
    .build());

    cluster_policy_resource = databricks.ClusterPolicy("clusterPolicyResource",
    definition="string",
    description="string",
    libraries=[databricks.ClusterPolicyLibraryArgs(
        cran=databricks.ClusterPolicyLibraryCranArgs(
            package="string",
            repo="string",
        ),
        egg="string",
        jar="string",
        maven=databricks.ClusterPolicyLibraryMavenArgs(
            coordinates="string",
            exclusions=["string"],
            repo="string",
        ),
        pypi=databricks.ClusterPolicyLibraryPypiArgs(
            package="string",
            repo="string",
        ),
        requirements="string",
        whl="string",
    )],
    max_clusters_per_user=0,
    name="string",
    policy_family_definition_overrides="string",
    policy_family_id="string")

    const clusterPolicyResource = new databricks.ClusterPolicy("clusterPolicyResource", {
    definition: "string",
    description: "string",
    libraries: [{
        cran: {
            "package": "string",
            repo: "string",
        },
        egg: "string",
        jar: "string",
        maven: {
            coordinates: "string",
            exclusions: ["string"],
            repo: "string",
        },
        pypi: {
            "package": "string",
            repo: "string",
        },
        requirements: "string",
        whl: "string",
    }],
    maxClustersPerUser: 0,
    name: "string",
    policyFamilyDefinitionOverrides: "string",
    policyFamilyId: "string",
});

    type: databricks:ClusterPolicy
properties:
    definition: string
    description: string
    libraries:
        - cran:
            package: string
            repo: string
          egg: string
          jar: string
          maven:
            coordinates: string
            exclusions:
                - string
            repo: string
          pypi:
            package: string
            repo: string
          requirements: string
          whl: string
    maxClustersPerUser: 0
    name: string
    policyFamilyDefinitionOverrides: string
    policyFamilyId: string

    ClusterPolicy Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ClusterPolicy resource accepts the following input properties:

    Definition string
    Policy definition: JSON document expressed in Databricks Policy Definition Language. Cannot be used with policy_family_id
    Description string
    Additional human-readable description of the cluster policy.
    Libraries List<ClusterPolicyLibrary>
    MaxClustersPerUser int
    Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.
    Name string
    Cluster policy name. This must be unique. Length must be between 1 and 100 characters.
    PolicyFamilyDefinitionOverrides string
    Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.
    PolicyFamilyId string
    ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with definition. Use policy_family_definition_overrides instead to customize the policy definition.
    Definition string
    Policy definition: JSON document expressed in Databricks Policy Definition Language. Cannot be used with policy_family_id
    Description string
    Additional human-readable description of the cluster policy.
    Libraries []ClusterPolicyLibraryArgs
    MaxClustersPerUser int
    Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.
    Name string
    Cluster policy name. This must be unique. Length must be between 1 and 100 characters.
    PolicyFamilyDefinitionOverrides string
    Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.
    PolicyFamilyId string
    ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with definition. Use policy_family_definition_overrides instead to customize the policy definition.
    definition String
    Policy definition: JSON document expressed in Databricks Policy Definition Language. Cannot be used with policy_family_id
    description String
    Additional human-readable description of the cluster policy.
    libraries List<ClusterPolicyLibrary>
    maxClustersPerUser Integer
    Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.
    name String
    Cluster policy name. This must be unique. Length must be between 1 and 100 characters.
    policyFamilyDefinitionOverrides String
    Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.
    policyFamilyId String
    ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with definition. Use policy_family_definition_overrides instead to customize the policy definition.
    definition string
    Policy definition: JSON document expressed in Databricks Policy Definition Language. Cannot be used with policy_family_id
    description string
    Additional human-readable description of the cluster policy.
    libraries ClusterPolicyLibrary[]
    maxClustersPerUser number
    Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.
    name string
    Cluster policy name. This must be unique. Length must be between 1 and 100 characters.
    policyFamilyDefinitionOverrides string
    Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.
    policyFamilyId string
    ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with definition. Use policy_family_definition_overrides instead to customize the policy definition.
    definition str
    Policy definition: JSON document expressed in Databricks Policy Definition Language. Cannot be used with policy_family_id
    description str
    Additional human-readable description of the cluster policy.
    libraries Sequence[ClusterPolicyLibraryArgs]
    max_clusters_per_user int
    Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.
    name str
    Cluster policy name. This must be unique. Length must be between 1 and 100 characters.
    policy_family_definition_overrides str
    Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.
    policy_family_id str
    ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with definition. Use policy_family_definition_overrides instead to customize the policy definition.
    definition String
    Policy definition: JSON document expressed in Databricks Policy Definition Language. Cannot be used with policy_family_id
    description String
    Additional human-readable description of the cluster policy.
    libraries List<Property Map>
    maxClustersPerUser Number
    Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.
    name String
    Cluster policy name. This must be unique. Length must be between 1 and 100 characters.
    policyFamilyDefinitionOverrides String
    Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.
    policyFamilyId String
    ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with definition. Use policy_family_definition_overrides instead to customize the policy definition.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClusterPolicy resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PolicyId string
    Canonical unique identifier for the cluster policy.
    Id string
    The provider-assigned unique ID for this managed resource.
    PolicyId string
    Canonical unique identifier for the cluster policy.
    id String
    The provider-assigned unique ID for this managed resource.
    policyId String
    Canonical unique identifier for the cluster policy.
    id string
    The provider-assigned unique ID for this managed resource.
    policyId string
    Canonical unique identifier for the cluster policy.
    id str
    The provider-assigned unique ID for this managed resource.
    policy_id str
    Canonical unique identifier for the cluster policy.
    id String
    The provider-assigned unique ID for this managed resource.
    policyId String
    Canonical unique identifier for the cluster policy.

    Look up Existing ClusterPolicy Resource

    Get an existing ClusterPolicy resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ClusterPolicyState, opts?: CustomResourceOptions): ClusterPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        definition: Optional[str] = None,
        description: Optional[str] = None,
        libraries: Optional[Sequence[ClusterPolicyLibraryArgs]] = None,
        max_clusters_per_user: Optional[int] = None,
        name: Optional[str] = None,
        policy_family_definition_overrides: Optional[str] = None,
        policy_family_id: Optional[str] = None,
        policy_id: Optional[str] = None) -> ClusterPolicy
    func GetClusterPolicy(ctx *Context, name string, id IDInput, state *ClusterPolicyState, opts ...ResourceOption) (*ClusterPolicy, error)
    public static ClusterPolicy Get(string name, Input<string> id, ClusterPolicyState? state, CustomResourceOptions? opts = null)
    public static ClusterPolicy get(String name, Output<String> id, ClusterPolicyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Definition string
    Policy definition: JSON document expressed in Databricks Policy Definition Language. Cannot be used with policy_family_id
    Description string
    Additional human-readable description of the cluster policy.
    Libraries List<ClusterPolicyLibrary>
    MaxClustersPerUser int
    Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.
    Name string
    Cluster policy name. This must be unique. Length must be between 1 and 100 characters.
    PolicyFamilyDefinitionOverrides string
    Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.
    PolicyFamilyId string
    ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with definition. Use policy_family_definition_overrides instead to customize the policy definition.
    PolicyId string
    Canonical unique identifier for the cluster policy.
    Definition string
    Policy definition: JSON document expressed in Databricks Policy Definition Language. Cannot be used with policy_family_id
    Description string
    Additional human-readable description of the cluster policy.
    Libraries []ClusterPolicyLibraryArgs
    MaxClustersPerUser int
    Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.
    Name string
    Cluster policy name. This must be unique. Length must be between 1 and 100 characters.
    PolicyFamilyDefinitionOverrides string
    Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.
    PolicyFamilyId string
    ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with definition. Use policy_family_definition_overrides instead to customize the policy definition.
    PolicyId string
    Canonical unique identifier for the cluster policy.
    definition String
    Policy definition: JSON document expressed in Databricks Policy Definition Language. Cannot be used with policy_family_id
    description String
    Additional human-readable description of the cluster policy.
    libraries List<ClusterPolicyLibrary>
    maxClustersPerUser Integer
    Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.
    name String
    Cluster policy name. This must be unique. Length must be between 1 and 100 characters.
    policyFamilyDefinitionOverrides String
    Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.
    policyFamilyId String
    ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with definition. Use policy_family_definition_overrides instead to customize the policy definition.
    policyId String
    Canonical unique identifier for the cluster policy.
    definition string
    Policy definition: JSON document expressed in Databricks Policy Definition Language. Cannot be used with policy_family_id
    description string
    Additional human-readable description of the cluster policy.
    libraries ClusterPolicyLibrary[]
    maxClustersPerUser number
    Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.
    name string
    Cluster policy name. This must be unique. Length must be between 1 and 100 characters.
    policyFamilyDefinitionOverrides string
    Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.
    policyFamilyId string
    ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with definition. Use policy_family_definition_overrides instead to customize the policy definition.
    policyId string
    Canonical unique identifier for the cluster policy.
    definition str
    Policy definition: JSON document expressed in Databricks Policy Definition Language. Cannot be used with policy_family_id
    description str
    Additional human-readable description of the cluster policy.
    libraries Sequence[ClusterPolicyLibraryArgs]
    max_clusters_per_user int
    Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.
    name str
    Cluster policy name. This must be unique. Length must be between 1 and 100 characters.
    policy_family_definition_overrides str
    Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.
    policy_family_id str
    ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with definition. Use policy_family_definition_overrides instead to customize the policy definition.
    policy_id str
    Canonical unique identifier for the cluster policy.
    definition String
    Policy definition: JSON document expressed in Databricks Policy Definition Language. Cannot be used with policy_family_id
    description String
    Additional human-readable description of the cluster policy.
    libraries List<Property Map>
    maxClustersPerUser Number
    Maximum number of clusters allowed per user. When omitted, there is no limit. If specified, value must be greater than zero.
    name String
    Cluster policy name. This must be unique. Length must be between 1 and 100 characters.
    policyFamilyDefinitionOverrides String
    Policy definition JSON document expressed in Databricks Policy Definition Language. The JSON document must be passed as a string and cannot be embedded in the requests. You can use this to customize the policy definition inherited from the policy family. Policy rules specified here are merged into the inherited policy definition.
    policyFamilyId String
    ID of the policy family. The cluster policy's policy definition inherits the policy family's policy definition. Cannot be used with definition. Use policy_family_definition_overrides instead to customize the policy definition.
    policyId String
    Canonical unique identifier for the cluster policy.

    Supporting Types

    ClusterPolicyLibrary, ClusterPolicyLibraryArgs

    ClusterPolicyLibraryCran, ClusterPolicyLibraryCranArgs

    Package string
    Repo string
    Package string
    Repo string
    package_ String
    repo String
    package string
    repo string
    package str
    repo str
    package String
    repo String

    ClusterPolicyLibraryMaven, ClusterPolicyLibraryMavenArgs

    Coordinates string
    Exclusions List<string>
    Repo string
    Coordinates string
    Exclusions []string
    Repo string
    coordinates String
    exclusions List<String>
    repo String
    coordinates string
    exclusions string[]
    repo string
    coordinates str
    exclusions Sequence[str]
    repo str
    coordinates String
    exclusions List<String>
    repo String

    ClusterPolicyLibraryPypi, ClusterPolicyLibraryPypiArgs

    Package string
    Repo string
    Package string
    Repo string
    package_ String
    repo String
    package string
    repo string
    package str
    repo str
    package String
    repo String

    Import

    The resource cluster policy can be imported using the policy id:

    bash

    $ pulumi import databricks:index/clusterPolicy:ClusterPolicy this <cluster-policy-id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.50.2 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-databricks