getPrivateLinkEndpointService

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

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

Example Usage

Coming soon!

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

const testPrivateLinkEndpoint = new mongodbatlas.PrivateLinkEndpoint("test", {
    projectId: "<PROJECT_ID>",
    providerName: "AWS",
    region: "us-east-1",
});
const ptfeService = new aws.ec2.VpcEndpoint("ptfe_service", {
    securityGroupIds: ["sg-3f238186"],
    serviceName: testPrivateLinkEndpoint.endpointServiceName,
    subnetIds: ["subnet-de0406d2"],
    vpcEndpointType: "Interface",
    vpcId: "vpc-7fc0a543",
});
const testMongodbatlasPrivateLinkEndpointService = new mongodbatlas.PrivateLinkEndpointService("test", {
    endpointServiceId: ptfeService.id,
    privateLinkId: testPrivateLinkEndpoint.privateLinkId,
    projectId: testPrivateLinkEndpoint.projectId,
    providerName: "AWS",
});
const testPrivateLinkEndpointService = pulumi.all([testMongodbatlasPrivateLinkEndpointService.interfaceEndpointId, testMongodbatlasPrivateLinkEndpointService.privateLinkId, testMongodbatlasPrivateLinkEndpointService.projectId]).apply(([interfaceEndpointId, privateLinkId, projectId]) => mongodbatlas.getPrivateLinkEndpointService({
    interfaceEndpointId: interfaceEndpointId,
    privateLinkId: privateLinkId,
    projectId: projectId,
}, { async: true }));

Using getPrivateLinkEndpointService

function getPrivateLinkEndpointService(args: GetPrivateLinkEndpointServiceArgs, opts?: InvokeOptions): Promise<GetPrivateLinkEndpointServiceResult>

def get_private_link_endpoint_service(endpoint_service_id: Optional[str] = None, private_link_id: Optional[str] = None, project_id: Optional[str] = None, provider_name: Optional[str] = None, opts: Optional[InvokeOptions] = None) -> GetPrivateLinkEndpointServiceResult

func LookupPrivateLinkEndpointService(ctx *Context, args *LookupPrivateLinkEndpointServiceArgs, opts ...InvokeOption) (*LookupPrivateLinkEndpointServiceResult, error)

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

public static class GetPrivateLinkEndpointService {
    public static Task<GetPrivateLinkEndpointServiceResult> InvokeAsync(GetPrivateLinkEndpointServiceArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

EndpointServiceId string: Unique identifier of the AWS or AZURE resource.
PrivateLinkId string: Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
ProjectId string: Unique identifier for the project.
ProviderName string: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS or AZURE.

EndpointServiceId string: Unique identifier of the AWS or AZURE resource.
PrivateLinkId string: Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
ProjectId string: Unique identifier for the project.
ProviderName string: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS or AZURE.

endpointServiceId string: Unique identifier of the AWS or AZURE resource.
privateLinkId string: Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
projectId string: Unique identifier for the project.
providerName string: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS or AZURE.

endpoint_service_id str: Unique identifier of the AWS or AZURE resource.
private_link_id str: Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
project_id str: Unique identifier for the project.
provider_name str: Cloud provider for which you want to create a private endpoint. Atlas accepts AWS or AZURE.

getPrivateLinkEndpointService Result

The following output properties are available:

AwsConnectionStatus string: Status of the interface endpoint for AWS. Returns one of the following values:
AzureStatus string: Status of the interface endpoint for AZURE. Returns one of the following values:
DeleteRequested bool: Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
EndpointServiceId string
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: Unique identifier of the interface endpoint.
PrivateEndpointConnectionName string: Name of the connection for this private endpoint that Atlas generates.
PrivateEndpointIpAddress string: Private IP address of the private endpoint network interface.
PrivateEndpointResourceId string: Unique identifier of the private endpoint.
PrivateLinkId string
ProjectId string
ProviderName string

AwsConnectionStatus string: Status of the interface endpoint for AWS. Returns one of the following values:
AzureStatus string: Status of the interface endpoint for AZURE. Returns one of the following values:
DeleteRequested bool: Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
EndpointServiceId string
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: Unique identifier of the interface endpoint.
PrivateEndpointConnectionName string: Name of the connection for this private endpoint that Atlas generates.
PrivateEndpointIpAddress string: Private IP address of the private endpoint network interface.
PrivateEndpointResourceId string: Unique identifier of the private endpoint.
PrivateLinkId string
ProjectId string
ProviderName string

awsConnectionStatus string: Status of the interface endpoint for AWS. Returns one of the following values:
azureStatus string: Status of the interface endpoint for AZURE. Returns one of the following values:
deleteRequested boolean: Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
endpointServiceId string
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: Unique identifier of the interface endpoint.
privateEndpointConnectionName string: Name of the connection for this private endpoint that Atlas generates.
privateEndpointIpAddress string: Private IP address of the private endpoint network interface.
privateEndpointResourceId string: Unique identifier of the private endpoint.
privateLinkId string
projectId string
providerName string

aws_connection_status str: Status of the interface endpoint for AWS. Returns one of the following values:
azure_status str: Status of the interface endpoint for AZURE. 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.
endpoint_service_id str
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: Unique identifier of the interface endpoint.
private_endpoint_connection_name str: Name of the connection for this private endpoint that Atlas generates.
private_endpoint_ip_address str: Private IP address of the private endpoint network interface.
private_endpoint_resource_id str: Unique identifier of the private endpoint.
private_link_id str
project_id str
provider_name 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.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

getPrivateLinkEndpointService

Example Usage

Using getPrivateLinkEndpointService

getPrivateLinkEndpointService Result

Package Details

On This Page