Databricks SDK for JavaScript
    Preparing search index...

    Interface NetworkConnectivityConfigAwsPrivateEndpointRule

    Properties of the new private endpoint rule. Note that for private endpoints towards a VPC endpoint service behind a customer-managed NLB, you must approve the endpoint in AWS console after initialization.

    interface NetworkConnectivityConfigAwsPrivateEndpointRule {
        accountId?: string;
        connectionState?: NetworkConnectivityConfigAwsPrivateEndpointRule_PrivateLinkConnectionState;
        creationTime?: bigint;
        deactivated?: boolean;
        deactivatedAt?: bigint;
        domainNames?: string[];
        enabled?: boolean;
        endpointService?: string;
        errorMessage?: string;
        networkConnectivityConfigId?: string;
        resourceNames?: string[];
        ruleId?: string;
        updatedTime?: bigint;
        vpcEndpointId?: string;
    }
    Index

    Properties

    accountId? connectionState? creationTime? deactivated? deactivatedAt? domainNames? enabled? endpointService? errorMessage? networkConnectivityConfigId? resourceNames? ruleId? updatedTime? vpcEndpointId?

    Properties

    accountId?: string

    account ID. You can find your account ID from the Accounts Console.

    connectionState?: NetworkConnectivityConfigAwsPrivateEndpointRule_PrivateLinkConnectionState

    The current status of this private endpoint. The private endpoint rules are effective only if the connection state is ESTABLISHED. Remember that you must approve new endpoints on your resources in the AWS console before they take effect. The possible values are:

    • PENDING: The endpoint has been created and pending approval.
    • ESTABLISHED: The endpoint has been approved and is ready to use in your serverless compute resources.
    • REJECTED: Connection was rejected by the private link resource owner.
    • DISCONNECTED: Connection was removed by the private link resource owner, the private endpoint becomes informative and should be deleted for clean-up.
    • EXPIRED: If the endpoint is created but not approved in 14 days, it is EXPIRED.
    creationTime?: bigint

    Time in epoch milliseconds when this object was created.

    deactivated?: boolean

    Whether this private endpoint is deactivated.

    deactivatedAt?: bigint

    Time in epoch milliseconds when this object was deactivated.

    domainNames?: string[]

    Only used by private endpoints towards a VPC endpoint service for customer-managed VPC endpoint service.

    The target AWS resource FQDNs accessible via the VPC endpoint service. When updating this field, we perform full update on this field. Please ensure a full list of desired domain_names is provided.

    enabled?: boolean

    Only used by private endpoints towards an AWS S3 service.

    Update this field to activate/deactivate this private endpoint to allow egress access from serverless compute resources.

    endpointService?: string

    The full target AWS endpoint service name that connects to the destination resources of the private endpoint.

    errorMessage?: string
    networkConnectivityConfigId?: string

    The ID of a network connectivity configuration, which is the parent resource of this private endpoint rule object.

    resourceNames?: string[]

    Only used by private endpoints towards AWS S3 service.

    The globally unique S3 bucket names that will be accessed via the VPC endpoint. The bucket names must be in the same region as the NCC/endpoint service. When updating this field, we perform full update on this field. Please ensure a full list of desired resource_names is provided.

    ruleId?: string

    The ID of a private endpoint rule.

    updatedTime?: bigint

    Time in epoch milliseconds when this object was updated.

    vpcEndpointId?: string

    The AWS VPC endpoint ID. You can use this ID to identify VPC endpoint created by .

    Settings

    Member Visibility

    On This Page

    Properties