MongoDB Atlas

Pulumi Official
Package maintained by Pulumi
v3.5.0 published on Wednesday, Jul 20, 2022 by Pulumi

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.

Using getPrivateLinkEndpoint

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getPrivateLinkEndpoint(args: GetPrivateLinkEndpointArgs, opts?: InvokeOptions): Promise<GetPrivateLinkEndpointResult>
function getPrivateLinkEndpointOutput(args: GetPrivateLinkEndpointOutputArgs, opts?: InvokeOptions): Output<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
def get_private_link_endpoint_output(private_link_id: Optional[pulumi.Input[str]] = None,
                              project_id: Optional[pulumi.Input[str]] = None,
                              provider_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetPrivateLinkEndpointResult]
func LookupPrivateLinkEndpoint(ctx *Context, args *LookupPrivateLinkEndpointArgs, opts ...InvokeOption) (*LookupPrivateLinkEndpointResult, error)
func LookupPrivateLinkEndpointOutput(ctx *Context, args *LookupPrivateLinkEndpointOutputArgs, opts ...InvokeOption) LookupPrivateLinkEndpointResultOutput

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

public static class GetPrivateLinkEndpoint 
{
    public static Task<GetPrivateLinkEndpointResult> InvokeAsync(GetPrivateLinkEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateLinkEndpointResult> Invoke(GetPrivateLinkEndpointInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPrivateLinkEndpointResult> getPrivateLinkEndpoint(GetPrivateLinkEndpointArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: mongodbatlas:index/getPrivateLinkEndpoint:getPrivateLinkEndpoint
  Arguments:
    # Arguments dictionary

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, AZURE or GCP.

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, AZURE or GCP.

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, AZURE or GCP.

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, AZURE or GCP.

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, AZURE or GCP.

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, AZURE or GCP.

getPrivateLinkEndpoint Result

The following output properties are available:

EndpointGroupNames List<string>

GCP network endpoint groups corresponding to the Private Service Connect endpoint service.

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.

ProjectId string
ProviderName string
RegionName string

GCP region for the Private Service Connect endpoint service.

ServiceAttachmentNames List<string>

Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service.

Status string

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

EndpointGroupNames []string

GCP network endpoint groups corresponding to the Private Service Connect endpoint service.

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.

ProjectId string
ProviderName string
RegionName string

GCP region for the Private Service Connect endpoint service.

ServiceAttachmentNames []string

Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service.

Status string

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

endpointGroupNames List<String>

GCP network endpoint groups corresponding to the Private Service Connect endpoint service.

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.

projectId String
providerName String
regionName String

GCP region for the Private Service Connect endpoint service.

serviceAttachmentNames List<String>

Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service.

status String

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

endpointGroupNames string[]

GCP network endpoint groups corresponding to the Private Service Connect endpoint service.

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.

projectId string
providerName string
regionName string

GCP region for the Private Service Connect endpoint service.

serviceAttachmentNames string[]

Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service.

status string

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

endpoint_group_names Sequence[str]

GCP network endpoint groups corresponding to the Private Service Connect endpoint service.

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.

project_id str
provider_name str
region_name str

GCP region for the Private Service Connect endpoint service.

service_attachment_names Sequence[str]

Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service.

status str

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

endpointGroupNames List<String>

GCP network endpoint groups corresponding to the Private Service Connect endpoint service.

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.

projectId String
providerName String
regionName String

GCP region for the Private Service Connect endpoint service.

serviceAttachmentNames List<String>

Unique alphanumeric and special character strings that identify the service attachments associated with the GCP Private Service Connect endpoint service.

status String

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.