Databricks SDK for JavaScript
    Preparing search index...

    Interface Policy

    Describes a Cluster Policy entity.

    interface Policy {
        createdAtTimestamp?: bigint;
        creatorUserName?: string;
        definition?: string;
        description?: string;
        isDefault?: boolean;
        libraries?: Library[];
        maxClustersPerUser?: bigint;
        name?: string;
        policyFamilyDefinitionOverrides?: string;
        policyFamilyId?: string;
        policyId?: string;
    }
    Index

    Properties

    createdAtTimestamp? creatorUserName? definition? description? isDefault? libraries? maxClustersPerUser? name? policyFamilyDefinitionOverrides? policyFamilyId? policyId?

    Properties

    createdAtTimestamp?: bigint

    Creation time. The timestamp (in millisecond) when this Cluster Policy was created.

    creatorUserName?: string

    Creator user name. The field won't be included in the response if the user has already been deleted.

    definition?: string

    Policy definition document expressed in Databricks Cluster Policy Definition Language.

    description?: string

    Additional human-readable description of the cluster policy.

    isDefault?: boolean

    If true, policy is a default policy created and managed by . Default policies cannot be deleted, and their policy families cannot be changed.

    libraries?: Library[]

    A list of libraries to be installed on the next cluster restart that uses this policy. The maximum number of libraries is 500.

    maxClustersPerUser?: bigint

    Max number of clusters per user that can be active using this policy. If not present, there is no max limit.

    name?: string

    Cluster Policy name requested by the user. This has to 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.

    Settings

    Member Visibility

    On This Page

    Properties