1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getPrivateLinkEndpoint
Viewing docs for MongoDB Atlas v4.5.0
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

mongodbatlas.getPrivateLinkEndpoint

mongodbatlas logo
Viewing docs for MongoDB Atlas v4.5.0
published on Thursday, Mar 12, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

    mongodbatlas.PrivateLinkEndpoint describes a Private Endpoint. This represents a Private Endpoint Connection to retrieve details regarding a private endpoint by id in an Atlas project

    NOTE: Groups and projects are synonymous terms. The official documentation uses group_id.

    IMPORTANT: Before configuring a private endpoint for a new region in your cluster, review the Multi-Region Private Endpoints troubleshooting documentation.

    Example Usage

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

const thisPrivateLinkEndpoint = new mongodbatlas.PrivateLinkEndpoint("this", {
    projectId: projectId,
    providerName: "AWS",
    region: "US_EAST_1",
});
const _this = mongodbatlas.getPrivateLinkEndpointOutput({
    projectId: thisPrivateLinkEndpoint.projectId,
    privateLinkId: thisPrivateLinkEndpoint.privateLinkId,
    providerName: "AWS",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

this_private_link_endpoint = mongodbatlas.PrivateLinkEndpoint("this",
    project_id=project_id,
    provider_name="AWS",
    region="US_EAST_1")
this = mongodbatlas.get_private_link_endpoint_output(project_id=this_private_link_endpoint.project_id,
    private_link_id=this_private_link_endpoint.private_link_id,
    provider_name="AWS")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		thisPrivateLinkEndpoint, err := mongodbatlas.NewPrivateLinkEndpoint(ctx, "this", &mongodbatlas.PrivateLinkEndpointArgs{
			ProjectId:    pulumi.Any(projectId),
			ProviderName: pulumi.String("AWS"),
			Region:       pulumi.String("US_EAST_1"),
		})
		if err != nil {
			return err
		}
		_ = mongodbatlas.LookupPrivateLinkEndpointOutput(ctx, mongodbatlas.GetPrivateLinkEndpointOutputArgs{
			ProjectId:     thisPrivateLinkEndpoint.ProjectId,
			PrivateLinkId: thisPrivateLinkEndpoint.PrivateLinkId,
			ProviderName:  pulumi.String("AWS"),
		}, nil)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var thisPrivateLinkEndpoint = new Mongodbatlas.PrivateLinkEndpoint("this", new()
    {
        ProjectId = projectId,
        ProviderName = "AWS",
        Region = "US_EAST_1",
    });

    var @this = Mongodbatlas.GetPrivateLinkEndpoint.Invoke(new()
    {
        ProjectId = thisPrivateLinkEndpoint.ProjectId,
        PrivateLinkId = thisPrivateLinkEndpoint.PrivateLinkId,
        ProviderName = "AWS",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.PrivateLinkEndpoint;
import com.pulumi.mongodbatlas.PrivateLinkEndpointArgs;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.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) {
        var thisPrivateLinkEndpoint = new PrivateLinkEndpoint("thisPrivateLinkEndpoint", PrivateLinkEndpointArgs.builder()
            .projectId(projectId)
            .providerName("AWS")
            .region("US_EAST_1")
            .build());

        final var this = MongodbatlasFunctions.getPrivateLinkEndpoint(GetPrivateLinkEndpointArgs.builder()
            .projectId(thisPrivateLinkEndpoint.projectId())
            .privateLinkId(thisPrivateLinkEndpoint.privateLinkId())
            .providerName("AWS")
            .build());

    }
}

    resources:
  thisPrivateLinkEndpoint:
    type: mongodbatlas:PrivateLinkEndpoint
    name: this
    properties:
      projectId: ${projectId}
      providerName: AWS
      region: US_EAST_1
variables:
  this:
    fn::invoke:
      function: mongodbatlas:getPrivateLinkEndpoint
      arguments:
        projectId: ${thisPrivateLinkEndpoint.projectId}
        privateLinkId: ${thisPrivateLinkEndpoint.privateLinkId}
        providerName: AWS

    Further Examples

    • AWS PrivateLink Endpoint
    • Azure PrivateLink Endpoint
    • GCP Private Service Connect Endpoint (Port-Mapped Architecture)

    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>
    def get_private_link_endpoint(private_link_id: Optional[str] = None,
                              project_id: Optional[str] = None,
                              provider_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetPrivateLinkEndpointResult
def get_private_link_endpoint_output(private_link_id: Optional[pulumi.Input[str]] = None,
                              project_id: Optional[pulumi.Input[str]] = None,
                              provider_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetPrivateLinkEndpointResult]
    func LookupPrivateLinkEndpoint(ctx *Context, args *LookupPrivateLinkEndpointArgs, opts ...InvokeOption) (*LookupPrivateLinkEndpointResult, error)
func LookupPrivateLinkEndpointOutput(ctx *Context, args *LookupPrivateLinkEndpointOutputArgs, opts ...InvokeOption) LookupPrivateLinkEndpointResultOutput

    > Note: This function is named LookupPrivateLinkEndpoint 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)
}
    public static CompletableFuture<GetPrivateLinkEndpointResult> getPrivateLinkEndpoint(GetPrivateLinkEndpointArgs args, InvokeOptions options)
public static Output<GetPrivateLinkEndpointResult> getPrivateLinkEndpoint(GetPrivateLinkEndpointArgs args, InvokeOptions options)

    fn::invoke:
  function: mongodbatlas:index/getPrivateLinkEndpoint:getPrivateLinkEndpoint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PrivateLinkId string
    Unique identifier of the private endpoint that you want to retrieve.
    ProjectId string
    Unique identifier for the project.
    ProviderName string
    Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS, AZURE, or GCP.
    PrivateLinkId string
    Unique identifier of the private endpoint that you want to retrieve.
    ProjectId string
    Unique identifier for the project.
    ProviderName string
    Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS, AZURE, or GCP.
    privateLinkId String
    Unique identifier of the private endpoint that you want to retrieve.
    projectId String
    Unique identifier for the project.
    providerName String
    Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS, AZURE, or GCP.
    privateLinkId string
    Unique identifier of the private endpoint that you want to retrieve.
    projectId string
    Unique identifier for the project.
    providerName string
    Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS, AZURE, or GCP.
    private_link_id str
    Unique identifier of the private endpoint that you want to retrieve.
    project_id str
    Unique identifier for the project.
    provider_name str
    Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS, AZURE, or GCP.
    privateLinkId String
    Unique identifier of the private endpoint that you want to retrieve.
    projectId String
    Unique identifier for the project.
    providerName String
    Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS, AZURE, or GCP.

    getPrivateLinkEndpoint Result

    The following output properties are available:

    EndpointGroupNames List<string>
    List of private endpoint names associated with the private endpoint service for port-mapped architectures. For GCP legacy private endpoint architectures, this is a list of endpoint group names associated with the private endpoint service.
    EndpointServiceName string
    Name of the PrivateLink endpoint service in AWS. Returns null while Atlas creates the endpoint service.
    ErrorMessage string
    Error message for the private endpoint connection. Returns null if there are no errors.
    Id string
    The provider-assigned unique ID for this managed resource.
    InterfaceEndpoints List<string>
    Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
    PortMappingEnabled bool
    Flag that indicates whether this resource uses GCP port-mapping. When true, the resource uses port-mapped architecture. When false or unset, the resource uses GCP legacy private endpoint architecture. Only applicable for GCP provider.
    PrivateEndpoints List<string>
    All private endpoints that you have added to this Azure Private Link Service.
    PrivateLinkId string
    PrivateLinkServiceName string
    Name of the Azure Private Link Service that Atlas manages.
    PrivateLinkServiceResourceId string
    Resource ID of the Azure Private Link Service that Atlas manages.
    ProjectId string
    ProviderName string
    RegionName string
    Region for the Private Service Connect endpoint service.
    ServiceAttachmentNames List<string>
    List containing one service attachment connected to the private endpoint service for port-mapped architecture. For GCP legacy private endpoint architecture, this is a list of service attachments connected to the private endpoint service (one per Atlas node). Returns an empty list while Atlas creates the service attachments.
    Status string
    Status of the AWS PrivateLink connection. Returns one of the following values:

    • AVAILABLE - Atlas created the load balancer and the Private Link Service.
    • INITIATING - Atlas is creating the network load balancer and VPC endpoint service.
    • WAITING_FOR_USER - The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
    • FAILED - A system failure occurred.
    • DELETING - Atlas is deleting the Private Link service.
    EndpointGroupNames []string
    List of private endpoint names associated with the private endpoint service for port-mapped architectures. For GCP legacy private endpoint architectures, this is a list of endpoint group names associated with the private endpoint service.
    EndpointServiceName string
    Name of the PrivateLink endpoint service in AWS. Returns null while Atlas creates the endpoint service.
    ErrorMessage string
    Error message for the private endpoint connection. Returns null if there are no errors.
    Id string
    The provider-assigned unique ID for this managed resource.
    InterfaceEndpoints []string
    Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
    PortMappingEnabled bool
    Flag that indicates whether this resource uses GCP port-mapping. When true, the resource uses port-mapped architecture. When false or unset, the resource uses GCP legacy private endpoint architecture. Only applicable for GCP provider.
    PrivateEndpoints []string
    All private endpoints that you have added to this Azure Private Link Service.
    PrivateLinkId string
    PrivateLinkServiceName string
    Name of the Azure Private Link Service that Atlas manages.
    PrivateLinkServiceResourceId string
    Resource ID of the Azure Private Link Service that Atlas manages.
    ProjectId string
    ProviderName string
    RegionName string
    Region for the Private Service Connect endpoint service.
    ServiceAttachmentNames []string
    List containing one service attachment connected to the private endpoint service for port-mapped architecture. For GCP legacy private endpoint architecture, this is a list of service attachments connected to the private endpoint service (one per Atlas node). Returns an empty list while Atlas creates the service attachments.
    Status string
    Status of the AWS PrivateLink connection. Returns one of the following values:

    • AVAILABLE - Atlas created the load balancer and the Private Link Service.
    • INITIATING - Atlas is creating the network load balancer and VPC endpoint service.
    • WAITING_FOR_USER - The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
    • FAILED - A system failure occurred.
    • DELETING - Atlas is deleting the Private Link service.
    endpointGroupNames List<String>
    List of private endpoint names associated with the private endpoint service for port-mapped architectures. For GCP legacy private endpoint architectures, this is a list of endpoint group names associated with the private endpoint service.
    endpointServiceName String
    Name of the PrivateLink endpoint service in AWS. Returns null while Atlas creates the endpoint service.
    errorMessage String
    Error message for the private endpoint connection. Returns null if there are no errors.
    id String
    The provider-assigned unique ID for this managed resource.
    interfaceEndpoints List<String>
    Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
    portMappingEnabled Boolean
    Flag that indicates whether this resource uses GCP port-mapping. When true, the resource uses port-mapped architecture. When false or unset, the resource uses GCP legacy private endpoint architecture. Only applicable for GCP provider.
    privateEndpoints List<String>
    All private endpoints that you have added to this Azure Private Link Service.
    privateLinkId String
    privateLinkServiceName String
    Name of the Azure Private Link Service that Atlas manages.
    privateLinkServiceResourceId String
    Resource ID of the Azure Private Link Service that Atlas manages.
    projectId String
    providerName String
    regionName String
    Region for the Private Service Connect endpoint service.
    serviceAttachmentNames List<String>
    List containing one service attachment connected to the private endpoint service for port-mapped architecture. For GCP legacy private endpoint architecture, this is a list of service attachments connected to the private endpoint service (one per Atlas node). Returns an empty list while Atlas creates the service attachments.
    status String
    Status of the AWS PrivateLink connection. Returns one of the following values:

    • AVAILABLE - Atlas created the load balancer and the Private Link Service.
    • INITIATING - Atlas is creating the network load balancer and VPC endpoint service.
    • WAITING_FOR_USER - The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
    • FAILED - A system failure occurred.
    • DELETING - Atlas is deleting the Private Link service.
    endpointGroupNames string[]
    List of private endpoint names associated with the private endpoint service for port-mapped architectures. For GCP legacy private endpoint architectures, this is a list of endpoint group names associated with the private endpoint service.
    endpointServiceName string
    Name of the PrivateLink endpoint service in AWS. Returns null while Atlas creates the endpoint service.
    errorMessage string
    Error message for the private endpoint connection. Returns null if there are no errors.
    id string
    The provider-assigned unique ID for this managed resource.
    interfaceEndpoints string[]
    Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
    portMappingEnabled boolean
    Flag that indicates whether this resource uses GCP port-mapping. When true, the resource uses port-mapped architecture. When false or unset, the resource uses GCP legacy private endpoint architecture. Only applicable for GCP provider.
    privateEndpoints string[]
    All private endpoints that you have added to this Azure Private Link Service.
    privateLinkId string
    privateLinkServiceName string
    Name of the Azure Private Link Service that Atlas manages.
    privateLinkServiceResourceId string
    Resource ID of the Azure Private Link Service that Atlas manages.
    projectId string
    providerName string
    regionName string
    Region for the Private Service Connect endpoint service.
    serviceAttachmentNames string[]
    List containing one service attachment connected to the private endpoint service for port-mapped architecture. For GCP legacy private endpoint architecture, this is a list of service attachments connected to the private endpoint service (one per Atlas node). Returns an empty list while Atlas creates the service attachments.
    status string
    Status of the AWS PrivateLink connection. Returns one of the following values:

    • AVAILABLE - Atlas created the load balancer and the Private Link Service.
    • INITIATING - Atlas is creating the network load balancer and VPC endpoint service.
    • WAITING_FOR_USER - The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
    • FAILED - A system failure occurred.
    • DELETING - Atlas is deleting the Private Link service.
    endpoint_group_names Sequence[str]
    List of private endpoint names associated with the private endpoint service for port-mapped architectures. For GCP legacy private endpoint architectures, this is a list of endpoint group names associated with the private endpoint service.
    endpoint_service_name str
    Name of the PrivateLink endpoint service in AWS. Returns null while Atlas creates the endpoint service.
    error_message str
    Error message for the private endpoint connection. Returns null if there are no errors.
    id str
    The provider-assigned unique ID for this managed resource.
    interface_endpoints Sequence[str]
    Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
    port_mapping_enabled bool
    Flag that indicates whether this resource uses GCP port-mapping. When true, the resource uses port-mapped architecture. When false or unset, the resource uses GCP legacy private endpoint architecture. Only applicable for GCP provider.
    private_endpoints Sequence[str]
    All private endpoints that you have added to this Azure Private Link Service.
    private_link_id str
    private_link_service_name str
    Name of the Azure Private Link Service that Atlas manages.
    private_link_service_resource_id str
    Resource ID of the Azure Private Link Service that Atlas manages.
    project_id str
    provider_name str
    region_name str
    Region for the Private Service Connect endpoint service.
    service_attachment_names Sequence[str]
    List containing one service attachment connected to the private endpoint service for port-mapped architecture. For GCP legacy private endpoint architecture, this is a list of service attachments connected to the private endpoint service (one per Atlas node). Returns an empty list while Atlas creates the service attachments.
    status str
    Status of the AWS PrivateLink connection. Returns one of the following values:

    • AVAILABLE - Atlas created the load balancer and the Private Link Service.
    • INITIATING - Atlas is creating the network load balancer and VPC endpoint service.
    • WAITING_FOR_USER - The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
    • FAILED - A system failure occurred.
    • DELETING - Atlas is deleting the Private Link service.
    endpointGroupNames List<String>
    List of private endpoint names associated with the private endpoint service for port-mapped architectures. For GCP legacy private endpoint architectures, this is a list of endpoint group names associated with the private endpoint service.
    endpointServiceName String
    Name of the PrivateLink endpoint service in AWS. Returns null while Atlas creates the endpoint service.
    errorMessage String
    Error message for the private endpoint connection. Returns null if there are no errors.
    id String
    The provider-assigned unique ID for this managed resource.
    interfaceEndpoints List<String>
    Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
    portMappingEnabled Boolean
    Flag that indicates whether this resource uses GCP port-mapping. When true, the resource uses port-mapped architecture. When false or unset, the resource uses GCP legacy private endpoint architecture. Only applicable for GCP provider.
    privateEndpoints List<String>
    All private endpoints that you have added to this Azure Private Link Service.
    privateLinkId String
    privateLinkServiceName String
    Name of the Azure Private Link Service that Atlas manages.
    privateLinkServiceResourceId String
    Resource ID of the Azure Private Link Service that Atlas manages.
    projectId String
    providerName String
    regionName String
    Region for the Private Service Connect endpoint service.
    serviceAttachmentNames List<String>
    List containing one service attachment connected to the private endpoint service for port-mapped architecture. For GCP legacy private endpoint architecture, this is a list of service attachments connected to the private endpoint service (one per Atlas node). Returns an empty list while Atlas creates the service attachments.
    status String
    Status of the AWS PrivateLink connection. Returns one of the following values:

    • AVAILABLE - Atlas created the load balancer and the Private Link Service.
    • INITIATING - Atlas is creating the network load balancer and VPC endpoint service.
    • WAITING_FOR_USER - The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
    • FAILED - A system failure occurred.
    • DELETING - Atlas is deleting the Private Link service.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    Viewing docs for MongoDB Atlas v4.5.0
    published on Thursday, Mar 12, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-mongodbatlas
      Try Pulumi Cloud free. Your team will thank you.