MongoDB Atlas

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

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.

Using getPrivateLinkEndpointService

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 getPrivateLinkEndpointService(args: GetPrivateLinkEndpointServiceArgs, opts?: InvokeOptions): Promise<GetPrivateLinkEndpointServiceResult>
function getPrivateLinkEndpointServiceOutput(args: GetPrivateLinkEndpointServiceOutputArgs, opts?: InvokeOptions): Output<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
def get_private_link_endpoint_service_output(endpoint_service_id: Optional[pulumi.Input[str]] = None,
                                      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[GetPrivateLinkEndpointServiceResult]
func LookupPrivateLinkEndpointService(ctx *Context, args *LookupPrivateLinkEndpointServiceArgs, opts ...InvokeOption) (*LookupPrivateLinkEndpointServiceResult, error)
func LookupPrivateLinkEndpointServiceOutput(ctx *Context, args *LookupPrivateLinkEndpointServiceOutputArgs, opts ...InvokeOption) LookupPrivateLinkEndpointServiceResultOutput

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

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

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.

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.

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.

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
Endpoints List<GetPrivateLinkEndpointServiceEndpoint>

Collection of individual private endpoints that comprise your network endpoint group.

ErrorMessage string

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

GcpStatus string

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

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
Endpoints []GetPrivateLinkEndpointServiceEndpoint

Collection of individual private endpoints that comprise your network endpoint group.

ErrorMessage string

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

GcpStatus string

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

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
endpoints List<GetPrivateLinkEndpointServiceEndpoint>

Collection of individual private endpoints that comprise your network endpoint group.

errorMessage String

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

gcpStatus String

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

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
endpoints GetPrivateLinkEndpointServiceEndpoint[]

Collection of individual private endpoints that comprise your network endpoint group.

errorMessage string

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

gcpStatus string

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

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
endpoints Sequence[GetPrivateLinkEndpointServiceEndpoint]

Collection of individual private endpoints that comprise your network endpoint group.

error_message str

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

gcp_status str

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

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
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
endpoints List<Property Map>

Collection of individual private endpoints that comprise your network endpoint group.

errorMessage String

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

gcpStatus String

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

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

Supporting Types

GetPrivateLinkEndpointServiceEndpoint

EndpointName string

Forwarding rule that corresponds to the endpoint you created in GCP.

IpAddress string

Private IP address of the network endpoint group you created in GCP.

ServiceAttachmentName string

Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.

Status string

Status of the endpoint. Atlas returns one of the values shown above.

EndpointName string

Forwarding rule that corresponds to the endpoint you created in GCP.

IpAddress string

Private IP address of the network endpoint group you created in GCP.

ServiceAttachmentName string

Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.

Status string

Status of the endpoint. Atlas returns one of the values shown above.

endpointName String

Forwarding rule that corresponds to the endpoint you created in GCP.

ipAddress String

Private IP address of the network endpoint group you created in GCP.

serviceAttachmentName String

Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.

status String

Status of the endpoint. Atlas returns one of the values shown above.

endpointName string

Forwarding rule that corresponds to the endpoint you created in GCP.

ipAddress string

Private IP address of the network endpoint group you created in GCP.

serviceAttachmentName string

Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.

status string

Status of the endpoint. Atlas returns one of the values shown above.

endpoint_name str

Forwarding rule that corresponds to the endpoint you created in GCP.

ip_address str

Private IP address of the network endpoint group you created in GCP.

service_attachment_name str

Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.

status str

Status of the endpoint. Atlas returns one of the values shown above.

endpointName String

Forwarding rule that corresponds to the endpoint you created in GCP.

ipAddress String

Private IP address of the network endpoint group you created in GCP.

serviceAttachmentName String

Unique alphanumeric and special character strings that identify the service attachment associated with the endpoint.

status String

Status of the endpoint. Atlas returns one of the values shown above.

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.