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

mongodbatlas.getPrivateLinkEndpointService

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

    mongodbatlas.PrivateLinkEndpointService describes a Private Endpoint Link. This represents a Private Endpoint Link Connection that wants to retrieve details 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 _this = mongodbatlas.getPrivateLinkEndpointService({
    projectId: thisMongodbatlasPrivatelinkEndpointService.projectId,
    privateLinkId: thisMongodbatlasPrivatelinkEndpointService.privateLinkId,
    endpointServiceId: thisMongodbatlasPrivatelinkEndpointService.endpointServiceId,
    providerName: "AWS",
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

this = mongodbatlas.get_private_link_endpoint_service(project_id=this_mongodbatlas_privatelink_endpoint_service["projectId"],
    private_link_id=this_mongodbatlas_privatelink_endpoint_service["privateLinkId"],
    endpoint_service_id=this_mongodbatlas_privatelink_endpoint_service["endpointServiceId"],
    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 {
		_, err := mongodbatlas.LookupPrivateLinkEndpointService(ctx, &mongodbatlas.LookupPrivateLinkEndpointServiceArgs{
			ProjectId:         thisMongodbatlasPrivatelinkEndpointService.ProjectId,
			PrivateLinkId:     thisMongodbatlasPrivatelinkEndpointService.PrivateLinkId,
			EndpointServiceId: thisMongodbatlasPrivatelinkEndpointService.EndpointServiceId,
			ProviderName:      "AWS",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @this = Mongodbatlas.GetPrivateLinkEndpointService.Invoke(new()
    {
        ProjectId = thisMongodbatlasPrivatelinkEndpointService.ProjectId,
        PrivateLinkId = thisMongodbatlasPrivatelinkEndpointService.PrivateLinkId,
        EndpointServiceId = thisMongodbatlasPrivatelinkEndpointService.EndpointServiceId,
        ProviderName = "AWS",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetPrivateLinkEndpointServiceArgs;
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 this = MongodbatlasFunctions.getPrivateLinkEndpointService(GetPrivateLinkEndpointServiceArgs.builder()
            .projectId(thisMongodbatlasPrivatelinkEndpointService.projectId())
            .privateLinkId(thisMongodbatlasPrivatelinkEndpointService.privateLinkId())
            .endpointServiceId(thisMongodbatlasPrivatelinkEndpointService.endpointServiceId())
            .providerName("AWS")
            .build());

    }
}

    variables:
  this:
    fn::invoke:
      function: mongodbatlas:getPrivateLinkEndpointService
      arguments:
        projectId: ${thisMongodbatlasPrivatelinkEndpointService.projectId}
        privateLinkId: ${thisMongodbatlasPrivatelinkEndpointService.privateLinkId}
        endpointServiceId: ${thisMongodbatlasPrivatelinkEndpointService.endpointServiceId}
        providerName: AWS

    See mongodbatlas.PrivateLinkEndpointService resource for complete examples with each cloud provider.

    Available complete examples

    • Setup private connection to a MongoDB Atlas Cluster with AWS VPC
    • GCP Private Service Connect Endpoint and Service (Port-Mapped Architecture)

    Using getPrivateLinkEndpointService

    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 getPrivateLinkEndpointService(args: GetPrivateLinkEndpointServiceArgs, opts?: InvokeOptions): Promise<GetPrivateLinkEndpointServiceResult>
function getPrivateLinkEndpointServiceOutput(args: GetPrivateLinkEndpointServiceOutputArgs, opts?: InvokeOptions): Output<GetPrivateLinkEndpointServiceResult>
    def get_private_link_endpoint_service(endpoint_service_id: Optional[str] = None,
                                      private_link_id: Optional[str] = None,
                                      project_id: Optional[str] = None,
                                      provider_name: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetPrivateLinkEndpointServiceResult
def get_private_link_endpoint_service_output(endpoint_service_id: Optional[pulumi.Input[str]] = None,
                                      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[GetPrivateLinkEndpointServiceResult]
    func LookupPrivateLinkEndpointService(ctx *Context, args *LookupPrivateLinkEndpointServiceArgs, opts ...InvokeOption) (*LookupPrivateLinkEndpointServiceResult, error)
func LookupPrivateLinkEndpointServiceOutput(ctx *Context, args *LookupPrivateLinkEndpointServiceOutputArgs, opts ...InvokeOption) LookupPrivateLinkEndpointServiceResultOutput

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

    public static class GetPrivateLinkEndpointService 
{
    public static Task<GetPrivateLinkEndpointServiceResult> InvokeAsync(GetPrivateLinkEndpointServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateLinkEndpointServiceResult> Invoke(GetPrivateLinkEndpointServiceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPrivateLinkEndpointServiceResult> getPrivateLinkEndpointService(GetPrivateLinkEndpointServiceArgs args, InvokeOptions options)
public static Output<GetPrivateLinkEndpointServiceResult> getPrivateLinkEndpointService(GetPrivateLinkEndpointServiceArgs args, InvokeOptions options)

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

    The following arguments are supported:

    EndpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC. For AWS and AZURE, this is the interface endpoint identifier. For GCP port-mapped architecture, this is the forwarding rule name. For GCP legacy private endpoint architecture, this is the endpoint group name.
    PrivateLinkId string
    Unique identifier of the AWS, AZURE or GCP PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    ProjectId string
    Unique identifier for the project, also known as group_id in the official documentation.
    ProviderName string
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    EndpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC. For AWS and AZURE, this is the interface endpoint identifier. For GCP port-mapped architecture, this is the forwarding rule name. For GCP legacy private endpoint architecture, this is the endpoint group name.
    PrivateLinkId string
    Unique identifier of the AWS, AZURE or GCP PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    ProjectId string
    Unique identifier for the project, also known as group_id in the official documentation.
    ProviderName string
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    endpointServiceId String
    Unique identifier of the interface endpoint you created in your VPC. For AWS and AZURE, this is the interface endpoint identifier. For GCP port-mapped architecture, this is the forwarding rule name. For GCP legacy private endpoint architecture, this is the endpoint group name.
    privateLinkId String
    Unique identifier of the AWS, AZURE or GCP PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    projectId String
    Unique identifier for the project, also known as group_id in the official documentation.
    providerName String
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    endpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC. For AWS and AZURE, this is the interface endpoint identifier. For GCP port-mapped architecture, this is the forwarding rule name. For GCP legacy private endpoint architecture, this is the endpoint group name.
    privateLinkId string
    Unique identifier of the AWS, AZURE or GCP PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    projectId string
    Unique identifier for the project, also known as group_id in the official documentation.
    providerName string
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    endpoint_service_id str
    Unique identifier of the interface endpoint you created in your VPC. For AWS and AZURE, this is the interface endpoint identifier. For GCP port-mapped architecture, this is the forwarding rule name. For GCP legacy private endpoint architecture, this is the endpoint group name.
    private_link_id str
    Unique identifier of the AWS, AZURE or GCP PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    project_id str
    Unique identifier for the project, also known as group_id in the official documentation.
    provider_name str
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    endpointServiceId String
    Unique identifier of the interface endpoint you created in your VPC. For AWS and AZURE, this is the interface endpoint identifier. For GCP port-mapped architecture, this is the forwarding rule name. For GCP legacy private endpoint architecture, this is the endpoint group name.
    privateLinkId String
    Unique identifier of the AWS, AZURE or GCP PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    projectId String
    Unique identifier for the project, also known as group_id in the official documentation.
    providerName String
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.

    getPrivateLinkEndpointService Result

    The following output properties are available:

    AwsConnectionStatus string
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    AzureStatus string
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    DeleteRequested bool
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    EndpointServiceId string
    Endpoints List<GetPrivateLinkEndpointServiceEndpoint>
    Collection of individual private endpoints that comprise your network endpoint group. Only populated for GCP legacy private endpoint architecture.
    ErrorMessage string
    Error message pertaining to the interface endpoint. Returns null if there are no errors.
    GcpEndpointStatus string
    Status of the individual endpoint. Only populated for port-mapped architecture. Returns one of the following values: INITIATING, AVAILABLE, FAILED, DELETING.
    GcpProjectId string
    Unique identifier of the GCP project in which the endpoints were created. Only applicable for GCP provider.
    GcpStatus string
    Status of the interface endpoint. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    Id string
    The provider-assigned unique ID for this managed resource.
    InterfaceEndpointId string
    Unique identifier of the interface endpoint.
    PortMappingEnabled bool
    Flag that indicates whether the underlying privatelink_endpoint resource uses GCP port-mapping. This is a read-only attribute that reflects the architecture type. When true, the endpoint service uses the port-mapped architecture. When false, it uses the GCP legacy private endpoint architecture. Only applicable for GCP provider.
    PrivateEndpointConnectionName string
    Name of the connection for this private endpoint that Atlas generates.
    PrivateEndpointIpAddress string
    Private IP address of the private endpoint network interface. For port-mapped architecture, this is required and is the IP address of the forwarding rule. For GCP legacy private endpoint architecture, this is not used.
    PrivateEndpointResourceId string
    Unique identifier of the private endpoint.
    PrivateLinkId string
    ProjectId string
    ProviderName string
    AwsConnectionStatus string
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    AzureStatus string
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    DeleteRequested bool
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    EndpointServiceId string
    Endpoints []GetPrivateLinkEndpointServiceEndpoint
    Collection of individual private endpoints that comprise your network endpoint group. Only populated for GCP legacy private endpoint architecture.
    ErrorMessage string
    Error message pertaining to the interface endpoint. Returns null if there are no errors.
    GcpEndpointStatus string
    Status of the individual endpoint. Only populated for port-mapped architecture. Returns one of the following values: INITIATING, AVAILABLE, FAILED, DELETING.
    GcpProjectId string
    Unique identifier of the GCP project in which the endpoints were created. Only applicable for GCP provider.
    GcpStatus string
    Status of the interface endpoint. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    Id string
    The provider-assigned unique ID for this managed resource.
    InterfaceEndpointId string
    Unique identifier of the interface endpoint.
    PortMappingEnabled bool
    Flag that indicates whether the underlying privatelink_endpoint resource uses GCP port-mapping. This is a read-only attribute that reflects the architecture type. When true, the endpoint service uses the port-mapped architecture. When false, it uses the GCP legacy private endpoint architecture. Only applicable for GCP provider.
    PrivateEndpointConnectionName string
    Name of the connection for this private endpoint that Atlas generates.
    PrivateEndpointIpAddress string
    Private IP address of the private endpoint network interface. For port-mapped architecture, this is required and is the IP address of the forwarding rule. For GCP legacy private endpoint architecture, this is not used.
    PrivateEndpointResourceId string
    Unique identifier of the private endpoint.
    PrivateLinkId string
    ProjectId string
    ProviderName string
    awsConnectionStatus String
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    azureStatus String
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    deleteRequested Boolean
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    endpointServiceId String
    endpoints List<GetPrivateLinkEndpointServiceEndpoint>
    Collection of individual private endpoints that comprise your network endpoint group. Only populated for GCP legacy private endpoint architecture.
    errorMessage String
    Error message pertaining to the interface endpoint. Returns null if there are no errors.
    gcpEndpointStatus String
    Status of the individual endpoint. Only populated for port-mapped architecture. Returns one of the following values: INITIATING, AVAILABLE, FAILED, DELETING.
    gcpProjectId String
    Unique identifier of the GCP project in which the endpoints were created. Only applicable for GCP provider.
    gcpStatus String
    Status of the interface endpoint. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    id String
    The provider-assigned unique ID for this managed resource.
    interfaceEndpointId String
    Unique identifier of the interface endpoint.
    portMappingEnabled Boolean
    Flag that indicates whether the underlying privatelink_endpoint resource uses GCP port-mapping. This is a read-only attribute that reflects the architecture type. When true, the endpoint service uses the port-mapped architecture. When false, it uses the GCP legacy private endpoint architecture. Only applicable for GCP provider.
    privateEndpointConnectionName String
    Name of the connection for this private endpoint that Atlas generates.
    privateEndpointIpAddress String
    Private IP address of the private endpoint network interface. For port-mapped architecture, this is required and is the IP address of the forwarding rule. For GCP legacy private endpoint architecture, this is not used.
    privateEndpointResourceId String
    Unique identifier of the private endpoint.
    privateLinkId String
    projectId String
    providerName String
    awsConnectionStatus string
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    azureStatus string
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    deleteRequested boolean
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    endpointServiceId string
    endpoints GetPrivateLinkEndpointServiceEndpoint[]
    Collection of individual private endpoints that comprise your network endpoint group. Only populated for GCP legacy private endpoint architecture.
    errorMessage string
    Error message pertaining to the interface endpoint. Returns null if there are no errors.
    gcpEndpointStatus string
    Status of the individual endpoint. Only populated for port-mapped architecture. Returns one of the following values: INITIATING, AVAILABLE, FAILED, DELETING.
    gcpProjectId string
    Unique identifier of the GCP project in which the endpoints were created. Only applicable for GCP provider.
    gcpStatus string
    Status of the interface endpoint. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    id string
    The provider-assigned unique ID for this managed resource.
    interfaceEndpointId string
    Unique identifier of the interface endpoint.
    portMappingEnabled boolean
    Flag that indicates whether the underlying privatelink_endpoint resource uses GCP port-mapping. This is a read-only attribute that reflects the architecture type. When true, the endpoint service uses the port-mapped architecture. When false, it uses the GCP legacy private endpoint architecture. Only applicable for GCP provider.
    privateEndpointConnectionName string
    Name of the connection for this private endpoint that Atlas generates.
    privateEndpointIpAddress string
    Private IP address of the private endpoint network interface. For port-mapped architecture, this is required and is the IP address of the forwarding rule. For GCP legacy private endpoint architecture, this is not used.
    privateEndpointResourceId string
    Unique identifier of the private endpoint.
    privateLinkId string
    projectId string
    providerName string
    aws_connection_status str
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    azure_status str
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    delete_requested bool
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    endpoint_service_id str
    endpoints Sequence[GetPrivateLinkEndpointServiceEndpoint]
    Collection of individual private endpoints that comprise your network endpoint group. Only populated for GCP legacy private endpoint architecture.
    error_message str
    Error message pertaining to the interface endpoint. Returns null if there are no errors.
    gcp_endpoint_status str
    Status of the individual endpoint. Only populated for port-mapped architecture. Returns one of the following values: INITIATING, AVAILABLE, FAILED, DELETING.
    gcp_project_id str
    Unique identifier of the GCP project in which the endpoints were created. Only applicable for GCP provider.
    gcp_status str
    Status of the interface endpoint. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    id str
    The provider-assigned unique ID for this managed resource.
    interface_endpoint_id str
    Unique identifier of the interface endpoint.
    port_mapping_enabled bool
    Flag that indicates whether the underlying privatelink_endpoint resource uses GCP port-mapping. This is a read-only attribute that reflects the architecture type. When true, the endpoint service uses the port-mapped architecture. When false, it uses the GCP legacy private endpoint architecture. Only applicable for GCP provider.
    private_endpoint_connection_name str
    Name of the connection for this private endpoint that Atlas generates.
    private_endpoint_ip_address str
    Private IP address of the private endpoint network interface. For port-mapped architecture, this is required and is the IP address of the forwarding rule. For GCP legacy private endpoint architecture, this is not used.
    private_endpoint_resource_id str
    Unique identifier of the private endpoint.
    private_link_id str
    project_id str
    provider_name str
    awsConnectionStatus String
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    azureStatus String
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    deleteRequested Boolean
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    endpointServiceId String
    endpoints List<Property Map>
    Collection of individual private endpoints that comprise your network endpoint group. Only populated for GCP legacy private endpoint architecture.
    errorMessage String
    Error message pertaining to the interface endpoint. Returns null if there are no errors.
    gcpEndpointStatus String
    Status of the individual endpoint. Only populated for port-mapped architecture. Returns one of the following values: INITIATING, AVAILABLE, FAILED, DELETING.
    gcpProjectId String
    Unique identifier of the GCP project in which the endpoints were created. Only applicable for GCP provider.
    gcpStatus String
    Status of the interface endpoint. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    id String
    The provider-assigned unique ID for this managed resource.
    interfaceEndpointId String
    Unique identifier of the interface endpoint.
    portMappingEnabled Boolean
    Flag that indicates whether the underlying privatelink_endpoint resource uses GCP port-mapping. This is a read-only attribute that reflects the architecture type. When true, the endpoint service uses the port-mapped architecture. When false, it uses the GCP legacy private endpoint architecture. Only applicable for GCP provider.
    privateEndpointConnectionName String
    Name of the connection for this private endpoint that Atlas generates.
    privateEndpointIpAddress String
    Private IP address of the private endpoint network interface. For port-mapped architecture, this is required and is the IP address of the forwarding rule. For GCP legacy private endpoint architecture, this is not used.
    privateEndpointResourceId String
    Unique identifier of the private endpoint.
    privateLinkId String
    projectId String
    providerName String

    Supporting Types

    GetPrivateLinkEndpointServiceEndpoint

    EndpointName string
    Forwarding rule that corresponds to the endpoint you created.
    IpAddress string
    Private IP address of the network endpoint group you created.
    Status string
    Status of the endpoint. Atlas returns one of the values shown above.
    EndpointName string
    Forwarding rule that corresponds to the endpoint you created.
    IpAddress string
    Private IP address of the network endpoint group you created.
    Status string
    Status of the endpoint. Atlas returns one of the values shown above.
    endpointName String
    Forwarding rule that corresponds to the endpoint you created.
    ipAddress String
    Private IP address of the network endpoint group you created.
    status String
    Status of the endpoint. Atlas returns one of the values shown above.
    endpointName string
    Forwarding rule that corresponds to the endpoint you created.
    ipAddress string
    Private IP address of the network endpoint group you created.
    status string
    Status of the endpoint. Atlas returns one of the values shown above.
    endpoint_name str
    Forwarding rule that corresponds to the endpoint you created.
    ip_address str
    Private IP address of the network endpoint group you created.
    status str
    Status of the endpoint. Atlas returns one of the values shown above.
    endpointName String
    Forwarding rule that corresponds to the endpoint you created.
    ipAddress String
    Private IP address of the network endpoint group you created.
    status String
    Status of the endpoint. Atlas returns one of the values shown above.

    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.