Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Confluent Provider
  3. API Docs
  4. getPrivateLinkAttachment
Confluent v2.10.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-confluentcloud

confluentcloud.getPrivateLinkAttachment

Explore with Pulumi AI

confluentcloud logo
Confluent v2.10.0 published on Wednesday, Nov 20, 2024 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;

    import pulumi
import pulumi_confluentcloud as confluentcloud

main = confluentcloud.get_private_link_attachment(id="platt-abcde",
    environment={
        "id": "env-1234",
    })
pulumi.export("platt", main)

    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
	})
}

    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,
    };
});

    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));
    }
}

    variables:
  main:
    fn::invoke:
      Function: confluentcloud:getPrivateLinkAttachment
      Arguments:
        id: platt-abcde
        environment:
          id: env-1234
outputs:
  platt: ${main}

    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>
    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]
    func LookupPrivateLinkAttachment(ctx *Context, args *LookupPrivateLinkAttachmentArgs, opts ...InvokeOption) (*LookupPrivateLinkAttachmentResult, error)
func LookupPrivateLinkAttachmentOutput(ctx *Context, args *LookupPrivateLinkAttachmentOutputArgs, opts ...InvokeOption) LookupPrivateLinkAttachmentResultOutput

    > 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)
}
    public static CompletableFuture<GetPrivateLinkAttachmentResult> getPrivateLinkAttachment(GetPrivateLinkAttachmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Environment Pulumi.ConfluentCloud.Inputs.GetPrivateLinkAttachmentEnvironment
    Id string
    The ID of the Private Link Attachment, for example, platt-61ovvd.
    Environment GetPrivateLinkAttachmentEnvironment
    Id string
    The ID of the Private Link Attachment, for example, platt-61ovvd.
    environment GetPrivateLinkAttachmentEnvironment
    id String
    The ID of the Private Link Attachment, for example, platt-61ovvd.
    environment GetPrivateLinkAttachmentEnvironment
    id string
    The ID of the Private Link Attachment, for example, platt-61ovvd.
    environment GetPrivateLinkAttachmentEnvironment
    id str
    The ID of the Private Link Attachment, for example, platt-61ovvd.
    environment Property Map
    id 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>
    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
    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>
    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[]
    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]
    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>
    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 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 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 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 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 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 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 string
    Azure PrivateLink service alias for the availability zone.
    PrivateLinkServiceResourceId string
    (Required String) Azure Private Link service resource id for the availability zone.
    PrivateLinkServiceAlias string
    Azure PrivateLink service alias for the availability zone.
    PrivateLinkServiceResourceId string
    (Required String) Azure Private Link service resource id for the availability zone.
    privateLinkServiceAlias String
    Azure PrivateLink service alias for the availability zone.
    privateLinkServiceResourceId String
    (Required String) Azure Private Link service resource id for the availability zone.
    privateLinkServiceAlias string
    Azure PrivateLink service alias for the availability zone.
    privateLinkServiceResourceId string
    (Required String) Azure Private Link service resource id for the availability zone.
    private_link_service_alias str
    Azure PrivateLink service alias for the availability zone.
    private_link_service_resource_id str
    (Required String) Azure Private Link service resource id for the availability zone.
    privateLinkServiceAlias String
    Azure PrivateLink service alias for the availability zone.
    privateLinkServiceResourceId String
    (Required String) Azure Private Link service resource id for the availability zone.

    GetPrivateLinkAttachmentEnvironment

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

    GetPrivateLinkAttachmentGcp

    PrivateServiceConnectServiceAttachment string
    Id of a Private Service Connect Service Attachment in Confluent Cloud.
    Zone string
    Zone associated with the PSC Service attachment.
    PrivateServiceConnectServiceAttachment string
    Id of a Private Service Connect Service Attachment in Confluent Cloud.
    Zone string
    Zone associated with the PSC Service attachment.
    privateServiceConnectServiceAttachment String
    Id of a Private Service Connect Service Attachment in Confluent Cloud.
    zone String
    Zone associated with the PSC Service attachment.
    privateServiceConnectServiceAttachment string
    Id of a Private Service Connect Service Attachment in Confluent Cloud.
    zone string
    Zone associated with the PSC Service attachment.
    private_service_connect_service_attachment str
    Id of a Private Service Connect Service Attachment in Confluent Cloud.
    zone str
    Zone associated with the PSC Service attachment.
    privateServiceConnectServiceAttachment String
    Id of a Private Service Connect Service Attachment in Confluent Cloud.
    zone String
    Zone associated with the PSC Service attachment.

    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.10.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-confluentcloud