1. Packages
  2. dbt Cloud Provider
  3. API Docs
  4. getPrivatelinkEndpoint
dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi

dbtcloud.getPrivatelinkEndpoint

Explore with Pulumi AI

dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as dbtcloud from "@pulumi/dbtcloud";

const testWithName = dbtcloud.getPrivatelinkEndpoint({
    name: "My Endpoint Name",
});
const testWithUrl = dbtcloud.getPrivatelinkEndpoint({
    privateLinkEndpointUrl: "abc.privatelink.def.com",
});
// in case multiple endpoints have the same name or URL
const testWithNameAndUrl = dbtcloud.getPrivatelinkEndpoint({
    name: "My Endpoint Name",
    privateLinkEndpointUrl: "abc.privatelink.def.com",
});
Copy
import pulumi
import pulumi_dbtcloud as dbtcloud

test_with_name = dbtcloud.get_privatelink_endpoint(name="My Endpoint Name")
test_with_url = dbtcloud.get_privatelink_endpoint(private_link_endpoint_url="abc.privatelink.def.com")
# in case multiple endpoints have the same name or URL
test_with_name_and_url = dbtcloud.get_privatelink_endpoint(name="My Endpoint Name",
    private_link_endpoint_url="abc.privatelink.def.com")
Copy
package main

import (
	"github.com/pulumi/pulumi-dbtcloud/sdk/go/dbtcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dbtcloud.GetPrivatelinkEndpoint(ctx, &dbtcloud.GetPrivatelinkEndpointArgs{
			Name: pulumi.StringRef("My Endpoint Name"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = dbtcloud.GetPrivatelinkEndpoint(ctx, &dbtcloud.GetPrivatelinkEndpointArgs{
			PrivateLinkEndpointUrl: pulumi.StringRef("abc.privatelink.def.com"),
		}, nil)
		if err != nil {
			return err
		}
		// in case multiple endpoints have the same name or URL
		_, err = dbtcloud.GetPrivatelinkEndpoint(ctx, &dbtcloud.GetPrivatelinkEndpointArgs{
			Name:                   pulumi.StringRef("My Endpoint Name"),
			PrivateLinkEndpointUrl: pulumi.StringRef("abc.privatelink.def.com"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DbtCloud = Pulumi.DbtCloud;

return await Deployment.RunAsync(() => 
{
    var testWithName = DbtCloud.GetPrivatelinkEndpoint.Invoke(new()
    {
        Name = "My Endpoint Name",
    });

    var testWithUrl = DbtCloud.GetPrivatelinkEndpoint.Invoke(new()
    {
        PrivateLinkEndpointUrl = "abc.privatelink.def.com",
    });

    // in case multiple endpoints have the same name or URL
    var testWithNameAndUrl = DbtCloud.GetPrivatelinkEndpoint.Invoke(new()
    {
        Name = "My Endpoint Name",
        PrivateLinkEndpointUrl = "abc.privatelink.def.com",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.dbtcloud.DbtcloudFunctions;
import com.pulumi.dbtcloud.inputs.GetPrivatelinkEndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testWithName = DbtcloudFunctions.getPrivatelinkEndpoint(GetPrivatelinkEndpointArgs.builder()
            .name("My Endpoint Name")
            .build());

        final var testWithUrl = DbtcloudFunctions.getPrivatelinkEndpoint(GetPrivatelinkEndpointArgs.builder()
            .privateLinkEndpointUrl("abc.privatelink.def.com")
            .build());

        // in case multiple endpoints have the same name or URL
        final var testWithNameAndUrl = DbtcloudFunctions.getPrivatelinkEndpoint(GetPrivatelinkEndpointArgs.builder()
            .name("My Endpoint Name")
            .privateLinkEndpointUrl("abc.privatelink.def.com")
            .build());

    }
}
Copy
variables:
  testWithName:
    fn::invoke:
      function: dbtcloud:getPrivatelinkEndpoint
      arguments:
        name: My Endpoint Name
  testWithUrl:
    fn::invoke:
      function: dbtcloud:getPrivatelinkEndpoint
      arguments:
        privateLinkEndpointUrl: abc.privatelink.def.com
  # in case multiple endpoints have the same name or URL
  testWithNameAndUrl:
    fn::invoke:
      function: dbtcloud:getPrivatelinkEndpoint
      arguments:
        name: My Endpoint Name
        privateLinkEndpointUrl: abc.privatelink.def.com
Copy

Using getPrivatelinkEndpoint

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 getPrivatelinkEndpoint(args: GetPrivatelinkEndpointArgs, opts?: InvokeOptions): Promise<GetPrivatelinkEndpointResult>
function getPrivatelinkEndpointOutput(args: GetPrivatelinkEndpointOutputArgs, opts?: InvokeOptions): Output<GetPrivatelinkEndpointResult>
Copy
def get_privatelink_endpoint(name: Optional[str] = None,
                             private_link_endpoint_url: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetPrivatelinkEndpointResult
def get_privatelink_endpoint_output(name: Optional[pulumi.Input[str]] = None,
                             private_link_endpoint_url: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetPrivatelinkEndpointResult]
Copy
func GetPrivatelinkEndpoint(ctx *Context, args *GetPrivatelinkEndpointArgs, opts ...InvokeOption) (*GetPrivatelinkEndpointResult, error)
func GetPrivatelinkEndpointOutput(ctx *Context, args *GetPrivatelinkEndpointOutputArgs, opts ...InvokeOption) GetPrivatelinkEndpointResultOutput
Copy

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

public static class GetPrivatelinkEndpoint 
{
    public static Task<GetPrivatelinkEndpointResult> InvokeAsync(GetPrivatelinkEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivatelinkEndpointResult> Invoke(GetPrivatelinkEndpointInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPrivatelinkEndpointResult> getPrivatelinkEndpoint(GetPrivatelinkEndpointArgs args, InvokeOptions options)
public static Output<GetPrivatelinkEndpointResult> getPrivatelinkEndpoint(GetPrivatelinkEndpointArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: dbtcloud:index/getPrivatelinkEndpoint:getPrivatelinkEndpoint
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name string
Given descriptive name for the PrivateLink Endpoint (name and/or privatelinkendpoint_url need to be provided to return data for the datasource)
PrivateLinkEndpointUrl string
The URL of the PrivateLink Endpoint (privatelinkendpoint_url and/or name need to be provided to return data for the datasource)
Name string
Given descriptive name for the PrivateLink Endpoint (name and/or privatelinkendpoint_url need to be provided to return data for the datasource)
PrivateLinkEndpointUrl string
The URL of the PrivateLink Endpoint (privatelinkendpoint_url and/or name need to be provided to return data for the datasource)
name String
Given descriptive name for the PrivateLink Endpoint (name and/or privatelinkendpoint_url need to be provided to return data for the datasource)
privateLinkEndpointUrl String
The URL of the PrivateLink Endpoint (privatelinkendpoint_url and/or name need to be provided to return data for the datasource)
name string
Given descriptive name for the PrivateLink Endpoint (name and/or privatelinkendpoint_url need to be provided to return data for the datasource)
privateLinkEndpointUrl string
The URL of the PrivateLink Endpoint (privatelinkendpoint_url and/or name need to be provided to return data for the datasource)
name str
Given descriptive name for the PrivateLink Endpoint (name and/or privatelinkendpoint_url need to be provided to return data for the datasource)
private_link_endpoint_url str
The URL of the PrivateLink Endpoint (privatelinkendpoint_url and/or name need to be provided to return data for the datasource)
name String
Given descriptive name for the PrivateLink Endpoint (name and/or privatelinkendpoint_url need to be provided to return data for the datasource)
privateLinkEndpointUrl String
The URL of the PrivateLink Endpoint (privatelinkendpoint_url and/or name need to be provided to return data for the datasource)

getPrivatelinkEndpoint Result

The following output properties are available:

CidrRange string
The CIDR range of the PrivateLink Endpoint
Id string
The internal ID of the PrivateLink Endpoint
State int
PrivatelinkEndpoint state should be 1 = active, as 2 = deleted

Deprecated: Remove this attribute's configuration as it's no longer in use and the attribute will be removed in the next major version of the provider.

Type string
Type of the PrivateLink Endpoint
Name string
Given descriptive name for the PrivateLink Endpoint (name and/or privatelinkendpoint_url need to be provided to return data for the datasource)
PrivateLinkEndpointUrl string
The URL of the PrivateLink Endpoint (privatelinkendpoint_url and/or name need to be provided to return data for the datasource)
CidrRange string
The CIDR range of the PrivateLink Endpoint
Id string
The internal ID of the PrivateLink Endpoint
State int
PrivatelinkEndpoint state should be 1 = active, as 2 = deleted

Deprecated: Remove this attribute's configuration as it's no longer in use and the attribute will be removed in the next major version of the provider.

Type string
Type of the PrivateLink Endpoint
Name string
Given descriptive name for the PrivateLink Endpoint (name and/or privatelinkendpoint_url need to be provided to return data for the datasource)
PrivateLinkEndpointUrl string
The URL of the PrivateLink Endpoint (privatelinkendpoint_url and/or name need to be provided to return data for the datasource)
cidrRange String
The CIDR range of the PrivateLink Endpoint
id String
The internal ID of the PrivateLink Endpoint
state Integer
PrivatelinkEndpoint state should be 1 = active, as 2 = deleted

Deprecated: Remove this attribute's configuration as it's no longer in use and the attribute will be removed in the next major version of the provider.

type String
Type of the PrivateLink Endpoint
name String
Given descriptive name for the PrivateLink Endpoint (name and/or privatelinkendpoint_url need to be provided to return data for the datasource)
privateLinkEndpointUrl String
The URL of the PrivateLink Endpoint (privatelinkendpoint_url and/or name need to be provided to return data for the datasource)
cidrRange string
The CIDR range of the PrivateLink Endpoint
id string
The internal ID of the PrivateLink Endpoint
state number
PrivatelinkEndpoint state should be 1 = active, as 2 = deleted

Deprecated: Remove this attribute's configuration as it's no longer in use and the attribute will be removed in the next major version of the provider.

type string
Type of the PrivateLink Endpoint
name string
Given descriptive name for the PrivateLink Endpoint (name and/or privatelinkendpoint_url need to be provided to return data for the datasource)
privateLinkEndpointUrl string
The URL of the PrivateLink Endpoint (privatelinkendpoint_url and/or name need to be provided to return data for the datasource)
cidr_range str
The CIDR range of the PrivateLink Endpoint
id str
The internal ID of the PrivateLink Endpoint
state int
PrivatelinkEndpoint state should be 1 = active, as 2 = deleted

Deprecated: Remove this attribute's configuration as it's no longer in use and the attribute will be removed in the next major version of the provider.

type str
Type of the PrivateLink Endpoint
name str
Given descriptive name for the PrivateLink Endpoint (name and/or privatelinkendpoint_url need to be provided to return data for the datasource)
private_link_endpoint_url str
The URL of the PrivateLink Endpoint (privatelinkendpoint_url and/or name need to be provided to return data for the datasource)
cidrRange String
The CIDR range of the PrivateLink Endpoint
id String
The internal ID of the PrivateLink Endpoint
state Number
PrivatelinkEndpoint state should be 1 = active, as 2 = deleted

Deprecated: Remove this attribute's configuration as it's no longer in use and the attribute will be removed in the next major version of the provider.

type String
Type of the PrivateLink Endpoint
name String
Given descriptive name for the PrivateLink Endpoint (name and/or privatelinkendpoint_url need to be provided to return data for the datasource)
privateLinkEndpointUrl String
The URL of the PrivateLink Endpoint (privatelinkendpoint_url and/or name need to be provided to return data for the datasource)

Package Details

Repository
dbtcloud pulumi/pulumi-dbtcloud
License
Apache-2.0
Notes
This Pulumi package is based on the dbtcloud Terraform Provider.
dbt Cloud v0.1.30 published on Thursday, Mar 20, 2025 by Pulumi