1. Packages
  2. dbt Cloud Provider
  3. API Docs
  4. getPrivatelinkEndpoints
dbt Cloud v1.2.0 published on Wednesday, Oct 15, 2025 by Pulumi

dbtcloud.getPrivatelinkEndpoints

Get Started
dbtcloud logo
dbt Cloud v1.2.0 published on Wednesday, Oct 15, 2025 by Pulumi

    Retrieve information about all PrivateLink endpoints in the dbt Cloud account.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as dbtcloud from "@pulumi/dbtcloud";
    
    export = async () => {
        const all = await dbtcloud.getPrivatelinkEndpoints({});
        const snowflakeEndpoint = .filter(endpoint => endpoint.name == "Snowflake Production Endpoint").map(endpoint => (endpoint))[0];
        // Use the endpoint in a global connection
        const snowflake = new dbtcloud.GlobalConnection("snowflake", {
            name: "Snowflake via PrivateLink",
            privateLinkEndpointId: snowflakeEndpoint.id,
            snowflake: {
                account: "my-snowflake-account",
                database: "ANALYTICS",
                warehouse: "COMPUTE_WH",
            },
        });
        const snowflakeEndpoints = .filter(endpoint => endpoint.type == "snowflake").map(endpoint => (endpoint));
        // Create connections for all Snowflake endpoints
        const snowflakeConnections: dbtcloud.GlobalConnection[] = [];
        for (const range of Object.entries(.reduce((__obj, ep) => ({ ...__obj, [ep.id]: ep }))).map(([k, v]) => ({key: k, value: v}))) {
            snowflakeConnections.push(new dbtcloud.GlobalConnection(`snowflake_connections-${range.key}`, {
                name: `Connection for ${range.value.name}`,
                privateLinkEndpointId: range.value.id,
                snowflake: {
                    account: "my-account",
                    database: "ANALYTICS",
                    warehouse: "COMPUTE_WH",
                },
            }));
        }
    }
    
    import pulumi
    import pulumi_dbtcloud as dbtcloud
    
    all = dbtcloud.get_privatelink_endpoints()
    snowflake_endpoint = [endpoint for endpoint in all.endpoints if endpoint.name == "Snowflake Production Endpoint"][0]
    # Use the endpoint in a global connection
    snowflake = dbtcloud.GlobalConnection("snowflake",
        name="Snowflake via PrivateLink",
        private_link_endpoint_id=snowflake_endpoint.id,
        snowflake={
            "account": "my-snowflake-account",
            "database": "ANALYTICS",
            "warehouse": "COMPUTE_WH",
        })
    snowflake_endpoints = [endpoint for endpoint in all.endpoints if endpoint.type == "snowflake"]
    # Create connections for all Snowflake endpoints
    snowflake_connections = []
    for range in [{"key": k, "value": v} for [k, v] in enumerate({ep.id: ep for ep in snowflake_endpoints})]:
        snowflake_connections.append(dbtcloud.GlobalConnection(f"snowflake_connections-{range['key']}",
            name=f"Connection for {range['value'].name}",
            private_link_endpoint_id=%!v(PANIC=Format method: runtime error: index out of range [-1]),
            snowflake={
                "account": "my-account",
                "database": "ANALYTICS",
                "warehouse": "COMPUTE_WH",
            }))
    
    Example coming soon!
    
    using System.Collections.Generic;
    using System.Linq;
    using System.Threading.Tasks;
    using Pulumi;
    using DbtCloud = Pulumi.DbtCloud;
    
    return await Deployment.RunAsync(async() => 
    {
        var all = await DbtCloud.GetPrivatelinkEndpoints.InvokeAsync();
    
        var snowflakeEndpoint = [0];
    
        // Use the endpoint in a global connection
        var snowflake = new DbtCloud.GlobalConnection("snowflake", new()
        {
            Name = "Snowflake via PrivateLink",
            PrivateLinkEndpointId = snowflakeEndpoint.Id,
            Snowflake = new DbtCloud.Inputs.GlobalConnectionSnowflakeArgs
            {
                Account = "my-snowflake-account",
                Database = "ANALYTICS",
                Warehouse = "COMPUTE_WH",
            },
        });
    
        var snowflakeEndpoints = ;
    
        // Create connections for all Snowflake endpoints
        var snowflakeConnections = new List<DbtCloud.GlobalConnection>();
        foreach (var range in .Select(pair => new { pair.Key, pair.Value }))
        {
            snowflakeConnections.Add(new DbtCloud.GlobalConnection($"snowflake_connections-{range.Key}", new()
            {
                Name = $"Connection for {range.Value.Name}",
                PrivateLinkEndpointId = range.Value.Id,
                Snowflake = new DbtCloud.Inputs.GlobalConnectionSnowflakeArgs
                {
                    Account = "my-account",
                    Database = "ANALYTICS",
                    Warehouse = "COMPUTE_WH",
                },
            }));
        }
    });
    
    Example coming soon!
    
    Example coming soon!
    

    Using getPrivatelinkEndpoints

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPrivatelinkEndpoints(opts?: InvokeOptions): Promise<GetPrivatelinkEndpointsResult>
    function getPrivatelinkEndpointsOutput(opts?: InvokeOptions): Output<GetPrivatelinkEndpointsResult>
    def get_privatelink_endpoints(opts: Optional[InvokeOptions] = None) -> GetPrivatelinkEndpointsResult
    def get_privatelink_endpoints_output(opts: Optional[InvokeOptions] = None) -> Output[GetPrivatelinkEndpointsResult]
    func GetPrivatelinkEndpoints(ctx *Context, opts ...InvokeOption) (*GetPrivatelinkEndpointsResult, error)
    func GetPrivatelinkEndpointsOutput(ctx *Context, opts ...InvokeOption) GetPrivatelinkEndpointsResultOutput

    > Note: This function is named GetPrivatelinkEndpoints in the Go SDK.

    public static class GetPrivatelinkEndpoints 
    {
        public static Task<GetPrivatelinkEndpointsResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetPrivatelinkEndpointsResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPrivatelinkEndpointsResult> getPrivatelinkEndpoints(InvokeOptions options)
    public static Output<GetPrivatelinkEndpointsResult> getPrivatelinkEndpoints(InvokeOptions options)
    
    fn::invoke:
      function: dbtcloud:index/getPrivatelinkEndpoints:getPrivatelinkEndpoints
      arguments:
        # arguments dictionary

    getPrivatelinkEndpoints Result

    The following output properties are available:

    Endpoints List<Pulumi.DbtCloud.Outputs.GetPrivatelinkEndpointsEndpoint>
    A list of all PrivateLink endpoints in the account
    Id string
    The provider-assigned unique ID for this managed resource.
    Endpoints []GetPrivatelinkEndpointsEndpoint
    A list of all PrivateLink endpoints in the account
    Id string
    The provider-assigned unique ID for this managed resource.
    endpoints List<GetPrivatelinkEndpointsEndpoint>
    A list of all PrivateLink endpoints in the account
    id String
    The provider-assigned unique ID for this managed resource.
    endpoints GetPrivatelinkEndpointsEndpoint[]
    A list of all PrivateLink endpoints in the account
    id string
    The provider-assigned unique ID for this managed resource.
    endpoints Sequence[GetPrivatelinkEndpointsEndpoint]
    A list of all PrivateLink endpoints in the account
    id str
    The provider-assigned unique ID for this managed resource.
    endpoints List<Property Map>
    A list of all PrivateLink endpoints in the account
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    GetPrivatelinkEndpointsEndpoint

    CidrRange string
    CIDR range of the PrivateLink Endpoint
    Id string
    The internal ID of the PrivateLink Endpoint
    Name string
    Given descriptive name for the PrivateLink Endpoint
    PrivateLinkEndpointUrl string
    URL of the PrivateLink Endpoint
    Type string
    Type of the PrivateLink Endpoint
    CidrRange string
    CIDR range of the PrivateLink Endpoint
    Id string
    The internal ID of the PrivateLink Endpoint
    Name string
    Given descriptive name for the PrivateLink Endpoint
    PrivateLinkEndpointUrl string
    URL of the PrivateLink Endpoint
    Type string
    Type of the PrivateLink Endpoint
    cidrRange String
    CIDR range of the PrivateLink Endpoint
    id String
    The internal ID of the PrivateLink Endpoint
    name String
    Given descriptive name for the PrivateLink Endpoint
    privateLinkEndpointUrl String
    URL of the PrivateLink Endpoint
    type String
    Type of the PrivateLink Endpoint
    cidrRange string
    CIDR range of the PrivateLink Endpoint
    id string
    The internal ID of the PrivateLink Endpoint
    name string
    Given descriptive name for the PrivateLink Endpoint
    privateLinkEndpointUrl string
    URL of the PrivateLink Endpoint
    type string
    Type of the PrivateLink Endpoint
    cidr_range str
    CIDR range of the PrivateLink Endpoint
    id str
    The internal ID of the PrivateLink Endpoint
    name str
    Given descriptive name for the PrivateLink Endpoint
    private_link_endpoint_url str
    URL of the PrivateLink Endpoint
    type str
    Type of the PrivateLink Endpoint
    cidrRange String
    CIDR range of the PrivateLink Endpoint
    id String
    The internal ID of the PrivateLink Endpoint
    name String
    Given descriptive name for the PrivateLink Endpoint
    privateLinkEndpointUrl String
    URL of the PrivateLink Endpoint
    type String
    Type of the PrivateLink Endpoint

    Package Details

    Repository
    dbtcloud pulumi/pulumi-dbtcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dbtcloud Terraform Provider.
    dbtcloud logo
    dbt Cloud v1.2.0 published on Wednesday, Oct 15, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate