Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getPrivateLinkEndpoint
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getPrivateLinkEndpoint

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

# Data Source: mongodbatlas.PrivateLinkEndpoint

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. You may find group_id in the official documentation.

Example Usage

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

const testPrivateLinkEndpoint = new mongodbatlas.PrivateLinkEndpoint("test", {
    projectId: "<PROJECT-ID>",
    providerName: "AWS",
    region: "US_EAST_1",
});
const test = mongodbatlas.getPrivateLinkEndpointOutput({
    projectId: testPrivateLinkEndpoint.projectId,
    privateLinkId: testPrivateLinkEndpoint.privateLinkId,
    providerName: "AWS",
});
Copy
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_private_link_endpoint = mongodbatlas.PrivateLinkEndpoint("test",
    project_id="<PROJECT-ID>",
    provider_name="AWS",
    region="US_EAST_1")
test = mongodbatlas.get_private_link_endpoint_output(project_id=test_private_link_endpoint.project_id,
    private_link_id=test_private_link_endpoint.private_link_id,
    provider_name="AWS")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testPrivateLinkEndpoint, err := mongodbatlas.NewPrivateLinkEndpoint(ctx, "test", &mongodbatlas.PrivateLinkEndpointArgs{
			ProjectId:    pulumi.String("<PROJECT-ID>"),
			ProviderName: pulumi.String("AWS"),
			Region:       pulumi.String("US_EAST_1"),
		})
		if err != nil {
			return err
		}
		_ = mongodbatlas.LookupPrivateLinkEndpointOutput(ctx, mongodbatlas.GetPrivateLinkEndpointOutputArgs{
			ProjectId:     testPrivateLinkEndpoint.ProjectId,
			PrivateLinkId: testPrivateLinkEndpoint.PrivateLinkId,
			ProviderName:  pulumi.String("AWS"),
		}, nil)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var testPrivateLinkEndpoint = new Mongodbatlas.PrivateLinkEndpoint("test", new()
    {
        ProjectId = "<PROJECT-ID>",
        ProviderName = "AWS",
        Region = "US_EAST_1",
    });

    var test = Mongodbatlas.GetPrivateLinkEndpoint.Invoke(new()
    {
        ProjectId = testPrivateLinkEndpoint.ProjectId,
        PrivateLinkId = testPrivateLinkEndpoint.PrivateLinkId,
        ProviderName = "AWS",
    });

});
Copy
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 testPrivateLinkEndpoint = new PrivateLinkEndpoint("testPrivateLinkEndpoint", PrivateLinkEndpointArgs.builder()
            .projectId("<PROJECT-ID>")
            .providerName("AWS")
            .region("US_EAST_1")
            .build());

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

    }
}
Copy
resources:
  testPrivateLinkEndpoint:
    type: mongodbatlas:PrivateLinkEndpoint
    name: test
    properties:
      projectId: <PROJECT-ID>
      providerName: AWS
      region: US_EAST_1
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getPrivateLinkEndpoint
      arguments:
        projectId: ${testPrivateLinkEndpoint.projectId}
        privateLinkId: ${testPrivateLinkEndpoint.privateLinkId}
        providerName: AWS
Copy

Available complete examples

  • Setup private connection to a MongoDB Atlas Cluster with AWS VPC

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>
Copy
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]
Copy
func LookupPrivateLinkEndpoint(ctx *Context, args *LookupPrivateLinkEndpointArgs, opts ...InvokeOption) (*LookupPrivateLinkEndpointResult, error)
func LookupPrivateLinkEndpointOutput(ctx *Context, args *LookupPrivateLinkEndpointOutputArgs, opts ...InvokeOption) LookupPrivateLinkEndpointResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetPrivateLinkEndpointResult> getPrivateLinkEndpoint(GetPrivateLinkEndpointArgs args, InvokeOptions options)
public static Output<GetPrivateLinkEndpointResult> getPrivateLinkEndpoint(GetPrivateLinkEndpointArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getPrivateLinkEndpoint:getPrivateLinkEndpoint
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PrivateLinkId
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the private endpoint service that you want to retrieve.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier for the project.
ProviderName
This property is required.
Changes to this property will trigger replacement.
string
Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS, AZURE or GCP.
PrivateLinkId
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the private endpoint service that you want to retrieve.
ProjectId
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier for the project.
ProviderName
This property is required.
Changes to this property will trigger replacement.
string
Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS, AZURE or GCP.
privateLinkId
This property is required.
Changes to this property will trigger replacement.
String
Unique identifier of the private endpoint service that you want to retrieve.
projectId
This property is required.
Changes to this property will trigger replacement.
String
Unique identifier for the project.
providerName
This property is required.
Changes to this property will trigger replacement.
String
Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS, AZURE or GCP.
privateLinkId
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier of the private endpoint service that you want to retrieve.
projectId
This property is required.
Changes to this property will trigger replacement.
string
Unique identifier for the project.
providerName
This property is required.
Changes to this property will trigger replacement.
string
Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS, AZURE or GCP.
private_link_id
This property is required.
Changes to this property will trigger replacement.
str
Unique identifier of the private endpoint service that you want to retrieve.
project_id
This property is required.
Changes to this property will trigger replacement.
str
Unique identifier for the project.
provider_name
This property is required.
Changes to this property will trigger replacement.
str
Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS, AZURE or GCP.
privateLinkId
This property is required.
Changes to this property will trigger replacement.
String
Unique identifier of the private endpoint service that you want to retrieve.
projectId
This property is required.
Changes to this property will trigger replacement.
String
Unique identifier for the project.
providerName
This property is required.
Changes to this property will trigger replacement.
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>
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
EndpointServiceName string
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
ErrorMessage string
Error message pertaining to the AWS PrivateLink 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.
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
GCP region for the Private Service Connect endpoint service.
ServiceAttachmentNames List<string>
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service.
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 has occurred.
  • DELETING The Private Link service is being deleted.
EndpointGroupNames []string
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
EndpointServiceName string
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
ErrorMessage string
Error message pertaining to the AWS PrivateLink 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.
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
GCP region for the Private Service Connect endpoint service.
ServiceAttachmentNames []string
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service.
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 has occurred.
  • DELETING The Private Link service is being deleted.
endpointGroupNames List<String>
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName String
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage String
Error message pertaining to the AWS PrivateLink 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.
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
GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames List<String>
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service.
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 has occurred.
  • DELETING The Private Link service is being deleted.
endpointGroupNames string[]
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName string
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage string
Error message pertaining to the AWS PrivateLink 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.
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
GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames string[]
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service.
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 has occurred.
  • DELETING The Private Link service is being deleted.
endpoint_group_names Sequence[str]
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpoint_service_name str
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
error_message str
Error message pertaining to the AWS PrivateLink 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.
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
GCP region for the Private Service Connect endpoint service.
service_attachment_names Sequence[str]
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service.
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 has occurred.
  • DELETING The Private Link service is being deleted.
endpointGroupNames List<String>
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName String
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage String
Error message pertaining to the AWS PrivateLink 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.
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
GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames List<String>
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service.
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 has occurred.
  • DELETING The Private Link service is being deleted.

Package Details

Repository
MongoDB Atlas pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas