Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. getPrivateLinkAccess
Confluent v2.21.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.getPrivateLinkAccess

Explore with Pulumi AI

confluentcloud logo
Confluent v2.21.0 published on Wednesday, Mar 19, 2025 by Pulumi
pulumi/pulumi-confluentcloud

    General Availability

    confluentcloud.PrivateLinkAccess describes a Private Link Access data source.

    Example Usage

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

export = async () => {
    const exampleUsingId = await confluentcloud.getPrivateLinkAccess({
        id: "pla-abc123",
        environment: {
            id: "env-xyz456",
        },
    });
    const exampleUsingName = await confluentcloud.getPrivateLinkAccess({
        displayName: "my_pla",
        environment: {
            id: "env-xyz456",
        },
    });
    return {
        exampleUsingId: exampleUsingId,
        exampleUsingName: exampleUsingName,
    };
}

    import pulumi
import pulumi_confluentcloud as confluentcloud

example_using_id = confluentcloud.get_private_link_access(id="pla-abc123",
    environment={
        "id": "env-xyz456",
    })
pulumi.export("exampleUsingId", example_using_id)
example_using_name = confluentcloud.get_private_link_access(display_name="my_pla",
    environment={
        "id": "env-xyz456",
    })
pulumi.export("exampleUsingName", example_using_name)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleUsingId, err := confluentcloud.LookupPrivateLinkAccess(ctx, &confluentcloud.LookupPrivateLinkAccessArgs{
			Id: pulumi.StringRef("pla-abc123"),
			Environment: confluentcloud.GetPrivateLinkAccessEnvironment{
				Id: "env-xyz456",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("exampleUsingId", exampleUsingId)
		exampleUsingName, err := confluentcloud.LookupPrivateLinkAccess(ctx, &confluentcloud.LookupPrivateLinkAccessArgs{
			DisplayName: pulumi.StringRef("my_pla"),
			Environment: confluentcloud.GetPrivateLinkAccessEnvironment{
				Id: "env-xyz456",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("exampleUsingName", exampleUsingName)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleUsingId = ConfluentCloud.GetPrivateLinkAccess.Invoke(new()
    {
        Id = "pla-abc123",
        Environment = new ConfluentCloud.Inputs.GetPrivateLinkAccessEnvironmentInputArgs
        {
            Id = "env-xyz456",
        },
    });

    var exampleUsingName = ConfluentCloud.GetPrivateLinkAccess.Invoke(new()
    {
        DisplayName = "my_pla",
        Environment = new ConfluentCloud.Inputs.GetPrivateLinkAccessEnvironmentInputArgs
        {
            Id = "env-xyz456",
        },
    });

    return new Dictionary<string, object?>
    {
        ["exampleUsingId"] = exampleUsingId,
        ["exampleUsingName"] = exampleUsingName,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.confluentcloud.ConfluentcloudFunctions;
import com.pulumi.confluentcloud.inputs.GetPrivateLinkAccessArgs;
import com.pulumi.confluentcloud.inputs.GetPrivateLinkAccessEnvironmentArgs;
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 exampleUsingId = ConfluentcloudFunctions.getPrivateLinkAccess(GetPrivateLinkAccessArgs.builder()
            .id("pla-abc123")
            .environment(GetPrivateLinkAccessEnvironmentArgs.builder()
                .id("env-xyz456")
                .build())
            .build());

        ctx.export("exampleUsingId", exampleUsingId.applyValue(getPrivateLinkAccessResult -> getPrivateLinkAccessResult));
        final var exampleUsingName = ConfluentcloudFunctions.getPrivateLinkAccess(GetPrivateLinkAccessArgs.builder()
            .displayName("my_pla")
            .environment(GetPrivateLinkAccessEnvironmentArgs.builder()
                .id("env-xyz456")
                .build())
            .build());

        ctx.export("exampleUsingName", exampleUsingName.applyValue(getPrivateLinkAccessResult -> getPrivateLinkAccessResult));
    }
}

    variables:
  exampleUsingId:
    fn::invoke:
      function: confluentcloud:getPrivateLinkAccess
      arguments:
        id: pla-abc123
        environment:
          id: env-xyz456
  exampleUsingName:
    fn::invoke:
      function: confluentcloud:getPrivateLinkAccess
      arguments:
        displayName: my_pla
        environment:
          id: env-xyz456
outputs:
  exampleUsingId: ${exampleUsingId}
  exampleUsingName: ${exampleUsingName}

    Using getPrivateLinkAccess

    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 getPrivateLinkAccess(args: GetPrivateLinkAccessArgs, opts?: InvokeOptions): Promise<GetPrivateLinkAccessResult>
function getPrivateLinkAccessOutput(args: GetPrivateLinkAccessOutputArgs, opts?: InvokeOptions): Output<GetPrivateLinkAccessResult>
    def get_private_link_access(display_name: Optional[str] = None,
                            environment: Optional[GetPrivateLinkAccessEnvironment] = None,
                            id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPrivateLinkAccessResult
def get_private_link_access_output(display_name: Optional[pulumi.Input[str]] = None,
                            environment: Optional[pulumi.Input[GetPrivateLinkAccessEnvironmentArgs]] = None,
                            id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPrivateLinkAccessResult]
    func LookupPrivateLinkAccess(ctx *Context, args *LookupPrivateLinkAccessArgs, opts ...InvokeOption) (*LookupPrivateLinkAccessResult, error)
func LookupPrivateLinkAccessOutput(ctx *Context, args *LookupPrivateLinkAccessOutputArgs, opts ...InvokeOption) LookupPrivateLinkAccessResultOutput

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

    public static class GetPrivateLinkAccess 
{
    public static Task<GetPrivateLinkAccessResult> InvokeAsync(GetPrivateLinkAccessArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateLinkAccessResult> Invoke(GetPrivateLinkAccessInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPrivateLinkAccessResult> getPrivateLinkAccess(GetPrivateLinkAccessArgs args, InvokeOptions options)
public static Output<GetPrivateLinkAccessResult> getPrivateLinkAccess(GetPrivateLinkAccessArgs args, InvokeOptions options)

    fn::invoke:
  function: confluentcloud:index/getPrivateLinkAccess:getPrivateLinkAccess
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Environment Pulumi.ConfluentCloud.Inputs.GetPrivateLinkAccessEnvironment
    (Required Configuration Block) supports the following:
    DisplayName string
    A human-readable name for the Private Link Access.
    Id string
    The ID of the Private Link Access, for example, pla-abc123.
    Environment GetPrivateLinkAccessEnvironment
    (Required Configuration Block) supports the following:
    DisplayName string
    A human-readable name for the Private Link Access.
    Id string
    The ID of the Private Link Access, for example, pla-abc123.
    environment GetPrivateLinkAccessEnvironment
    (Required Configuration Block) supports the following:
    displayName String
    A human-readable name for the Private Link Access.
    id String
    The ID of the Private Link Access, for example, pla-abc123.
    environment GetPrivateLinkAccessEnvironment
    (Required Configuration Block) supports the following:
    displayName string
    A human-readable name for the Private Link Access.
    id string
    The ID of the Private Link Access, for example, pla-abc123.
    environment GetPrivateLinkAccessEnvironment
    (Required Configuration Block) supports the following:
    display_name str
    A human-readable name for the Private Link Access.
    id str
    The ID of the Private Link Access, for example, pla-abc123.
    environment Property Map
    (Required Configuration Block) supports the following:
    displayName String
    A human-readable name for the Private Link Access.
    id String
    The ID of the Private Link Access, for example, pla-abc123.

    getPrivateLinkAccess Result

    The following output properties are available:

    Aws List<Pulumi.ConfluentCloud.Outputs.GetPrivateLinkAccessAw>
    (Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:
    Azures List<Pulumi.ConfluentCloud.Outputs.GetPrivateLinkAccessAzure>
    (Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:
    DisplayName string
    (Optional String) The name of the Private Link Access.
    Environment Pulumi.ConfluentCloud.Outputs.GetPrivateLinkAccessEnvironment
    (Required Configuration Block) supports the following:
    Gcps List<Pulumi.ConfluentCloud.Outputs.GetPrivateLinkAccessGcp>
    (Optional Configuration Block) The GCP-specific Private Service Connect details if available. It supports the following:
    Id string
    (Required String) The ID of the Network that the Private Link Access belongs to, for example, n-abc123.
    Networks List<Pulumi.ConfluentCloud.Outputs.GetPrivateLinkAccessNetwork>
    (Required Configuration Block) supports the following:
    Aws []GetPrivateLinkAccessAw
    (Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:
    Azures []GetPrivateLinkAccessAzure
    (Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:
    DisplayName string
    (Optional String) The name of the Private Link Access.
    Environment GetPrivateLinkAccessEnvironment
    (Required Configuration Block) supports the following:
    Gcps []GetPrivateLinkAccessGcp
    (Optional Configuration Block) The GCP-specific Private Service Connect details if available. It supports the following:
    Id string
    (Required String) The ID of the Network that the Private Link Access belongs to, for example, n-abc123.
    Networks []GetPrivateLinkAccessNetwork
    (Required Configuration Block) supports the following:
    aws List<GetPrivateLinkAccessAw>
    (Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:
    azures List<GetPrivateLinkAccessAzure>
    (Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:
    displayName String
    (Optional String) The name of the Private Link Access.
    environment GetPrivateLinkAccessEnvironment
    (Required Configuration Block) supports the following:
    gcps List<GetPrivateLinkAccessGcp>
    (Optional Configuration Block) The GCP-specific Private Service Connect details if available. It supports the following:
    id String
    (Required String) The ID of the Network that the Private Link Access belongs to, for example, n-abc123.
    networks List<GetPrivateLinkAccessNetwork>
    (Required Configuration Block) supports the following:
    aws GetPrivateLinkAccessAw[]
    (Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:
    azures GetPrivateLinkAccessAzure[]
    (Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:
    displayName string
    (Optional String) The name of the Private Link Access.
    environment GetPrivateLinkAccessEnvironment
    (Required Configuration Block) supports the following:
    gcps GetPrivateLinkAccessGcp[]
    (Optional Configuration Block) The GCP-specific Private Service Connect details if available. It supports the following:
    id string
    (Required String) The ID of the Network that the Private Link Access belongs to, for example, n-abc123.
    networks GetPrivateLinkAccessNetwork[]
    (Required Configuration Block) supports the following:
    aws Sequence[GetPrivateLinkAccessAw]
    (Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:
    azures Sequence[GetPrivateLinkAccessAzure]
    (Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:
    display_name str
    (Optional String) The name of the Private Link Access.
    environment GetPrivateLinkAccessEnvironment
    (Required Configuration Block) supports the following:
    gcps Sequence[GetPrivateLinkAccessGcp]
    (Optional Configuration Block) The GCP-specific Private Service Connect details if available. It supports the following:
    id str
    (Required String) The ID of the Network that the Private Link Access belongs to, for example, n-abc123.
    networks Sequence[GetPrivateLinkAccessNetwork]
    (Required Configuration Block) supports the following:
    aws List<Property Map>
    (Optional Configuration Block) The AWS-specific Private Link Access details if available. It supports the following:
    azures List<Property Map>
    (Optional Configuration Block) The Azure-specific Private Link Access details if available. It supports the following:
    displayName String
    (Optional String) The name of the Private Link Access.
    environment Property Map
    (Required Configuration Block) supports the following:
    gcps List<Property Map>
    (Optional Configuration Block) The GCP-specific Private Service Connect details if available. It supports the following:
    id String
    (Required String) The ID of the Network that the Private Link Access belongs to, for example, n-abc123.
    networks List<Property Map>
    (Required Configuration Block) supports the following:

    Supporting Types

    GetPrivateLinkAccessAw

    Account string
    (Required String) The AWS account ID to enable for the Private Link Access. You can find your AWS account ID here under My Account in your AWS Management Console. Must be a 12 character string.
    Account string
    (Required String) The AWS account ID to enable for the Private Link Access. You can find your AWS account ID here under My Account in your AWS Management Console. Must be a 12 character string.
    account String
    (Required String) The AWS account ID to enable for the Private Link Access. You can find your AWS account ID here under My Account in your AWS Management Console. Must be a 12 character string.
    account string
    (Required String) The AWS account ID to enable for the Private Link Access. You can find your AWS account ID here under My Account in your AWS Management Console. Must be a 12 character string.
    account str
    (Required String) The AWS account ID to enable for the Private Link Access. You can find your AWS account ID here under My Account in your AWS Management Console. Must be a 12 character string.
    account String
    (Required String) The AWS account ID to enable for the Private Link Access. You can find your AWS account ID here under My Account in your AWS Management Console. Must be a 12 character string.

    GetPrivateLinkAccessAzure

    Subscription string
    (Required String) The Azure subscription ID to enable for the Private Link Access. You can find your Azure subscription ID in the subscription section of your Microsoft Azure Portal. Must be a valid 32 character UUID string.
    Subscription string
    (Required String) The Azure subscription ID to enable for the Private Link Access. You can find your Azure subscription ID in the subscription section of your Microsoft Azure Portal. Must be a valid 32 character UUID string.
    subscription String
    (Required String) The Azure subscription ID to enable for the Private Link Access. You can find your Azure subscription ID in the subscription section of your Microsoft Azure Portal. Must be a valid 32 character UUID string.
    subscription string
    (Required String) The Azure subscription ID to enable for the Private Link Access. You can find your Azure subscription ID in the subscription section of your Microsoft Azure Portal. Must be a valid 32 character UUID string.
    subscription str
    (Required String) The Azure subscription ID to enable for the Private Link Access. You can find your Azure subscription ID in the subscription section of your Microsoft Azure Portal. Must be a valid 32 character UUID string.
    subscription String
    (Required String) The Azure subscription ID to enable for the Private Link Access. You can find your Azure subscription ID in the subscription section of your Microsoft Azure Portal. Must be a valid 32 character UUID string.

    GetPrivateLinkAccessEnvironment

    Id string

    The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    Id string

    The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id String

    The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id string

    The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id str

    The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    id String

    The ID of the Environment that the Private Link Access belongs to, for example, env-xyz456.

    Note: Exactly one from the id and display_name attributes must be specified.

    GetPrivateLinkAccessGcp

    Project string
    (Required String) The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
    Project string
    (Required String) The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
    project String
    (Required String) The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
    project string
    (Required String) The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
    project str
    (Required String) The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.
    project String
    (Required String) The GCP project ID to allow for Private Service Connect access. You can find your Google Cloud Project ID under Project ID section of your Google Cloud Console dashboard.

    GetPrivateLinkAccessNetwork

    Id string
    The ID of the Private Link Access, for example, pla-abc123.
    Id string
    The ID of the Private Link Access, for example, pla-abc123.
    id String
    The ID of the Private Link Access, for example, pla-abc123.
    id string
    The ID of the Private Link Access, for example, pla-abc123.
    id str
    The ID of the Private Link Access, for example, pla-abc123.
    id String
    The ID of the Private Link Access, for example, pla-abc123.

    Package Details

    Repository
    Confluent Cloud pulumi/pulumi-confluentcloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the confluent Terraform Provider.
    confluentcloud logo
    Confluent v2.21.0 published on Wednesday, Mar 19, 2025 by Pulumi
    pulumi/pulumi-confluentcloud