Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. getPrivateLinkAttachment
Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.getPrivateLinkAttachment

Explore with Pulumi AI

Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud

General Availability

confluentcloud.PrivateLinkAttachment describes a Private Link Attachment data source.

Example Usage

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

const main = confluentcloud.getPrivateLinkAttachment({
    id: "platt-abcde",
    environment: {
        id: "env-1234",
    },
});
export const platt = main;
Copy
import pulumi
import pulumi_confluentcloud as confluentcloud

main = confluentcloud.get_private_link_attachment(id="platt-abcde",
    environment={
        "id": "env-1234",
    })
pulumi.export("platt", main)
Copy
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 {
		main, err := confluentcloud.LookupPrivateLinkAttachment(ctx, &confluentcloud.LookupPrivateLinkAttachmentArgs{
			Id: "platt-abcde",
			Environment: confluentcloud.GetPrivateLinkAttachmentEnvironment{
				Id: "env-1234",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("platt", main)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using ConfluentCloud = Pulumi.ConfluentCloud;

return await Deployment.RunAsync(() => 
{
    var main = ConfluentCloud.GetPrivateLinkAttachment.Invoke(new()
    {
        Id = "platt-abcde",
        Environment = new ConfluentCloud.Inputs.GetPrivateLinkAttachmentEnvironmentInputArgs
        {
            Id = "env-1234",
        },
    });

    return new Dictionary<string, object?>
    {
        ["platt"] = main,
    };
});
Copy
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.GetPrivateLinkAttachmentArgs;
import com.pulumi.confluentcloud.inputs.GetPrivateLinkAttachmentEnvironmentArgs;
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 main = ConfluentcloudFunctions.getPrivateLinkAttachment(GetPrivateLinkAttachmentArgs.builder()
            .id("platt-abcde")
            .environment(GetPrivateLinkAttachmentEnvironmentArgs.builder()
                .id("env-1234")
                .build())
            .build());

        ctx.export("platt", main.applyValue(getPrivateLinkAttachmentResult -> getPrivateLinkAttachmentResult));
    }
}
Copy
variables:
  main:
    fn::invoke:
      function: confluentcloud:getPrivateLinkAttachment
      arguments:
        id: platt-abcde
        environment:
          id: env-1234
outputs:
  platt: ${main}
Copy

Getting Started

The following end-to-end examples might help to get started with confluentcloud.PrivateLinkAttachment data source:

  • enterprise-privatelinkattachment-aws-kafka-acls: Enterprise Kafka cluster on AWS that is accessible via PrivateLink connections with authorization using ACLs
  • enterprise-privatelinkattachment-azure-kafka-acls: Enterprise Kafka cluster on Azure that is accessible via PrivateLink connections with authorization using ACLs

Using getPrivateLinkAttachment

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 getPrivateLinkAttachment(args: GetPrivateLinkAttachmentArgs, opts?: InvokeOptions): Promise<GetPrivateLinkAttachmentResult>
function getPrivateLinkAttachmentOutput(args: GetPrivateLinkAttachmentOutputArgs, opts?: InvokeOptions): Output<GetPrivateLinkAttachmentResult>
Copy
def get_private_link_attachment(environment: Optional[GetPrivateLinkAttachmentEnvironment] = None,
                                id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetPrivateLinkAttachmentResult
def get_private_link_attachment_output(environment: Optional[pulumi.Input[GetPrivateLinkAttachmentEnvironmentArgs]] = None,
                                id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetPrivateLinkAttachmentResult]
Copy
func LookupPrivateLinkAttachment(ctx *Context, args *LookupPrivateLinkAttachmentArgs, opts ...InvokeOption) (*LookupPrivateLinkAttachmentResult, error)
func LookupPrivateLinkAttachmentOutput(ctx *Context, args *LookupPrivateLinkAttachmentOutputArgs, opts ...InvokeOption) LookupPrivateLinkAttachmentResultOutput
Copy

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

public static class GetPrivateLinkAttachment 
{
    public static Task<GetPrivateLinkAttachmentResult> InvokeAsync(GetPrivateLinkAttachmentArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateLinkAttachmentResult> Invoke(GetPrivateLinkAttachmentInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetPrivateLinkAttachmentResult> getPrivateLinkAttachment(GetPrivateLinkAttachmentArgs args, InvokeOptions options)
public static Output<GetPrivateLinkAttachmentResult> getPrivateLinkAttachment(GetPrivateLinkAttachmentArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: confluentcloud:index/getPrivateLinkAttachment:getPrivateLinkAttachment
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Environment This property is required. Pulumi.ConfluentCloud.Inputs.GetPrivateLinkAttachmentEnvironment
Id This property is required. string
The ID of the Private Link Attachment, for example, platt-61ovvd.
Environment This property is required. GetPrivateLinkAttachmentEnvironment
Id This property is required. string
The ID of the Private Link Attachment, for example, platt-61ovvd.
environment This property is required. GetPrivateLinkAttachmentEnvironment
id This property is required. String
The ID of the Private Link Attachment, for example, platt-61ovvd.
environment This property is required. GetPrivateLinkAttachmentEnvironment
id This property is required. string
The ID of the Private Link Attachment, for example, platt-61ovvd.
environment This property is required. GetPrivateLinkAttachmentEnvironment
id This property is required. str
The ID of the Private Link Attachment, for example, platt-61ovvd.
environment This property is required. Property Map
id This property is required. String
The ID of the Private Link Attachment, for example, platt-61ovvd.

getPrivateLinkAttachment Result

The following output properties are available:

Aws List<Pulumi.ConfluentCloud.Outputs.GetPrivateLinkAttachmentAw>
(Optional Configuration Block) supports the following:
Azures List<Pulumi.ConfluentCloud.Outputs.GetPrivateLinkAttachmentAzure>
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
Cloud string
(Optional String) The cloud service provider that hosts the resources to access with the Private Link Attachment.
DisplayName string
(Optional String) The name of the Private Link Attachment.
DnsDomain string
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
Environment Pulumi.ConfluentCloud.Outputs.GetPrivateLinkAttachmentEnvironment
Gcps List<Pulumi.ConfluentCloud.Outputs.GetPrivateLinkAttachmentGcp>
(Optional Configuration Block) supports the following:
Id string
Region string
(Optional String) The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
ResourceName string
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
Aws []GetPrivateLinkAttachmentAw
(Optional Configuration Block) supports the following:
Azures []GetPrivateLinkAttachmentAzure
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
Cloud string
(Optional String) The cloud service provider that hosts the resources to access with the Private Link Attachment.
DisplayName string
(Optional String) The name of the Private Link Attachment.
DnsDomain string
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
Environment GetPrivateLinkAttachmentEnvironment
Gcps []GetPrivateLinkAttachmentGcp
(Optional Configuration Block) supports the following:
Id string
Region string
(Optional String) The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
ResourceName string
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
aws List<GetPrivateLinkAttachmentAw>
(Optional Configuration Block) supports the following:
azures List<GetPrivateLinkAttachmentAzure>
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
cloud String
(Optional String) The cloud service provider that hosts the resources to access with the Private Link Attachment.
displayName String
(Optional String) The name of the Private Link Attachment.
dnsDomain String
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
environment GetPrivateLinkAttachmentEnvironment
gcps List<GetPrivateLinkAttachmentGcp>
(Optional Configuration Block) supports the following:
id String
region String
(Optional String) The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
resourceName String
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
aws GetPrivateLinkAttachmentAw[]
(Optional Configuration Block) supports the following:
azures GetPrivateLinkAttachmentAzure[]
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
cloud string
(Optional String) The cloud service provider that hosts the resources to access with the Private Link Attachment.
displayName string
(Optional String) The name of the Private Link Attachment.
dnsDomain string
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
environment GetPrivateLinkAttachmentEnvironment
gcps GetPrivateLinkAttachmentGcp[]
(Optional Configuration Block) supports the following:
id string
region string
(Optional String) The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
resourceName string
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
aws Sequence[GetPrivateLinkAttachmentAw]
(Optional Configuration Block) supports the following:
azures Sequence[GetPrivateLinkAttachmentAzure]
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
cloud str
(Optional String) The cloud service provider that hosts the resources to access with the Private Link Attachment.
display_name str
(Optional String) The name of the Private Link Attachment.
dns_domain str
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
environment GetPrivateLinkAttachmentEnvironment
gcps Sequence[GetPrivateLinkAttachmentGcp]
(Optional Configuration Block) supports the following:
id str
region str
(Optional String) The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
resource_name str
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.
aws List<Property Map>
(Optional Configuration Block) supports the following:
azures List<Property Map>
(Optional Configuration Block) supports the following:

  • private_link_service_alias - (Required String) Azure Private Link service alias for the availability zone.
cloud String
(Optional String) The cloud service provider that hosts the resources to access with the Private Link Attachment.
displayName String
(Optional String) The name of the Private Link Attachment.
dnsDomain String
(Required String) The root DNS domain for the Private Link Attachment, for example, pr123a.us-east-2.aws.confluent.cloud.
environment Property Map
gcps List<Property Map>
(Optional Configuration Block) supports the following:
id String
region String
(Optional String) The cloud service provider region where the resources to be accessed using the Private Link Attachment are located.
resourceName String
(Required String) The Confluent Resource Name of the Private Link Attachment, for example crn://confluent.cloud/organization=1111aaaa-11aa-11aa-11aa-111111aaaaaa/environment=env-75gxp2/private-link-attachment=platt-1q0ky0.

Supporting Types

GetPrivateLinkAttachmentAw

VpcEndpointServiceName This property is required. string
(Required String) AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
VpcEndpointServiceName This property is required. string
(Required String) AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
vpcEndpointServiceName This property is required. String
(Required String) AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
vpcEndpointServiceName This property is required. string
(Required String) AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
vpc_endpoint_service_name This property is required. str
(Required String) AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.
vpcEndpointServiceName This property is required. String
(Required String) AWS VPC Endpoint Service that can be used to establish connections for all zones, for example com.amazonaws.vpce.us-west-2.vpce-svc-0d3be37e21708ecd3.

GetPrivateLinkAttachmentAzure

PrivateLinkServiceAlias This property is required. string
Azure PrivateLink service alias for the availability zone.
PrivateLinkServiceResourceId This property is required. string
(Required String) Azure Private Link service resource id for the availability zone.
PrivateLinkServiceAlias This property is required. string
Azure PrivateLink service alias for the availability zone.
PrivateLinkServiceResourceId This property is required. string
(Required String) Azure Private Link service resource id for the availability zone.
privateLinkServiceAlias This property is required. String
Azure PrivateLink service alias for the availability zone.
privateLinkServiceResourceId This property is required. String
(Required String) Azure Private Link service resource id for the availability zone.
privateLinkServiceAlias This property is required. string
Azure PrivateLink service alias for the availability zone.
privateLinkServiceResourceId This property is required. string
(Required String) Azure Private Link service resource id for the availability zone.
private_link_service_alias This property is required. str
Azure PrivateLink service alias for the availability zone.
private_link_service_resource_id This property is required. str
(Required String) Azure Private Link service resource id for the availability zone.
privateLinkServiceAlias This property is required. String
Azure PrivateLink service alias for the availability zone.
privateLinkServiceResourceId This property is required. String
(Required String) Azure Private Link service resource id for the availability zone.

GetPrivateLinkAttachmentEnvironment

Id This property is required. string
The ID of the Environment that the Private Link Attachment belongs to, for example env-xyz456.
Id This property is required. string
The ID of the Environment that the Private Link Attachment belongs to, for example env-xyz456.
id This property is required. String
The ID of the Environment that the Private Link Attachment belongs to, for example env-xyz456.
id This property is required. string
The ID of the Environment that the Private Link Attachment belongs to, for example env-xyz456.
id This property is required. str
The ID of the Environment that the Private Link Attachment belongs to, for example env-xyz456.
id This property is required. String
The ID of the Environment that the Private Link Attachment belongs to, for example env-xyz456.

GetPrivateLinkAttachmentGcp

PrivateServiceConnectServiceAttachment This property is required. string
Id of a Private Service Connect Service Attachment in Confluent Cloud.
PrivateServiceConnectServiceAttachment This property is required. string
Id of a Private Service Connect Service Attachment in Confluent Cloud.
privateServiceConnectServiceAttachment This property is required. String
Id of a Private Service Connect Service Attachment in Confluent Cloud.
privateServiceConnectServiceAttachment This property is required. string
Id of a Private Service Connect Service Attachment in Confluent Cloud.
private_service_connect_service_attachment This property is required. str
Id of a Private Service Connect Service Attachment in Confluent Cloud.
privateServiceConnectServiceAttachment This property is required. String
Id of a Private Service Connect Service Attachment in Confluent Cloud.

Package Details

Repository
Confluent Cloud pulumi/pulumi-confluentcloud
License
Apache-2.0
Notes
This Pulumi package is based on the confluent Terraform Provider.
Confluent v2.23.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-confluentcloud