1. Docs
  2. Reference
  3. API
  4. mongodbatlas
  5. GetPrivateEndpoint

GetPrivateEndpoint

mongodbatlas..PrivateEndpoint describe a Private Endpoint. This represents a Private Endpoint Connection to retrieve details regarding a private endpoint by id in an Atlas project

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

Example Usage

Coming soon!

Coming soon!

Coming soon!

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

const testMongodbatlasPrivateEndpoint = new mongodbatlas.PrivateEndpoint("test", {
    projectId: "<PROJECT-ID>",
    providerName: "AWS",
    region: "us-east-1",
});
const testPrivateEndpoint = pulumi.all([testMongodbatlasPrivateEndpoint.privateLinkId, testMongodbatlasPrivateEndpoint.projectId]).apply(([privateLinkId, projectId]) => mongodbatlas.getPrivateEndpoint({
    privateLinkId: privateLinkId,
    projectId: projectId,
}, { async: true }));

Using GetPrivateEndpoint

function getPrivateEndpoint(args: GetPrivateEndpointArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointResult>
function  get_private_endpoint(private_link_id=None, project_id=None, opts=None)
func LookupPrivateEndpoint(ctx *Context, args *LookupPrivateEndpointArgs, opts ...InvokeOption) (*LookupPrivateEndpointResult, error)

Note: This function is named LookupPrivateEndpoint in the Go SDK.

public static class GetPrivateEndpoint {
    public static Task<GetPrivateEndpointResult> InvokeAsync(GetPrivateEndpointArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

PrivateLinkId string

Unique identifier of the AWS PrivateLink connection.

ProjectId string

Unique identifier for the project.

PrivateLinkId string

Unique identifier of the AWS PrivateLink connection.

ProjectId string

Unique identifier for the project.

privateLinkId string

Unique identifier of the AWS PrivateLink connection.

projectId string

Unique identifier for the project.

private_link_id str

Unique identifier of the AWS PrivateLink connection.

project_id str

Unique identifier for the project.

GetPrivateEndpoint Result

The following output properties are available:

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
ProjectId string
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
ProjectId string
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
projectId string
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 List[str]

Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.

private_link_id str
project_id str
status str

Status of the AWS PrivateLink connection. Returns one of the following values:

Package Details

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