PrivateEndpoint

mongodbatlas.PrivateEndpoint provides a Private Endpoint resource. This represents a Private Endpoint Connection that can be created in an Atlas project.

!> WARNING: This resource is deprecated and will be removed in the next major version Please transition to privatelink_endpoint as soon as possible. [PrivateLink Endpoints] (https://docs.atlas.mongodb.com/reference/api/private-endpoints/)

**IMPORTANT:**You must have one of the following roles to successfully handle the resource:

  • Organization Owner
  • Project Owner

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

NOTE: A network container is created for a private endpoint to reside in if one does not yet exist in the project.

Example Usage

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var test = new Mongodbatlas.PrivateEndpoint("test", new Mongodbatlas.PrivateEndpointArgs
        {
            ProjectId = "<PROJECT-ID>",
            ProviderName = "AWS",
            Region = "us-east-1",
        });
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.NewPrivateEndpoint(ctx, "test", &mongodbatlas.PrivateEndpointArgs{
			ProjectId:    pulumi.String("<PROJECT-ID>"),
			ProviderName: pulumi.String("AWS"),
			Region:       pulumi.String("us-east-1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.PrivateEndpoint("test",
    project_id="<PROJECT-ID>",
    provider_name="AWS",
    region="us-east-1")
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const test = new mongodbatlas.PrivateEndpoint("test", {
    projectId: "<PROJECT-ID>",
    providerName: "AWS",
    region: "us-east-1",
});

Create a PrivateEndpoint Resource

new PrivateEndpoint(name: string, args: PrivateEndpointArgs, opts?: CustomResourceOptions);
@overload
def PrivateEndpoint(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    project_id: Optional[str] = None,
                    provider_name: Optional[str] = None,
                    region: Optional[str] = None)
@overload
def PrivateEndpoint(resource_name: str,
                    args: PrivateEndpointArgs,
                    opts: Optional[ResourceOptions] = None)
func NewPrivateEndpoint(ctx *Context, name string, args PrivateEndpointArgs, opts ...ResourceOption) (*PrivateEndpoint, error)
public PrivateEndpoint(string name, PrivateEndpointArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args PrivateEndpointArgs
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 PrivateEndpointArgs
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 PrivateEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PrivateEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

PrivateEndpoint Resource Properties

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

Inputs

The PrivateEndpoint resource accepts the following input properties:

ProjectId string
Required Unique identifier for the project.
ProviderName string
Region string

Cloud provider region in which you want to create the private endpoint connection. Accepted values are:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • ca-central-1
  • sa-east-1
  • eu-north-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • me-south-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-east-1
ProjectId string
Required Unique identifier for the project.
ProviderName string
Region string

Cloud provider region in which you want to create the private endpoint connection. Accepted values are:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • ca-central-1
  • sa-east-1
  • eu-north-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • me-south-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-east-1
projectId string
Required Unique identifier for the project.
providerName string
region string

Cloud provider region in which you want to create the private endpoint connection. Accepted values are:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • ca-central-1
  • sa-east-1
  • eu-north-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • me-south-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-east-1
project_id str
Required Unique identifier for the project.
provider_name str
region str

Cloud provider region in which you want to create the private endpoint connection. Accepted values are:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • ca-central-1
  • sa-east-1
  • eu-north-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • me-south-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-east-1

Outputs

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

EndpointServiceName string
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
ErrorMessage string
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.
Id string
The provider-assigned unique ID for this managed resource.
InterfaceEndpoints List<string>
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
PrivateLinkId string
Unique identifier of the AWS PrivateLink connection.
Status string
Status of the AWS PrivateLink connection. Returns one of the following values:
EndpointServiceName string
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
ErrorMessage string
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.
Id string
The provider-assigned unique ID for this managed resource.
InterfaceEndpoints []string
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
PrivateLinkId string
Unique identifier of the AWS PrivateLink connection.
Status string
Status of the AWS PrivateLink connection. Returns one of the following values:
endpointServiceName string
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
errorMessage string
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.
id string
The provider-assigned unique ID for this managed resource.
interfaceEndpoints string[]
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
privateLinkId string
Unique identifier of the AWS PrivateLink connection.
status string
Status of the AWS PrivateLink connection. Returns one of the following values:
endpoint_service_name str
Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
error_message str
Error message pertaining to the AWS PrivateLink connection. Returns null if there are no errors.
id str
The provider-assigned unique ID for this managed resource.
interface_endpoints Sequence[str]
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
private_link_id str
Unique identifier of the AWS PrivateLink connection.
status str
Status of the AWS PrivateLink connection. Returns one of the following values:

Look up an Existing PrivateEndpoint Resource

Get an existing PrivateEndpoint 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?: PrivateEndpointState, opts?: CustomResourceOptions): PrivateEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        endpoint_service_name: Optional[str] = None,
        error_message: Optional[str] = None,
        interface_endpoints: Optional[Sequence[str]] = None,
        private_link_id: Optional[str] = None,
        project_id: Optional[str] = None,
        provider_name: Optional[str] = None,
        region: Optional[str] = None,
        status: Optional[str] = None) -> PrivateEndpoint
func GetPrivateEndpoint(ctx *Context, name string, id IDInput, state *PrivateEndpointState, opts ...ResourceOption) (*PrivateEndpoint, error)
public static PrivateEndpoint Get(string name, Input<string> id, PrivateEndpointState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

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.
InterfaceEndpoints List<string>
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
PrivateLinkId string
Unique identifier of the AWS PrivateLink connection.
ProjectId string
Required Unique identifier for the project.
ProviderName string
Region string

Cloud provider region in which you want to create the private endpoint connection. Accepted values are:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • ca-central-1
  • sa-east-1
  • eu-north-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • me-south-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-east-1
Status string
Status of the AWS PrivateLink connection. Returns one of the following values:
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.
InterfaceEndpoints []string
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
PrivateLinkId string
Unique identifier of the AWS PrivateLink connection.
ProjectId string
Required Unique identifier for the project.
ProviderName string
Region string

Cloud provider region in which you want to create the private endpoint connection. Accepted values are:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • ca-central-1
  • sa-east-1
  • eu-north-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • me-south-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-east-1
Status string
Status of the AWS PrivateLink connection. Returns one of the following values:
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.
interfaceEndpoints string[]
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
privateLinkId string
Unique identifier of the AWS PrivateLink connection.
projectId string
Required Unique identifier for the project.
providerName string
region string

Cloud provider region in which you want to create the private endpoint connection. Accepted values are:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • ca-central-1
  • sa-east-1
  • eu-north-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • me-south-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-east-1
status string
Status of the AWS PrivateLink connection. Returns one of the following values:
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.
interface_endpoints Sequence[str]
Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
private_link_id str
Unique identifier of the AWS PrivateLink connection.
project_id str
Required Unique identifier for the project.
provider_name str
region str

Cloud provider region in which you want to create the private endpoint connection. Accepted values are:

  • us-east-1
  • us-east-2
  • us-west-1
  • us-west-2
  • ca-central-1
  • sa-east-1
  • eu-north-1
  • eu-west-1
  • eu-west-2
  • eu-west-3
  • eu-central-1
  • me-south-1
  • ap-northeast-1
  • ap-northeast-2
  • ap-south-1
  • ap-southeast-1
  • ap-southeast-2
  • ap-east-1
status str
Status of the AWS PrivateLink connection. Returns one of the following values:

Import

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

 $ pulumi import mongodbatlas:index/privateEndpoint:PrivateEndpoint test 1112222b3bf99403840e8934-3242342343112-AWS-us-east-2

See detailed information for arguments and attributesMongoDB API Private Endpoint Connection

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.