MongoDB Atlas v3.33.0, Jun 12 25

MongoDB Atlas v3.33.0 published on Thursday, Jun 12, 2025 by Pulumi

mongodbatlas.getPrivateLinkEndpointService

Explore with Pulumi AI

MongoDB Atlas v3.33.0 published on Thursday, Jun 12, 2025 by Pulumi

# Data Source: mongodbatlas.PrivateLinkEndpointService

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 with AWS

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  testPrivateLinkEndpoint:
    type: mongodbatlas:PrivateLinkEndpoint
    name: test
    properties:
      projectId: <PROJECT_ID>
      providerName: AWS
      region: US_EAST_1
  ptfeService:
    type: aws:vpcEndpoint
    name: ptfe_service
    properties:
      vpcId: vpc-7fc0a543
      serviceName: ${testPrivateLinkEndpoint.endpointServiceName}
      vpcEndpointType: Interface
      subnetIds:
        - subnet-de0406d2
      securityGroupIds:
        - sg-3f238186
  testPrivateLinkEndpointService:
    type: mongodbatlas:PrivateLinkEndpointService
    name: test
    properties:
      projectId: ${testPrivateLinkEndpoint.projectId}
      privateLinkId: ${testPrivateLinkEndpoint.privateLinkId}
      endpointServiceId: ${ptfeService.id}
      providerName: AWS
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getPrivateLinkEndpointService
      arguments:
        projectId: ${testPrivateLinkEndpointService.projectId}
        privateLinkId: ${testPrivateLinkEndpointService.privateLinkId}
        interfaceEndpointId: ${testPrivateLinkEndpointService.interfaceEndpointId}

Example with Azure

Coming soon!

Coming soon!

Coming soon!

Coming soon!

Coming soon!

resources:
  testPrivateLinkEndpoint:
    type: mongodbatlas:PrivateLinkEndpoint
    name: test
    properties:
      projectId: ${projectId}
      providerName: AZURE
      region: eastus2
  testPrivateEndpoint:
    type: azurerm:privateEndpoint
    name: test
    properties:
      name: endpoint-test
      location: ${testAzurermResourceGroup.location}
      resourceGroupName: ${resourceGroupName}
      subnetId: ${testAzurermSubnet.id}
      privateServiceConnection:
        - name: ${testPrivateLinkEndpoint.privateLinkServiceName}
          privateConnectionResourceId: ${testPrivateLinkEndpoint.privateLinkServiceResourceId}
          isManualConnection: true
          requestMessage: Azure Private Link test
  testPrivateLinkEndpointService:
    type: mongodbatlas:PrivateLinkEndpointService
    name: test
    properties:
      projectId: ${testPrivateLinkEndpoint.projectId}
      privateLinkId: ${testPrivateLinkEndpoint.privateLinkId}
      endpointServiceId: ${testPrivateEndpoint.id}
      privateEndpointIpAddress: ${testPrivateEndpoint.privateServiceConnection[0].privateIpAddress}
      providerName: AZURE
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getPrivateLinkEndpointService
      arguments:
        projectId: ${testPrivateLinkEndpointService.projectId}
        privateLinkId: ${testPrivateLinkEndpointService.privateLinkId}
        interfaceEndpointId: ${testPrivateLinkEndpointService.interfaceEndpointId}

Available complete examples

Setup private connection to a MongoDB Atlas Cluster with AWS VPC

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 AWS or AZURE or GCP resource.
PrivateLinkId string: Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
ProjectId string: Unique identifier for the project.
ProviderName string: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS or AZURE or GCP.

EndpointServiceId string: Unique identifier of the AWS or AZURE or GCP resource.
PrivateLinkId string: Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
ProjectId string: Unique identifier for the project.
ProviderName string: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS or AZURE or GCP.

endpointServiceId String: Unique identifier of the AWS or AZURE or GCP resource.
privateLinkId String: Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
projectId String: Unique identifier for the project.
providerName String: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS or AZURE or GCP.

endpointServiceId string: Unique identifier of the AWS or AZURE or GCP resource.
privateLinkId string: Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
projectId string: Unique identifier for the project.
providerName string: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS or AZURE or GCP.

endpoint_service_id str: Unique identifier of the AWS or AZURE or GCP resource.
private_link_id str: Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
project_id str: Unique identifier for the project.
provider_name str: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS or AZURE or GCP.

endpointServiceId String: Unique identifier of the AWS or AZURE or GCP resource.
privateLinkId String: Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
projectId String: Unique identifier for the project.
providerName String: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS or 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.

ErrorMessage string

Error message pertaining to the interface endpoint. Returns null if there are no errors.

GcpStatus string

Status of the interface endpoint for GCP. 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.

PrivateEndpointConnectionName string

Name of the connection for this private endpoint that Atlas generates.

PrivateEndpointIpAddress string

Private IP address of the private endpoint network interface.

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.

ErrorMessage string

Error message pertaining to the interface endpoint. Returns null if there are no errors.

GcpStatus string

Status of the interface endpoint for GCP. 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.

PrivateEndpointConnectionName string

Name of the connection for this private endpoint that Atlas generates.

PrivateEndpointIpAddress string

Private IP address of the private endpoint network interface.

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.

errorMessage String

Error message pertaining to the interface endpoint. Returns null if there are no errors.

gcpStatus String

Status of the interface endpoint for GCP. 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.

privateEndpointConnectionName String

Name of the connection for this private endpoint that Atlas generates.

privateEndpointIpAddress String

Private IP address of the private endpoint network interface.

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.

errorMessage string

Error message pertaining to the interface endpoint. Returns null if there are no errors.

gcpStatus string

Status of the interface endpoint for GCP. 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.

privateEndpointConnectionName string

Name of the connection for this private endpoint that Atlas generates.

privateEndpointIpAddress string

Private IP address of the private endpoint network interface.

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.

error_message str

Error message pertaining to the interface endpoint. Returns null if there are no errors.

gcp_status str

Status of the interface endpoint for GCP. 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.

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.

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.

errorMessage String

Error message pertaining to the interface endpoint. Returns null if there are no errors.

gcpStatus String

Status of the interface endpoint for GCP. 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.

privateEndpointConnectionName String

Name of the connection for this private endpoint that Atlas generates.

privateEndpointIpAddress String

Private IP address of the private endpoint network interface.

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 in GCP.
IpAddress string: Private IP address of the network endpoint group you created in GCP.
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 in GCP.
IpAddress string: Private IP address of the network endpoint group you created in GCP.
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 in GCP.
ipAddress String: Private IP address of the network endpoint group you created in GCP.
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 in GCP.
ipAddress string: Private IP address of the network endpoint group you created in GCP.
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 in GCP.
ip_address str: Private IP address of the network endpoint group you created in GCP.
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 in GCP.
ipAddress String: Private IP address of the network endpoint group you created in GCP.
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.

MongoDB Atlas v3.33.0 published on Thursday, Jun 12, 2025 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.getPrivateLinkEndpointService

On this page

On this page

# Data Source: mongodbatlas.PrivateLinkEndpointService

Example with AWS

Example with Azure

Available complete examples

Using getPrivateLinkEndpointService

getPrivateLinkEndpointService Result

Supporting Types

GetPrivateLinkEndpointServiceEndpoint

Package Details

On this page

On this page