1. Packages
  2. Fivetran Provider
  3. API Docs
  4. getPrivateLink
Viewing docs for fivetran 1.9.25
published on Tuesday, Feb 24, 2026 by fivetran
Schema (JSON)
fivetran/terraform-provider-fivetran

fivetran.getPrivateLink

fivetran logo
Viewing docs for fivetran 1.9.25
published on Tuesday, Feb 24, 2026 by fivetran
Schema (JSON)
fivetran/terraform-provider-fivetran

    This data source returns a private link object.

    Example Usage

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

const privateLink = fivetran.getPrivateLink({
    id: "private_link_id",
});

    import pulumi
import pulumi_fivetran as fivetran

private_link = fivetran.get_private_link(id="private_link_id")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/fivetran/fivetran"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fivetran.LookupPrivateLink(ctx, &fivetran.LookupPrivateLinkArgs{
			Id: "private_link_id",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fivetran = Pulumi.Fivetran;

return await Deployment.RunAsync(() => 
{
    var privateLink = Fivetran.GetPrivateLink.Invoke(new()
    {
        Id = "private_link_id",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fivetran.FivetranFunctions;
import com.pulumi.fivetran.inputs.GetPrivateLinkArgs;
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 privateLink = FivetranFunctions.getPrivateLink(GetPrivateLinkArgs.builder()
            .id("private_link_id")
            .build());

    }
}

    variables:
  privateLink:
    fn::invoke:
      function: fivetran:getPrivateLink
      arguments:
        id: private_link_id

    Using getPrivateLink

    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 getPrivateLink(args: GetPrivateLinkArgs, opts?: InvokeOptions): Promise<GetPrivateLinkResult>
function getPrivateLinkOutput(args: GetPrivateLinkOutputArgs, opts?: InvokeOptions): Output<GetPrivateLinkResult>
    def get_private_link(id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetPrivateLinkResult
def get_private_link_output(id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetPrivateLinkResult]
    func LookupPrivateLink(ctx *Context, args *LookupPrivateLinkArgs, opts ...InvokeOption) (*LookupPrivateLinkResult, error)
func LookupPrivateLinkOutput(ctx *Context, args *LookupPrivateLinkOutputArgs, opts ...InvokeOption) LookupPrivateLinkResultOutput

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

    public static class GetPrivateLink 
{
    public static Task<GetPrivateLinkResult> InvokeAsync(GetPrivateLinkArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateLinkResult> Invoke(GetPrivateLinkInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPrivateLinkResult> getPrivateLink(GetPrivateLinkArgs args, InvokeOptions options)
public static Output<GetPrivateLinkResult> getPrivateLink(GetPrivateLinkArgs args, InvokeOptions options)

    fn::invoke:
  function: fivetran:index/getPrivateLink:getPrivateLink
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The unique identifier for the private link within the Fivetran system.
    Id string
    The unique identifier for the private link within the Fivetran system.
    id String
    The unique identifier for the private link within the Fivetran system.
    id string
    The unique identifier for the private link within the Fivetran system.
    id str
    The unique identifier for the private link within the Fivetran system.
    id String
    The unique identifier for the private link within the Fivetran system.

    getPrivateLink Result

    The following output properties are available:

    CloudProvider string
    The cloud provider name.
    ConfigMap Dictionary<string, string>
    Configuration.
    CreatedAt string
    The date and time the membership was created.
    CreatedBy string
    The unique identifier for the User within the Fivetran system.
    Host string
    The private link host.
    Id string
    The unique identifier for the private link within the Fivetran system.
    Name string
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    Region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    Service string
    Service type.
    State string
    The state of the private link.
    StateSummary string
    The state of the private link.
    CloudProvider string
    The cloud provider name.
    ConfigMap map[string]string
    Configuration.
    CreatedAt string
    The date and time the membership was created.
    CreatedBy string
    The unique identifier for the User within the Fivetran system.
    Host string
    The private link host.
    Id string
    The unique identifier for the private link within the Fivetran system.
    Name string
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    Region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    Service string
    Service type.
    State string
    The state of the private link.
    StateSummary string
    The state of the private link.
    cloudProvider String
    The cloud provider name.
    configMap Map<String,String>
    Configuration.
    createdAt String
    The date and time the membership was created.
    createdBy String
    The unique identifier for the User within the Fivetran system.
    host String
    The private link host.
    id String
    The unique identifier for the private link within the Fivetran system.
    name String
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    region String
    Data processing location. This is where Fivetran will operate and run computation on data.
    service String
    Service type.
    state String
    The state of the private link.
    stateSummary String
    The state of the private link.
    cloudProvider string
    The cloud provider name.
    configMap {[key: string]: string}
    Configuration.
    createdAt string
    The date and time the membership was created.
    createdBy string
    The unique identifier for the User within the Fivetran system.
    host string
    The private link host.
    id string
    The unique identifier for the private link within the Fivetran system.
    name string
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    region string
    Data processing location. This is where Fivetran will operate and run computation on data.
    service string
    Service type.
    state string
    The state of the private link.
    stateSummary string
    The state of the private link.
    cloud_provider str
    The cloud provider name.
    config_map Mapping[str, str]
    Configuration.
    created_at str
    The date and time the membership was created.
    created_by str
    The unique identifier for the User within the Fivetran system.
    host str
    The private link host.
    id str
    The unique identifier for the private link within the Fivetran system.
    name str
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    region str
    Data processing location. This is where Fivetran will operate and run computation on data.
    service str
    Service type.
    state str
    The state of the private link.
    state_summary str
    The state of the private link.
    cloudProvider String
    The cloud provider name.
    configMap Map<String>
    Configuration.
    createdAt String
    The date and time the membership was created.
    createdBy String
    The unique identifier for the User within the Fivetran system.
    host String
    The private link host.
    id String
    The unique identifier for the private link within the Fivetran system.
    name String
    The private link name within the account. The name must start with a letter or underscore and can only contain letters, numbers, or underscores. Maximum size of name is 23 characters.
    region String
    Data processing location. This is where Fivetran will operate and run computation on data.
    service String
    Service type.
    state String
    The state of the private link.
    stateSummary String
    The state of the private link.

    Package Details

    Repository
    fivetran fivetran/terraform-provider-fivetran
    License
    Notes
    This Pulumi package is based on the fivetran Terraform Provider.
    fivetran logo
    Viewing docs for fivetran 1.9.25
    published on Tuesday, Feb 24, 2026 by fivetran
    Schema (JSON)
    fivetran/terraform-provider-fivetran
      Try Pulumi Cloud free. Your team will thank you.