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

mongodbatlas.PrivateLinkEndpoint

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 provides a Private Endpoint resource. This represents a Private Endpoint Service that can be created in an Atlas project.

    IMPORTANT: This resource creates a Private Endpoint Service in MongoDB Atlas. The endpoint itself is created in your cloud provider using the information returned by this resource. The complementary resource mongodbatlas.PrivateLinkEndpointService is used to link your cloud provider’s endpoint to the Atlas service.

    The private link Terraform module makes use of this resource and simplifies its use.

    NOTE: You must have Organization Owner or Project Owner role. A network container is created for a private endpoint if one does not yet exist in the project. Before configuring a private endpoint for a new region, review the Multi-Region Private Endpoints troubleshooting documentation.

    IMPORTANT: For GCP, MongoDB encourages customers to use the port-mapped architecture by setting port_mapping_enabled </span>= true. This architecture uses a single set of resources to support up to 150 nodes. The legacy architecture requires dedicated resources for each Atlas node, which can lead to IP address exhaustion. For migration guidance, see the GCP Private Service Connect to Port-Mapped Architecture.

    Example Usage

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

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

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

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

    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.NewPrivateLinkEndpoint(ctx, "this", &mongodbatlas.PrivateLinkEndpointArgs{
			ProjectId:    pulumi.Any(projectId),
			ProviderName: pulumi.String("AWS"),
			Region:       pulumi.String("US_EAST_1"),
		})
		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 = new Mongodbatlas.PrivateLinkEndpoint("this", new()
    {
        ProjectId = projectId,
        ProviderName = "AWS",
        Region = "US_EAST_1",
    });

});

    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 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 this_ = new PrivateLinkEndpoint("this", PrivateLinkEndpointArgs.builder()
            .projectId(projectId)
            .providerName("AWS")
            .region("US_EAST_1")
            .build());

    }
}

    resources:
  this:
    type: mongodbatlas:PrivateLinkEndpoint
    properties:
      projectId: ${projectId}
      providerName: AWS
      region: US_EAST_1

    Further Examples

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

    Create PrivateLinkEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PrivateLinkEndpoint(name: string, args: PrivateLinkEndpointArgs, opts?: CustomResourceOptions);
    @overload
def PrivateLinkEndpoint(resource_name: str,
                        args: PrivateLinkEndpointArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def PrivateLinkEndpoint(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        project_id: Optional[str] = None,
                        provider_name: Optional[str] = None,
                        region: Optional[str] = None,
                        delete_on_create_timeout: Optional[bool] = None,
                        port_mapping_enabled: Optional[bool] = None)
    func NewPrivateLinkEndpoint(ctx *Context, name string, args PrivateLinkEndpointArgs, opts ...ResourceOption) (*PrivateLinkEndpoint, error)
    public PrivateLinkEndpoint(string name, PrivateLinkEndpointArgs args, CustomResourceOptions? opts = null)
    public PrivateLinkEndpoint(String name, PrivateLinkEndpointArgs args)
public PrivateLinkEndpoint(String name, PrivateLinkEndpointArgs args, CustomResourceOptions options)

    type: mongodbatlas:PrivateLinkEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PrivateLinkEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PrivateLinkEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PrivateLinkEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateLinkEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateLinkEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var privateLinkEndpointResource = new Mongodbatlas.PrivateLinkEndpoint("privateLinkEndpointResource", new()
{
    ProjectId = "string",
    ProviderName = "string",
    Region = "string",
    DeleteOnCreateTimeout = false,
    PortMappingEnabled = false,
});

    example, err := mongodbatlas.NewPrivateLinkEndpoint(ctx, "privateLinkEndpointResource", &mongodbatlas.PrivateLinkEndpointArgs{
	ProjectId:             pulumi.String("string"),
	ProviderName:          pulumi.String("string"),
	Region:                pulumi.String("string"),
	DeleteOnCreateTimeout: pulumi.Bool(false),
	PortMappingEnabled:    pulumi.Bool(false),
})

    var privateLinkEndpointResource = new PrivateLinkEndpoint("privateLinkEndpointResource", PrivateLinkEndpointArgs.builder()
    .projectId("string")
    .providerName("string")
    .region("string")
    .deleteOnCreateTimeout(false)
    .portMappingEnabled(false)
    .build());

    private_link_endpoint_resource = mongodbatlas.PrivateLinkEndpoint("privateLinkEndpointResource",
    project_id="string",
    provider_name="string",
    region="string",
    delete_on_create_timeout=False,
    port_mapping_enabled=False)

    const privateLinkEndpointResource = new mongodbatlas.PrivateLinkEndpoint("privateLinkEndpointResource", {
    projectId: "string",
    providerName: "string",
    region: "string",
    deleteOnCreateTimeout: false,
    portMappingEnabled: false,
});

    type: mongodbatlas:PrivateLinkEndpoint
properties:
    deleteOnCreateTimeout: false
    portMappingEnabled: false
    projectId: string
    providerName: string
    region: string

    PrivateLinkEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PrivateLinkEndpoint resource accepts the following input properties:

    ProjectId string
    Unique identifier for the project, also known as group_id in the official documentation.
    ProviderName string
    Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE, GCP.
    Region string
    Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    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.
    ProjectId string
    Unique identifier for the project, also known as group_id in the official documentation.
    ProviderName string
    Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE, GCP.
    Region string
    Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    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.
    projectId String
    Unique identifier for the project, also known as group_id in the official documentation.
    providerName String
    Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE, GCP.
    region String
    Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    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.
    projectId string
    Unique identifier for the project, also known as group_id in the official documentation.
    providerName string
    Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE, GCP.
    region string
    Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
    deleteOnCreateTimeout boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    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.
    project_id str
    Unique identifier for the project, also known as group_id in the official documentation.
    provider_name str
    Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE, GCP.
    region str
    Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
    delete_on_create_timeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    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.
    projectId String
    Unique identifier for the project, also known as group_id in the official documentation.
    providerName String
    Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE, GCP.
    region String
    Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PrivateLinkEndpoint resource produces the following output properties:

    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.
    PrivateEndpoints List<string>
    All private endpoints that you have added to this Azure Private Link Service.
    PrivateLinkId string
    Unique identifier of the private endpoint connection.
    PrivateLinkServiceName string
    Name of the Azure Private Link Service that Atlas manages.
    PrivateLinkServiceResourceId string
    Resource ID of the Azure Private Link Service.
    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
    values:

    • AVAILABLE - Atlas created the load balancer and the GCP Private Service Connect service.
    • INITIATING - Atlas is creating the load balancer and the GCP Private Service Connect service.
    • FAILED - Atlas failed to create the load balancer and the GCP Private Service Connect service.
    • DELETING - Atlas is deleting the GCP Private Service Connect 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.
    PrivateEndpoints []string
    All private endpoints that you have added to this Azure Private Link Service.
    PrivateLinkId string
    Unique identifier of the private endpoint connection.
    PrivateLinkServiceName string
    Name of the Azure Private Link Service that Atlas manages.
    PrivateLinkServiceResourceId string
    Resource ID of the Azure Private Link Service.
    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
    values:

    • AVAILABLE - Atlas created the load balancer and the GCP Private Service Connect service.
    • INITIATING - Atlas is creating the load balancer and the GCP Private Service Connect service.
    • FAILED - Atlas failed to create the load balancer and the GCP Private Service Connect service.
    • DELETING - Atlas is deleting the GCP Private Service Connect 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.
    privateEndpoints List<String>
    All private endpoints that you have added to this Azure Private Link Service.
    privateLinkId String
    Unique identifier of the private endpoint connection.
    privateLinkServiceName String
    Name of the Azure Private Link Service that Atlas manages.
    privateLinkServiceResourceId String
    Resource ID of the Azure Private Link Service.
    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
    values:

    • AVAILABLE - Atlas created the load balancer and the GCP Private Service Connect service.
    • INITIATING - Atlas is creating the load balancer and the GCP Private Service Connect service.
    • FAILED - Atlas failed to create the load balancer and the GCP Private Service Connect service.
    • DELETING - Atlas is deleting the GCP Private Service Connect 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.
    privateEndpoints string[]
    All private endpoints that you have added to this Azure Private Link Service.
    privateLinkId string
    Unique identifier of the private endpoint connection.
    privateLinkServiceName string
    Name of the Azure Private Link Service that Atlas manages.
    privateLinkServiceResourceId string
    Resource ID of the Azure Private Link Service.
    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
    values:

    • AVAILABLE - Atlas created the load balancer and the GCP Private Service Connect service.
    • INITIATING - Atlas is creating the load balancer and the GCP Private Service Connect service.
    • FAILED - Atlas failed to create the load balancer and the GCP Private Service Connect service.
    • DELETING - Atlas is deleting the GCP Private Service Connect 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.
    private_endpoints Sequence[str]
    All private endpoints that you have added to this Azure Private Link Service.
    private_link_id str
    Unique identifier of the private endpoint connection.
    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.
    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
    values:

    • AVAILABLE - Atlas created the load balancer and the GCP Private Service Connect service.
    • INITIATING - Atlas is creating the load balancer and the GCP Private Service Connect service.
    • FAILED - Atlas failed to create the load balancer and the GCP Private Service Connect service.
    • DELETING - Atlas is deleting the GCP Private Service Connect 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.
    privateEndpoints List<String>
    All private endpoints that you have added to this Azure Private Link Service.
    privateLinkId String
    Unique identifier of the private endpoint connection.
    privateLinkServiceName String
    Name of the Azure Private Link Service that Atlas manages.
    privateLinkServiceResourceId String
    Resource ID of the Azure Private Link Service.
    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
    values:

    • AVAILABLE - Atlas created the load balancer and the GCP Private Service Connect service.
    • INITIATING - Atlas is creating the load balancer and the GCP Private Service Connect service.
    • FAILED - Atlas failed to create the load balancer and the GCP Private Service Connect service.
    • DELETING - Atlas is deleting the GCP Private Service Connect service.

    Look up Existing PrivateLinkEndpoint Resource

    Get an existing PrivateLinkEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PrivateLinkEndpointState, opts?: CustomResourceOptions): PrivateLinkEndpoint
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        delete_on_create_timeout: Optional[bool] = None,
        endpoint_group_names: Optional[Sequence[str]] = None,
        endpoint_service_name: Optional[str] = None,
        error_message: Optional[str] = None,
        interface_endpoints: Optional[Sequence[str]] = None,
        port_mapping_enabled: Optional[bool] = None,
        private_endpoints: Optional[Sequence[str]] = None,
        private_link_id: Optional[str] = None,
        private_link_service_name: Optional[str] = None,
        private_link_service_resource_id: Optional[str] = None,
        project_id: Optional[str] = None,
        provider_name: Optional[str] = None,
        region: Optional[str] = None,
        region_name: Optional[str] = None,
        service_attachment_names: Optional[Sequence[str]] = None,
        status: Optional[str] = None) -> PrivateLinkEndpoint
    func GetPrivateLinkEndpoint(ctx *Context, name string, id IDInput, state *PrivateLinkEndpointState, opts ...ResourceOption) (*PrivateLinkEndpoint, error)
    public static PrivateLinkEndpoint Get(string name, Input<string> id, PrivateLinkEndpointState? state, CustomResourceOptions? opts = null)
    public static PrivateLinkEndpoint get(String name, Output<String> id, PrivateLinkEndpointState state, CustomResourceOptions options)
    resources:  _:    type: mongodbatlas:PrivateLinkEndpoint    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    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.
    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
    Unique identifier of the private endpoint connection.
    PrivateLinkServiceName string
    Name of the Azure Private Link Service that Atlas manages.
    PrivateLinkServiceResourceId string
    Resource ID of the Azure Private Link Service.
    ProjectId string
    Unique identifier for the project, also known as group_id in the official documentation.
    ProviderName string
    Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE, GCP.
    Region string
    Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
    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
    values:

    • AVAILABLE - Atlas created the load balancer and the GCP Private Service Connect service.
    • INITIATING - Atlas is creating the load balancer and the GCP Private Service Connect service.
    • FAILED - Atlas failed to create the load balancer and the GCP Private Service Connect service.
    • DELETING - Atlas is deleting the GCP Private Service Connect service.
    DeleteOnCreateTimeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    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.
    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
    Unique identifier of the private endpoint connection.
    PrivateLinkServiceName string
    Name of the Azure Private Link Service that Atlas manages.
    PrivateLinkServiceResourceId string
    Resource ID of the Azure Private Link Service.
    ProjectId string
    Unique identifier for the project, also known as group_id in the official documentation.
    ProviderName string
    Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE, GCP.
    Region string
    Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
    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
    values:

    • AVAILABLE - Atlas created the load balancer and the GCP Private Service Connect service.
    • INITIATING - Atlas is creating the load balancer and the GCP Private Service Connect service.
    • FAILED - Atlas failed to create the load balancer and the GCP Private Service Connect service.
    • DELETING - Atlas is deleting the GCP Private Service Connect service.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    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.
    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
    Unique identifier of the private endpoint connection.
    privateLinkServiceName String
    Name of the Azure Private Link Service that Atlas manages.
    privateLinkServiceResourceId String
    Resource ID of the Azure Private Link Service.
    projectId String
    Unique identifier for the project, also known as group_id in the official documentation.
    providerName String
    Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE, GCP.
    region String
    Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
    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
    values:

    • AVAILABLE - Atlas created the load balancer and the GCP Private Service Connect service.
    • INITIATING - Atlas is creating the load balancer and the GCP Private Service Connect service.
    • FAILED - Atlas failed to create the load balancer and the GCP Private Service Connect service.
    • DELETING - Atlas is deleting the GCP Private Service Connect service.
    deleteOnCreateTimeout boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    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.
    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
    Unique identifier of the private endpoint connection.
    privateLinkServiceName string
    Name of the Azure Private Link Service that Atlas manages.
    privateLinkServiceResourceId string
    Resource ID of the Azure Private Link Service.
    projectId string
    Unique identifier for the project, also known as group_id in the official documentation.
    providerName string
    Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE, GCP.
    region string
    Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
    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
    values:

    • AVAILABLE - Atlas created the load balancer and the GCP Private Service Connect service.
    • INITIATING - Atlas is creating the load balancer and the GCP Private Service Connect service.
    • FAILED - Atlas failed to create the load balancer and the GCP Private Service Connect service.
    • DELETING - Atlas is deleting the GCP Private Service Connect service.
    delete_on_create_timeout bool
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    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.
    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
    Unique identifier of the private endpoint connection.
    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.
    project_id str
    Unique identifier for the project, also known as group_id in the official documentation.
    provider_name str
    Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE, GCP.
    region str
    Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
    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
    values:

    • AVAILABLE - Atlas created the load balancer and the GCP Private Service Connect service.
    • INITIATING - Atlas is creating the load balancer and the GCP Private Service Connect service.
    • FAILED - Atlas failed to create the load balancer and the GCP Private Service Connect service.
    • DELETING - Atlas is deleting the GCP Private Service Connect service.
    deleteOnCreateTimeout Boolean
    Indicates whether to delete the resource being created if a timeout is reached when waiting for completion. When set to true and timeout occurs, it triggers the deletion and returns immediately without waiting for deletion to complete. When set to false, the timeout will not trigger resource deletion. If you suspect a transient error when the value is true, wait before retrying to allow resource deletion to finish. Default is true.
    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.
    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
    Unique identifier of the private endpoint connection.
    privateLinkServiceName String
    Name of the Azure Private Link Service that Atlas manages.
    privateLinkServiceResourceId String
    Resource ID of the Azure Private Link Service.
    projectId String
    Unique identifier for the project, also known as group_id in the official documentation.
    providerName String
    Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE, GCP.
    region String
    Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
    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
    values:

    • AVAILABLE - Atlas created the load balancer and the GCP Private Service Connect service.
    • INITIATING - Atlas is creating the load balancer and the GCP Private Service Connect service.
    • FAILED - Atlas failed to create the load balancer and the GCP Private Service Connect service.
    • DELETING - Atlas is deleting the GCP Private Service Connect service.

    Import

    Private Endpoint Service can be imported using project ID, private link ID, provider name and region, in the format {project_id}-{private_link_id}-{provider_name}-{region}, e.g.

    $ pulumi import mongodbatlas:index/privateLinkEndpoint:PrivateLinkEndpoint this 1112222b3bf99403840e8934-3242342343112-AWS-us-east-1

    For more information, see:

    To learn more about importing existing cloud resources, see Importing resources.

    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.