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

GetPrivateEndpointInterfaceLink

mongodbatlas.PrivateEndpointInterfaceLink describe a Private Endpoint Link. This represents a Private Endpoint Link Connection that wants to retrieve details in an Atlas project.

!> WARNING: This datasource is deprecated and will be removed in the next major version Please transition to privatelink_endpoint_service as soon as possible. PrivateLink Endpoint Service

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 aws from "@pulumi/aws";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const testPrivateEndpoint = new mongodbatlas.PrivateEndpoint("test", {
    projectId: "<PROJECT_ID>",
    providerName: "AWS",
    region: "us-east-1",
});
const ptfeService = new aws.ec2.VpcEndpoint("ptfe_service", {
    securityGroupIds: ["sg-3f238186"],
    serviceName: testPrivateEndpoint.endpointServiceName,
    subnetIds: ["subnet-de0406d2"],
    vpcEndpointType: "Interface",
    vpcId: "vpc-7fc0a543",
});
const testMongodbatlasPrivateEndpointInterfaceLink = new mongodbatlas.PrivateEndpointInterfaceLink("test", {
    interfaceEndpointId: ptfeService.id,
    privateLinkId: testPrivateEndpoint.privateLinkId,
    projectId: testPrivateEndpoint.projectId,
});
const testPrivateEndpointInterfaceLink = pulumi.all([mongodbatlas_private_endpoint_link_test.interfaceEndpointId, mongodbatlas_private_endpoint_link_test.privateLinkId, mongodbatlas_private_endpoint_link_test.projectId]).apply(([interfaceEndpointId, privateLinkId, projectId]) => mongodbatlas.getPrivateEndpointInterfaceLink({
    interfaceEndpointId: interfaceEndpointId,
    privateLinkId: privateLinkId,
    projectId: projectId,
}, { async: true }));

Using GetPrivateEndpointInterfaceLink

function getPrivateEndpointInterfaceLink(args: GetPrivateEndpointInterfaceLinkArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointInterfaceLinkResult>
def get_private_endpoint_interface_link(interface_endpoint_id: Optional[str] = None, private_link_id: Optional[str] = None, project_id: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointInterfaceLinkResult
func LookupPrivateEndpointInterfaceLink(ctx *Context, args *LookupPrivateEndpointInterfaceLinkArgs, opts ...InvokeOption) (*LookupPrivateEndpointInterfaceLinkResult, error)

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

public static class GetPrivateEndpointInterfaceLink {
    public static Task<GetPrivateEndpointInterfaceLinkResult> InvokeAsync(GetPrivateEndpointInterfaceLinkArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

InterfaceEndpointId string
PrivateLinkId string

Unique identifier of the AWS PrivateLink connection.

ProjectId string

Unique identifier for the project.

InterfaceEndpointId string
PrivateLinkId string

Unique identifier of the AWS PrivateLink connection.

ProjectId string

Unique identifier for the project.

interfaceEndpointId string
privateLinkId string

Unique identifier of the AWS PrivateLink connection.

projectId string

Unique identifier for the project.

interface_endpoint_id str
private_link_id str

Unique identifier of the AWS PrivateLink connection.

project_id str

Unique identifier for the project.

GetPrivateEndpointInterfaceLink Result

The following output properties are available:

ConnectionStatus string

Status of the interface endpoint. Returns one of the following values:

DeleteRequested bool

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

ErrorMessage string

Error message pertaining to the interface endpoint. Returns null if there are no errors.

Id string

The provider-assigned unique ID for this managed resource.

InterfaceEndpointId string
PrivateLinkId string
ProjectId string
ConnectionStatus string

Status of the interface endpoint. Returns one of the following values:

DeleteRequested bool

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

ErrorMessage string

Error message pertaining to the interface endpoint. Returns null if there are no errors.

Id string

The provider-assigned unique ID for this managed resource.

InterfaceEndpointId string
PrivateLinkId string
ProjectId string
connectionStatus string

Status of the interface endpoint. Returns one of the following values:

deleteRequested boolean

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

errorMessage string

Error message pertaining to the interface endpoint. Returns null if there are no errors.

id string

The provider-assigned unique ID for this managed resource.

interfaceEndpointId string
privateLinkId string
projectId string
connection_status str

Status of the interface endpoint. Returns one of the following values:

delete_requested bool

Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.

error_message str

Error message pertaining to the interface endpoint. Returns null if there are no errors.

id str

The provider-assigned unique ID for this managed resource.

interface_endpoint_id str
private_link_id str
project_id str

Package Details

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