Databricks SDK for JavaScript
    Preparing search index...

    Interface CreateWorkspaceRequest

    interface CreateWorkspaceRequest {
        accountId?: string;
        awsRegion?: string;
        cloud?: string;
        cloudResourceContainer?: CloudResourceContainer;
        computeMode?: ComputeMode;
        credentialsId?: string;
        customTags?: Record<string, string>;
        deploymentName?: string;
        gcpManagedNetworkConfig?: GcpManagedNetworkConfig;
        gkeConfig?: GkeConfig;
        location?: string;
        managedServicesCustomerManagedKeyId?: string;
        networkConnectivityConfigId?: string;
        networkId?: string;
        pricingTier?: PricingTier;
        privateAccessSettingsId?: string;
        storageConfigurationId?: string;
        storageCustomerManagedKeyId?: string;
        workspaceName?: string;
    }
    Index

    Properties

    accountId? awsRegion? cloud? cloudResourceContainer? computeMode? credentialsId? customTags? deploymentName? gcpManagedNetworkConfig? gkeConfig? location? managedServicesCustomerManagedKeyId? networkConnectivityConfigId? networkId? pricingTier? privateAccessSettingsId? storageConfigurationId? storageCustomerManagedKeyId? workspaceName?

    Properties

    accountId?: string
    awsRegion?: string
    cloud?: string

    DEPRECATED: This field is being ignored by the server and will be removed in the future. The cloud name. This field always has the value gcp.

    cloudResourceContainer?: CloudResourceContainer
    computeMode?: ComputeMode

    If the compute mode is SERVERLESS, a serverless workspace is created that comes pre-configured with serverless compute and default storage, providing a fully-managed, enterprise-ready SaaS experience. This means you don't need to provide any resources managed by you, such as credentials, storage, or network. If the compute mode is HYBRID (which is the default option), a classic workspace is created that uses customer-managed resources.

    credentialsId?: string

    ID of the workspace's credential configuration object.

    customTags?: Record<string, string>

    The custom tags key-value pairing that is attached to this workspace. The key-value pair is a string of utf-8 characters. The value can be an empty string, with maximum length of 255 characters. The key can be of maximum length of 127 characters, and cannot be empty.

    deploymentName?: string

    The deployment name defines part of the subdomain for the workspace. The workspace URL for the web application and REST APIs is .cloud.databricks.com. For example, if the deployment name is abcsales, your workspace URL will be https://abcsales.cloud.databricks.com. Hyphens are allowed. This property supports only the set of characters that are allowed in a subdomain. To set this value, you must have a deployment name prefix. Contact your account team to add an account deployment name prefix to your account. Workspace deployment names follow the account prefix and a hyphen. For example, if your account's deployment prefix is acme and the workspace deployment name is workspace-1, the JSON response for the deployment_name field becomes acme-workspace-1. The workspace URL would be acme-workspace-1.cloud.databricks.com. You can also set the deployment_name to the reserved keyword EMPTY if you want the deployment name to only include the deployment prefix. For example, if your account's deployment prefix is acme and the workspace deployment name is EMPTY, the deployment_name becomes acme only and the workspace URL is acme.cloud.databricks.com. This value must be unique across all non-deleted deployments across all AWS regions. If a new workspace omits this property, the server generates a unique deployment name for you with the pattern dbc-xxxxxxxx-xxxx.

    gcpManagedNetworkConfig?: GcpManagedNetworkConfig
    gkeConfig?: GkeConfig
    location?: string

    The Google Cloud region of the workspace data plane in your Google account (for example, us-east4).

    managedServicesCustomerManagedKeyId?: string

    The ID of the workspace's managed services encryption key configuration object. This is used to help protect and control access to the workspace's notebooks, secrets, Databricks SQL queries, and query history. The provided key configuration object property use_cases must contain MANAGED_SERVICES.

    networkConnectivityConfigId?: string

    The object ID of network connectivity config. Once assigned, the workspace serverless compute resources use the same set of stable IP CIDR blocks and optional private link to access your resources.

    networkId?: string

    The ID of the workspace's network configuration object. To use AWS PrivateLink, this field is required.

    pricingTier?: PricingTier
    privateAccessSettingsId?: string

    ID of the workspace's private access settings object. Only used for PrivateLink. You must specify this ID if you are using AWS PrivateLink for either front-end (user-to-workspace connection), back-end (data plane to control plane connection), or both connection types. Before configuring PrivateLink, read the article about PrivateLink.",

    storageConfigurationId?: string

    ID of the workspace's storage configuration object.

    storageCustomerManagedKeyId?: string

    The ID of the workspace's storage encryption key configuration object. This is used to encrypt the workspace's root S3 bucket (root DBFS and system data) and, optionally, cluster EBS volumes. The provided key configuration object property use_cases must contain STORAGE.

    workspaceName?: string

    The human-readable name of the workspace.

    Settings

    Member Visibility

    On This Page

    Properties