Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now
  1. Docs
  2. Reference
  3. API
  4. MongoDB Atlas
  5. getPrivateLinkEndpoint

getPrivateLinkEndpoint

mongodbatlas.PrivateLinkEndpoint 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 testMongodbatlasPrivateLinkEndpoint = new mongodbatlas.PrivateLinkEndpoint("test", {
    projectId: "<PROJECT-ID>",
    providerName: "AWS",
    region: "us-east-1",
});
const testPrivateLinkEndpoint = pulumi.all([testMongodbatlasPrivateLinkEndpoint.privateLinkId, testMongodbatlasPrivateLinkEndpoint.projectId]).apply(([privateLinkId, projectId]) => mongodbatlas.getPrivateLinkEndpoint({
    privateLinkId: privateLinkId,
    projectId: projectId,
    providerName: "AWS",
}, { async: true }));

Using getPrivateLinkEndpoint

function getPrivateLinkEndpoint(args: GetPrivateLinkEndpointArgs, opts?: InvokeOptions): Promise<GetPrivateLinkEndpointResult>
def get_private_link_endpoint(private_link_id: Optional[str] = None, project_id: Optional[str] = None, provider_name: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetPrivateLinkEndpointResult
func LookupPrivateLinkEndpoint(ctx *Context, args *LookupPrivateLinkEndpointArgs, opts ...InvokeOption) (*LookupPrivateLinkEndpointResult, error)

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

public static class GetPrivateLinkEndpoint {
    public static Task<GetPrivateLinkEndpointResult> InvokeAsync(GetPrivateLinkEndpointArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

PrivateLinkId string

Unique identifier of the private endpoint service that you want to retrieve.

ProjectId string

Unique identifier for the project.

ProviderName string

Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS or AZURE.

PrivateLinkId string

Unique identifier of the private endpoint service that you want to retrieve.

ProjectId string

Unique identifier for the project.

ProviderName string

Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS or AZURE.

privateLinkId string

Unique identifier of the private endpoint service that you want to retrieve.

projectId string

Unique identifier for the project.

providerName string

Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS or AZURE.

private_link_id str

Unique identifier of the private endpoint service that you want to retrieve.

project_id str

Unique identifier for the project.

provider_name str

Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts AWS or AZURE.

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

PrivateEndpoints List<string>

All private endpoints that you have added to this Azure Private Link Service.

PrivateLinkId string
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. Returns one of the following values:

ProjectId string
ProviderName string
Status string

Status of the AWS PrivateLink connection.

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
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. Returns one of the following values:

ProjectId string
ProviderName string
Status string

Status of the AWS PrivateLink connection.

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
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. Returns one of the following values:

projectId string
providerName string
status string

Status of the AWS PrivateLink connection.

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
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. Returns one of the following values:

project_id str
provider_name str
status str

Status of the AWS PrivateLink 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.