Databricks SDK for JavaScript
    Preparing search index...

    Interface PrivateAccessSettings

    interface PrivateAccessSettings {
        accountId?: string;
        allowedVpcEndpointIds?: string[];
        privateAccessLevel?: PrivateAccessLevel;
        privateAccessSettingsId?: string;
        privateAccessSettingsName?: string;
        publicAccessEnabled?: boolean;
        region?: string;
    }
    Index

    Properties

    accountId? allowedVpcEndpointIds? privateAccessLevel? privateAccessSettingsId? privateAccessSettingsName? publicAccessEnabled? region?

    Properties

    accountId?: string

    The account ID that hosts the private access settings.

    allowedVpcEndpointIds?: string[]

    An array of Databricks VPC endpoint IDs. This is the ID that is returned when registering the VPC endpoint configuration in your account. This is not the ID of the VPC endpoint in AWS. Only used when private_access_level is set to ENDPOINT. This is an allow list of VPC endpoints that in your account that can connect to your workspace over AWS PrivateLink. If hybrid access to your workspace is enabled by setting public_access_enabled to true, this control only works for PrivateLink connections. To control how your workspace is accessed via public internet, see IP access lists.

    privateAccessLevel?: PrivateAccessLevel

    The private access level controls which VPC endpoints can connect to the UI or API of any workspace that attaches this private access settings object. ACCOUNT level access (the default) allows only VPC endpoints that are registered in your account connect to your workspace. ENDPOINT level access allows only specified VPC endpoints connect to your workspace. For details, see allowed_vpc_endpoint_ids.

    privateAccessSettingsId?: string

    private access settings ID.

    privateAccessSettingsName?: string

    The human-readable name of the private access settings object.

    publicAccessEnabled?: boolean

    Determines if the workspace can be accessed over public internet. For fully private workspaces, you can optionally specify false, but only if you implement both the front-end and the back-end PrivateLink connections. Otherwise, specify true, which means that public access is enabled.

    region?: string

    The AWS region for workspaces attached to this private access settings object.

    Settings

    Member Visibility

    On This Page

    Properties