Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

PrivateLinkEndpoint

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

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.PrivateLinkEndpoint("test", new Mongodbatlas.PrivateLinkEndpointArgs
        {
            ProjectId = "<PROJECT-ID>",
            ProviderName = "AWS/AZURE",
            Region = "us-east-1",
        });
    }

}
package main

import (
    "github.com/pulumi/pulumi-mongodbatlas/sdk/go/mongodbatlas"
    "github.com/pulumi/pulumi/sdk/v2/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
    })
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.PrivateLinkEndpoint("test",
    project_id="<PROJECT-ID>",
    provider_name="AWS/AZURE",
    region="us-east-1")
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",
});

Create a PrivateLinkEndpoint Resource

new PrivateLinkEndpoint(name: string, args: PrivateLinkEndpointArgs, opts?: CustomResourceOptions);
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)
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.
opts ResourceOptions
A bag of options that control this 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.

PrivateLinkEndpoint Resource Properties

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

Inputs

The PrivateLinkEndpoint 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: AWS regions and AZURE regions

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: AWS regions and AZURE regions

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: AWS regions and AZURE regions

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: AWS regions and AZURE regions

Outputs

All input properties are implicitly available as output properties. Additionally, the PrivateLinkEndpoint 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.

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.

PrivateLinkServiceResourceId string

Resource ID of the Azure Private Link Service that Atlas manages.

Status string

Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

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.

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.

PrivateLinkServiceResourceId string

Resource ID of the Azure Private Link Service that Atlas manages.

Status string

Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

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.

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.

privateLinkServiceResourceId string

Resource ID of the Azure Private Link Service that Atlas manages.

status string

Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

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_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.

private_link_service_resource_id str

Resource ID of the Azure Private Link Service that Atlas manages.

status str

Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

Look up an 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_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, 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)
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.

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.

PrivateLinkServiceResourceId string

Resource ID of the Azure Private Link Service that Atlas manages.

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: AWS regions and AZURE regions

Status string

Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

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.

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.

PrivateLinkServiceResourceId string

Resource ID of the Azure Private Link Service that Atlas manages.

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: AWS regions and AZURE regions

Status string

Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

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.

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.

privateLinkServiceResourceId string

Resource ID of the Azure Private Link Service that Atlas manages.

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: AWS regions and AZURE regions

status string

Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

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_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.

private_link_service_resource_id str

Resource ID of the Azure Private Link Service that Atlas manages.

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: AWS regions and AZURE regions

status str

Status of the AWS PrivateLink connection or Status of the Azure Private Link Service. Atlas returns one of the following values: AWS:

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

See detailed information for arguments and attributesMongoDB API Private Endpoint Service

Package Details

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