Databricks SDK for JavaScript
    Preparing search index...

    Interface NodeType

    A description of a Spark node type including both the dimensions of the node and the instance type on which it will be hosted.

    interface NodeType {
        category?: string;
        description?: string;
        displayOrder?: number;
        instanceTypeId?: string;
        isDeprecated?: boolean;
        isEncryptedInTransit?: boolean;
        isGraviton?: boolean;
        isHidden?: boolean;
        isIoCacheEnabled?: boolean;
        memoryMb?: number;
        nodeInfo?: CloudProviderNodeInfo;
        nodeInstanceType?: NodeInstanceType;
        nodeTypeId?: string;
        numCores?: number;
        numGpus?: number;
        photonDriverCapable?: boolean;
        photonWorkerCapable?: boolean;
        supportClusterTags?: boolean;
        supportEbsVolumes?: boolean;
        supportPortForwarding?: boolean;
    }
    Index

    Properties

    category? description? displayOrder? instanceTypeId? isDeprecated? isEncryptedInTransit? isGraviton? isHidden? isIoCacheEnabled? memoryMb? nodeInfo? nodeInstanceType? nodeTypeId? numCores? numGpus? photonDriverCapable? photonWorkerCapable? supportClusterTags? supportEbsVolumes? supportPortForwarding?

    Properties

    category?: string

    A descriptive category for this node type. Examples include "Memory Optimized" and "Compute Optimized".

    description?: string

    A string description associated with this node type, e.g., "r3.xlarge".

    displayOrder?: number

    An optional hint at the display order of node types in the UI. Within a node type category, lowest numbers come first.

    instanceTypeId?: string

    An identifier for the type of hardware that this node runs on, e.g., "r3.2xlarge" in AWS.

    isDeprecated?: boolean

    Whether the node type is deprecated. Non-deprecated node types offer greater performance.

    isEncryptedInTransit?: boolean

    AWS specific, whether this instance supports encryption in transit, used for hipaa and pci workloads.

    isGraviton?: boolean

    Whether this is an Arm-based instance.

    isHidden?: boolean

    Whether this node is hidden from presentation in the UI.

    isIoCacheEnabled?: boolean

    Whether this node comes with IO cache enabled by default.

    memoryMb?: number

    Memory (in MB) available for this node type.

    nodeInfo?: CloudProviderNodeInfo

    A collection of node type info reported by the cloud provider

    nodeInstanceType?: NodeInstanceType

    The NodeInstanceType object corresponding to instance_type_id

    nodeTypeId?: string

    Unique identifier for this node type.

    numCores?: number

    Number of CPU cores available for this node type. Note that this can be fractional, e.g., 2.5 cores, if the number of cores on a machine instance is not divisible by the number of Spark nodes on that machine.

    numGpus?: number

    Number of GPUs available for this node type.

    photonDriverCapable?: boolean
    photonWorkerCapable?: boolean
    supportClusterTags?: boolean

    Whether this node type support cluster tags.

    supportEbsVolumes?: boolean

    Whether this node type support EBS volumes. EBS volumes is disabled for node types that we could place multiple corresponding containers on the same hosting instance.

    supportPortForwarding?: boolean

    Whether this node type supports port forwarding.

    Settings

    Member Visibility

    On This Page

    Properties