Databricks SDK for JavaScript
    Preparing search index...

    Interface InstancePoolAndStats

    interface InstancePoolAndStats {
        awsAttributes?: InstancePoolAwsAttributes;
        azureAttributes?: InstancePoolAzureAttributes;
        customTags?: Record<string, string>;
        defaultTags?: Record<string, string>;
        diskSpec?: DiskSpec;
        enableElasticDisk?: boolean;
        gcpAttributes?: InstancePoolGcpAttributes;
        idleInstanceAutoterminationMinutes?: number;
        instancePoolId?: string;
        instancePoolName?: string;
        maxCapacity?: number;
        minIdleInstances?: number;
        nodeTypeFlexibility?: NodeTypeFlexibility;
        nodeTypeId?: string;
        preloadedDockerImages?: DockerImage[];
        preloadedSparkVersions?: string[];
        remoteDiskThroughput?: number;
        state?: InstancePoolState;
        stats?: InstancePoolStats;
        status?: InstancePoolStatus;
        totalInitialRemoteDiskSize?: number;
    }
    Index

    Properties

    awsAttributes? azureAttributes? customTags? defaultTags? diskSpec? enableElasticDisk? gcpAttributes? idleInstanceAutoterminationMinutes? instancePoolId? instancePoolName? maxCapacity? minIdleInstances? nodeTypeFlexibility? nodeTypeId? preloadedDockerImages? preloadedSparkVersions? remoteDiskThroughput? state? stats? status? totalInitialRemoteDiskSize?

    Properties

    awsAttributes?: InstancePoolAwsAttributes

    Attributes related to instance pools running on Amazon Web Services. If not specified at pool creation, a set of default values will be used.

    azureAttributes?: InstancePoolAzureAttributes

    Attributes related to instance pools running on Azure. If not specified at pool creation, a set of default values will be used.

    customTags?: Record<string, string>

    Additional tags for pool resources. will tag all pool resources (e.g., AWS instances and EBS volumes) with these tags in addition to default_tags. Notes:

    • Currently, allows at most 45 custom tags
    defaultTags?: Record<string, string>

    Tags that are added by regardless of any custom_tags, including:

    • Vendor:

    • InstancePoolCreator: <user_id_of_creator>

    • InstancePoolName: <name_of_pool>

    • InstancePoolId: <id_of_pool>

    diskSpec?: DiskSpec

    Defines the specification of the disks that will be attached to all spark containers.

    enableElasticDisk?: boolean

    Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire additional disk space when its Spark workers are running low on disk space. In AWS, this feature requires specific AWS permissions to function correctly - refer to the User Guide for more details.

    gcpAttributes?: InstancePoolGcpAttributes

    Attributes related to instance pools running on Google Cloud Platform. If not specified at pool creation, a set of default values will be used.

    idleInstanceAutoterminationMinutes?: number

    Automatically terminates the extra instances in the pool cache after they are inactive for this time in minutes if min_idle_instances requirement is already met. If not set, the extra pool instances will be automatically terminated after a default timeout. If specified, the threshold must be between 0 and 10000 minutes. Users can also set this value to 0 to instantly remove idle instances from the cache if min cache size could still hold.

    instancePoolId?: string

    Canonical unique identifier for the pool.

    instancePoolName?: string

    Pool name requested by the user. Pool name must be unique. Length must be between 1 and 100 characters.

    maxCapacity?: number

    Maximum number of outstanding instances to keep in the pool, including both instances used by clusters and idle instances. Clusters that require further instance provisioning will fail during upsize requests.

    minIdleInstances?: number

    Minimum number of idle instances to keep in the instance pool

    nodeTypeFlexibility?: NodeTypeFlexibility

    Flexible node type configuration for the pool.

    nodeTypeId?: string

    This field encodes, through a single value, the resources available to each of the Spark nodes in this cluster. For example, the Spark nodes can be provisioned and optimized for memory or compute intensive workloads. A list of available node types can be retrieved by using the :method:clusters/listNodeTypes API call.

    preloadedDockerImages?: DockerImage[]

    Custom Docker Image BYOC

    preloadedSparkVersions?: string[]

    A list containing at most one preloaded Spark image version for the pool. Pool-backed clusters started with the preloaded Spark version will start faster. A list of available Spark versions can be retrieved by using the :method:clusters/sparkVersions API call.

    remoteDiskThroughput?: number

    If set, what the configurable throughput (in Mb/s) for the remote disk is. Currently only supported for GCP HYPERDISK_BALANCED types.

    state?: InstancePoolState

    Current state of the instance pool.

    stats?: InstancePoolStats

    Usage statistics about the instance pool.

    status?: InstancePoolStatus

    Status of failed pending instances in the pool.

    totalInitialRemoteDiskSize?: number

    If set, what the total initial volume size (in GB) of the remote disks should be. Currently only supported for GCP HYPERDISK_BALANCED types.

    Settings

    Member Visibility

    On This Page

    Properties