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

mongodbatlas.PrivateLinkEndpoint

Explore with Pulumi AI

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

Example Usage

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

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

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

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

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

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

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.PrivateLinkEndpoint;
import com.pulumi.mongodbatlas.PrivateLinkEndpointArgs;
import 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 test = new PrivateLinkEndpoint("test", PrivateLinkEndpointArgs.builder()
            .projectId("<PROJECT-ID>")
            .providerName("AWS/AZURE")
            .region("US_EAST_1")
            .build());

    }
}
Copy
resources:
  test:
    type: mongodbatlas:PrivateLinkEndpoint
    properties:
      projectId: <PROJECT-ID>
      providerName: AWS/AZURE
      region: US_EAST_1
Copy

Available complete examples

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

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)
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 This property is required. string
The unique name of the resource.
args This property is required. PrivateLinkEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. PrivateLinkEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PrivateLinkEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
});
Copy
example, err := mongodbatlas.NewPrivateLinkEndpoint(ctx, "privateLinkEndpointResource", &mongodbatlas.PrivateLinkEndpointArgs{
	ProjectId:    pulumi.String("string"),
	ProviderName: pulumi.String("string"),
	Region:       pulumi.String("string"),
})
Copy
var privateLinkEndpointResource = new PrivateLinkEndpoint("privateLinkEndpointResource", PrivateLinkEndpointArgs.builder()
    .projectId("string")
    .providerName("string")
    .region("string")
    .build());
Copy
private_link_endpoint_resource = mongodbatlas.PrivateLinkEndpoint("privateLinkEndpointResource",
    project_id="string",
    provider_name="string",
    region="string")
Copy
const privateLinkEndpointResource = new mongodbatlas.PrivateLinkEndpoint("privateLinkEndpointResource", {
    projectId: "string",
    providerName: "string",
    region: "string",
});
Copy
type: mongodbatlas:PrivateLinkEndpoint
properties:
    projectId: string
    providerName: string
    region: string
Copy

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
This property is required.
Changes to this property will trigger replacement.
string
Required Unique identifier for the project.
ProviderName
This property is required.
Changes to this property will trigger replacement.
string
Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
Region
This property is required.
Changes to this property will trigger replacement.
string
Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
ProjectId
This property is required.
Changes to this property will trigger replacement.
string
Required Unique identifier for the project.
ProviderName
This property is required.
Changes to this property will trigger replacement.
string
Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
Region
This property is required.
Changes to this property will trigger replacement.
string
Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
projectId
This property is required.
Changes to this property will trigger replacement.
String
Required Unique identifier for the project.
providerName
This property is required.
Changes to this property will trigger replacement.
String
Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region
This property is required.
Changes to this property will trigger replacement.
String
Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
projectId
This property is required.
Changes to this property will trigger replacement.
string
Required Unique identifier for the project.
providerName
This property is required.
Changes to this property will trigger replacement.
string
Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region
This property is required.
Changes to this property will trigger replacement.
string
Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
project_id
This property is required.
Changes to this property will trigger replacement.
str
Required Unique identifier for the project.
provider_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region
This property is required.
Changes to this property will trigger replacement.
str
Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions
projectId
This property is required.
Changes to this property will trigger replacement.
String
Required Unique identifier for the project.
providerName
This property is required.
Changes to this property will trigger replacement.
String
Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region
This property is required.
Changes to this property will trigger replacement.
String
Cloud provider region in which you want to create the private endpoint connection. Accepted values are: AWS regions, AZURE regions and GCP regions

Outputs

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

EndpointGroupNames List<string>
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
EndpointServiceName string
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
ErrorMessage string
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
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. AZURE:
PrivateEndpoints List<string>
All private endpoints that you have added to this Azure Private Link Service.
PrivateLinkId string
Unique identifier of the AWS PrivateLink connection.
PrivateLinkServiceName string
Name of the Azure Private Link Service that Atlas manages. GCP:
PrivateLinkServiceResourceId string
RegionName string
GCP region for the Private Service Connect endpoint service.
ServiceAttachmentNames List<string>
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
Status string
Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

  • AVAILABLE Atlas is creating the network load balancer and VPC endpoint service.
  • WAITING_FOR_USER The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
  • FAILED A system failure has occurred.
  • DELETING The AWS PrivateLink connection is being deleted. AZURE:
  • AVAILABLE Atlas created the load balancer and the Private Link Service.
  • INITIATING Atlas is creating the load balancer and the Private Link Service.
  • FAILED Atlas failed to create the load balancer and the Private Link service.
  • DELETING Atlas is deleting the Private Link service. GCP:
  • 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
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
EndpointServiceName string
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
ErrorMessage string
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
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. AZURE:
PrivateEndpoints []string
All private endpoints that you have added to this Azure Private Link Service.
PrivateLinkId string
Unique identifier of the AWS PrivateLink connection.
PrivateLinkServiceName string
Name of the Azure Private Link Service that Atlas manages. GCP:
PrivateLinkServiceResourceId string
RegionName string
GCP region for the Private Service Connect endpoint service.
ServiceAttachmentNames []string
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
Status string
Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

  • AVAILABLE Atlas is creating the network load balancer and VPC endpoint service.
  • WAITING_FOR_USER The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
  • FAILED A system failure has occurred.
  • DELETING The AWS PrivateLink connection is being deleted. AZURE:
  • AVAILABLE Atlas created the load balancer and the Private Link Service.
  • INITIATING Atlas is creating the load balancer and the Private Link Service.
  • FAILED Atlas failed to create the load balancer and the Private Link service.
  • DELETING Atlas is deleting the Private Link service. GCP:
  • 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>
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName String
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage String
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
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. AZURE:
privateEndpoints List<String>
All private endpoints that you have added to this Azure Private Link Service.
privateLinkId String
Unique identifier of the AWS PrivateLink connection.
privateLinkServiceName String
Name of the Azure Private Link Service that Atlas manages. GCP:
privateLinkServiceResourceId String
regionName String
GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames List<String>
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status String
Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

  • AVAILABLE Atlas is creating the network load balancer and VPC endpoint service.
  • WAITING_FOR_USER The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
  • FAILED A system failure has occurred.
  • DELETING The AWS PrivateLink connection is being deleted. AZURE:
  • AVAILABLE Atlas created the load balancer and the Private Link Service.
  • INITIATING Atlas is creating the load balancer and the Private Link Service.
  • FAILED Atlas failed to create the load balancer and the Private Link service.
  • DELETING Atlas is deleting the Private Link service. GCP:
  • 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[]
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName string
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage string
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
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. AZURE:
privateEndpoints string[]
All private endpoints that you have added to this Azure Private Link Service.
privateLinkId string
Unique identifier of the AWS PrivateLink connection.
privateLinkServiceName string
Name of the Azure Private Link Service that Atlas manages. GCP:
privateLinkServiceResourceId string
regionName string
GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames string[]
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status string
Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

  • AVAILABLE Atlas is creating the network load balancer and VPC endpoint service.
  • WAITING_FOR_USER The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
  • FAILED A system failure has occurred.
  • DELETING The AWS PrivateLink connection is being deleted. AZURE:
  • AVAILABLE Atlas created the load balancer and the Private Link Service.
  • INITIATING Atlas is creating the load balancer and the Private Link Service.
  • FAILED Atlas failed to create the load balancer and the Private Link service.
  • DELETING Atlas is deleting the Private Link service. GCP:
  • 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]
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpoint_service_name str
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
error_message str
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
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. AZURE:
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 AWS PrivateLink connection.
private_link_service_name str
Name of the Azure Private Link Service that Atlas manages. GCP:
private_link_service_resource_id str
region_name str
GCP region for the Private Service Connect endpoint service.
service_attachment_names Sequence[str]
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status str
Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

  • AVAILABLE Atlas is creating the network load balancer and VPC endpoint service.
  • WAITING_FOR_USER The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
  • FAILED A system failure has occurred.
  • DELETING The AWS PrivateLink connection is being deleted. AZURE:
  • AVAILABLE Atlas created the load balancer and the Private Link Service.
  • INITIATING Atlas is creating the load balancer and the Private Link Service.
  • FAILED Atlas failed to create the load balancer and the Private Link service.
  • DELETING Atlas is deleting the Private Link service. GCP:
  • 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>
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName String
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage String
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
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. AZURE:
privateEndpoints List<String>
All private endpoints that you have added to this Azure Private Link Service.
privateLinkId String
Unique identifier of the AWS PrivateLink connection.
privateLinkServiceName String
Name of the Azure Private Link Service that Atlas manages. GCP:
privateLinkServiceResourceId String
regionName String
GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames List<String>
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status String
Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

  • AVAILABLE Atlas is creating the network load balancer and VPC endpoint service.
  • WAITING_FOR_USER The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
  • FAILED A system failure has occurred.
  • DELETING The AWS PrivateLink connection is being deleted. AZURE:
  • AVAILABLE Atlas created the load balancer and the Private Link Service.
  • INITIATING Atlas is creating the load balancer and the Private Link Service.
  • FAILED Atlas failed to create the load balancer and the Private Link service.
  • DELETING Atlas is deleting the Private Link service. GCP:
  • 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,
        endpoint_group_names: Optional[Sequence[str]] = None,
        endpoint_service_name: Optional[str] = None,
        error_message: Optional[str] = None,
        interface_endpoints: Optional[Sequence[str]] = 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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
EndpointGroupNames List<string>
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
EndpointServiceName string
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
ErrorMessage string
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
InterfaceEndpoints List<string>
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
PrivateEndpoints List<string>
All private endpoints that you have added to this Azure Private Link Service.
PrivateLinkId string
Unique identifier of the AWS PrivateLink connection.
PrivateLinkServiceName string
Name of the Azure Private Link Service that Atlas manages. GCP:
PrivateLinkServiceResourceId string
ProjectId Changes to this property will trigger replacement. string
Required Unique identifier for the project.
ProviderName Changes to this property will trigger replacement. string
Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
Region Changes to this property will trigger replacement. 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
GCP region for the Private Service Connect endpoint service.
ServiceAttachmentNames List<string>
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
Status string
Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

  • AVAILABLE Atlas is creating the network load balancer and VPC endpoint service.
  • WAITING_FOR_USER The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
  • FAILED A system failure has occurred.
  • DELETING The AWS PrivateLink connection is being deleted. AZURE:
  • AVAILABLE Atlas created the load balancer and the Private Link Service.
  • INITIATING Atlas is creating the load balancer and the Private Link Service.
  • FAILED Atlas failed to create the load balancer and the Private Link service.
  • DELETING Atlas is deleting the Private Link service. GCP:
  • 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
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
EndpointServiceName string
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
ErrorMessage string
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
InterfaceEndpoints []string
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
PrivateEndpoints []string
All private endpoints that you have added to this Azure Private Link Service.
PrivateLinkId string
Unique identifier of the AWS PrivateLink connection.
PrivateLinkServiceName string
Name of the Azure Private Link Service that Atlas manages. GCP:
PrivateLinkServiceResourceId string
ProjectId Changes to this property will trigger replacement. string
Required Unique identifier for the project.
ProviderName Changes to this property will trigger replacement. string
Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
Region Changes to this property will trigger replacement. 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
GCP region for the Private Service Connect endpoint service.
ServiceAttachmentNames []string
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
Status string
Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

  • AVAILABLE Atlas is creating the network load balancer and VPC endpoint service.
  • WAITING_FOR_USER The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
  • FAILED A system failure has occurred.
  • DELETING The AWS PrivateLink connection is being deleted. AZURE:
  • AVAILABLE Atlas created the load balancer and the Private Link Service.
  • INITIATING Atlas is creating the load balancer and the Private Link Service.
  • FAILED Atlas failed to create the load balancer and the Private Link service.
  • DELETING Atlas is deleting the Private Link service. GCP:
  • 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>
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName String
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage String
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
interfaceEndpoints List<String>
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
privateEndpoints List<String>
All private endpoints that you have added to this Azure Private Link Service.
privateLinkId String
Unique identifier of the AWS PrivateLink connection.
privateLinkServiceName String
Name of the Azure Private Link Service that Atlas manages. GCP:
privateLinkServiceResourceId String
projectId Changes to this property will trigger replacement. String
Required Unique identifier for the project.
providerName Changes to this property will trigger replacement. String
Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region Changes to this property will trigger replacement. 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
GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames List<String>
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status String
Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

  • AVAILABLE Atlas is creating the network load balancer and VPC endpoint service.
  • WAITING_FOR_USER The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
  • FAILED A system failure has occurred.
  • DELETING The AWS PrivateLink connection is being deleted. AZURE:
  • AVAILABLE Atlas created the load balancer and the Private Link Service.
  • INITIATING Atlas is creating the load balancer and the Private Link Service.
  • FAILED Atlas failed to create the load balancer and the Private Link service.
  • DELETING Atlas is deleting the Private Link service. GCP:
  • 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[]
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName string
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage string
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
interfaceEndpoints string[]
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
privateEndpoints string[]
All private endpoints that you have added to this Azure Private Link Service.
privateLinkId string
Unique identifier of the AWS PrivateLink connection.
privateLinkServiceName string
Name of the Azure Private Link Service that Atlas manages. GCP:
privateLinkServiceResourceId string
projectId Changes to this property will trigger replacement. string
Required Unique identifier for the project.
providerName Changes to this property will trigger replacement. string
Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region Changes to this property will trigger replacement. 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
GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames string[]
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status string
Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

  • AVAILABLE Atlas is creating the network load balancer and VPC endpoint service.
  • WAITING_FOR_USER The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
  • FAILED A system failure has occurred.
  • DELETING The AWS PrivateLink connection is being deleted. AZURE:
  • AVAILABLE Atlas created the load balancer and the Private Link Service.
  • INITIATING Atlas is creating the load balancer and the Private Link Service.
  • FAILED Atlas failed to create the load balancer and the Private Link service.
  • DELETING Atlas is deleting the Private Link service. GCP:
  • 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]
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpoint_service_name str
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
error_message str
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
interface_endpoints Sequence[str]
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
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 AWS PrivateLink connection.
private_link_service_name str
Name of the Azure Private Link Service that Atlas manages. GCP:
private_link_service_resource_id str
project_id Changes to this property will trigger replacement. str
Required Unique identifier for the project.
provider_name Changes to this property will trigger replacement. str
Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region Changes to this property will trigger replacement. 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
GCP region for the Private Service Connect endpoint service.
service_attachment_names Sequence[str]
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status str
Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

  • AVAILABLE Atlas is creating the network load balancer and VPC endpoint service.
  • WAITING_FOR_USER The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
  • FAILED A system failure has occurred.
  • DELETING The AWS PrivateLink connection is being deleted. AZURE:
  • AVAILABLE Atlas created the load balancer and the Private Link Service.
  • INITIATING Atlas is creating the load balancer and the Private Link Service.
  • FAILED Atlas failed to create the load balancer and the Private Link service.
  • DELETING Atlas is deleting the Private Link service. GCP:
  • 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>
GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
endpointServiceName String
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage String
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors. AWS:
interfaceEndpoints List<String>
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection. AZURE:
privateEndpoints List<String>
All private endpoints that you have added to this Azure Private Link Service.
privateLinkId String
Unique identifier of the AWS PrivateLink connection.
privateLinkServiceName String
Name of the Azure Private Link Service that Atlas manages. GCP:
privateLinkServiceResourceId String
projectId Changes to this property will trigger replacement. String
Required Unique identifier for the project.
providerName Changes to this property will trigger replacement. String
Name of the cloud provider for which you want to create the private endpoint service. Atlas accepts AWS, AZURE or GCP.
region Changes to this property will trigger replacement. 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
GCP region for the Private Service Connect endpoint service.
serviceAttachmentNames List<String>
Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service. Returns an empty list while Atlas creates the service attachments.
status String
Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

  • AVAILABLE Atlas is creating the network load balancer and VPC endpoint service.
  • WAITING_FOR_USER The Atlas network load balancer and VPC endpoint service are created and ready to receive connection requests. When you receive this status, create an interface endpoint to continue configuring the AWS PrivateLink connection.
  • FAILED A system failure has occurred.
  • DELETING The AWS PrivateLink connection is being deleted. AZURE:
  • AVAILABLE Atlas created the load balancer and the Private Link Service.
  • INITIATING Atlas is creating the load balancer and the Private Link Service.
  • FAILED Atlas failed to create the load balancer and the Private Link service.
  • DELETING Atlas is deleting the Private Link service. GCP:
  • 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 test 1112222b3bf99403840e8934-3242342343112-AWS-us-east-1
Copy

See detailed information for arguments and attributes: MongoDB API Private Endpoint Service

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.
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas