Databricks SDK for JavaScript
    Preparing search index...

    Interface InstancePoolAwsAttributes

    Attributes set during instance pool creation which are related to Amazon Web Services.

    interface InstancePoolAwsAttributes {
        availability?: AwsAvailability;
        instanceProfileArn?: string;
        spotBidPricePercent?: number;
        zoneId?: string;
    }
    Index

    Properties

    availability? instanceProfileArn? spotBidPricePercent? zoneId?

    Properties

    availability?: AwsAvailability

    Availability type used for the instances in the pool. Supports on-demand, spot, and spot-with-fallback (the pool acquires spot instances first, and falls back to on-demand instances when spot capacity is unavailable).

    You can change this value on an existing pool. New clusters use the updated availability, and existing clusters keep the availability they launched with.

    instanceProfileArn?: string

    All AWS instances belonging to the instance pool will have this instance profile. If omitted, instances will initially be launched with the workspace's default instance profile. If defined, clusters that use the pool will inherit the instance profile, and must not specify their own instance profile on cluster creation or update. If the pool does not specify an instance profile, clusters using the pool may specify any instance profile. The instance profile must have previously been added to the environment by an account administrator.

    This feature may only be available to certain customer plans.

    spotBidPricePercent?: number

    Calculates the bid price for AWS spot instances, as a percentage of the corresponding instance type's on-demand price. For example, if this field is set to 50, and the cluster needs a new r3.xlarge spot instance, then the bid price is half of the price of on-demand r3.xlarge instances. Similarly, if this field is set to 200, the bid price is twice the price of on-demand r3.xlarge instances. If not specified, the default value is 100. When spot instances are requested for this cluster, only spot instances whose bid price percentage matches this field will be considered. Note that, for safety, we enforce this field to be no more than 10000.

    You can change this value on an existing pool. New clusters use the updated bid price, and existing clusters keep the bid price they launched with.

    zoneId?: string

    Identifier for the availability zone/datacenter in which the cluster resides. This string will be of a form like "us-west-2a". The provided availability zone must be in the same region as the deployment. For example, "us-west-2a" is not a valid zone id if the deployment resides in the "us-east-1" region. This is an optional field at cluster creation, and if not specified, a default zone will be used. The list of available zones as well as the default value can be found by using the List Zones method.

    Set this field to "auto" to enable Auto-AZ, in which case selects the availability zone for each cluster independently when the cluster launches, and retries another zone if the cluster can't be fulfilled because of insufficient capacity or quota. All nodes in a cluster land in the same zone, and different clusters backed by the pool can run in different zones.

    You can change the zone on an existing pool. New clusters use the updated zone, and existing clusters keep the zone they launched with.

    Settings

    Member Visibility

    On This Page

    Properties