MongoDB Atlas
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:
- Endpoint
Service stringId Unique identifier of the
AWS
orAZURE
resource.- Private
Link stringId Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
- Project
Id string Unique identifier for the project.
- Provider
Name string Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
orAZURE
.
- Endpoint
Service stringId Unique identifier of the
AWS
orAZURE
resource.- Private
Link stringId Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
- Project
Id string Unique identifier for the project.
- Provider
Name string Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
orAZURE
.
- endpoint
Service StringId Unique identifier of the
AWS
orAZURE
resource.- private
Link StringId Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
- project
Id String Unique identifier for the project.
- provider
Name String Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
orAZURE
.
- endpoint
Service stringId Unique identifier of the
AWS
orAZURE
resource.- private
Link stringId Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
- project
Id string Unique identifier for the project.
- provider
Name string Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
orAZURE
.
- endpoint_
service_ strid Unique identifier of the
AWS
orAZURE
resource.- private_
link_ strid 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
orAZURE
.
- endpoint
Service StringId Unique identifier of the
AWS
orAZURE
resource.- private
Link StringId Unique identifier of the private endpoint service for which you want to retrieve a private endpoint.
- project
Id String Unique identifier for the project.
- provider
Name String Cloud provider for which you want to create a private endpoint. Atlas accepts
AWS
orAZURE
.
getPrivateLinkEndpointService Result
The following output properties are available:
- Aws
Connection stringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- Azure
Status string 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 stringId - Endpoints
List<Get
Private Link Endpoint Service Endpoint> Collection of individual private endpoints that comprise your network endpoint group.
- Error
Message string Error message pertaining to the interface endpoint. Returns null if there are no errors.
- Gcp
Status 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.
- Interface
Endpoint stringId Unique identifier of the interface endpoint.
- Private
Endpoint stringConnection Name Name of the connection for this private endpoint that Atlas generates.
- Private
Endpoint stringIp Address Private IP address of the private endpoint network interface.
- Private
Endpoint stringResource Id Unique identifier of the private endpoint.
- Private
Link stringId - Project
Id string - Provider
Name string
- Aws
Connection stringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- Azure
Status string 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 stringId - Endpoints
[]Get
Private Link Endpoint Service Endpoint Collection of individual private endpoints that comprise your network endpoint group.
- Error
Message string Error message pertaining to the interface endpoint. Returns null if there are no errors.
- Gcp
Status 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.
- Interface
Endpoint stringId Unique identifier of the interface endpoint.
- Private
Endpoint stringConnection Name Name of the connection for this private endpoint that Atlas generates.
- Private
Endpoint stringIp Address Private IP address of the private endpoint network interface.
- Private
Endpoint stringResource Id Unique identifier of the private endpoint.
- Private
Link stringId - Project
Id string - Provider
Name string
- aws
Connection StringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status String Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested Boolean Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Service StringId - endpoints
List<Get
Private Link Endpoint Service Endpoint> Collection of individual private endpoints that comprise your network endpoint group.
- error
Message String Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Status 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.
- interface
Endpoint StringId Unique identifier of the interface endpoint.
- private
Endpoint StringConnection Name Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint StringIp Address Private IP address of the private endpoint network interface.
- private
Endpoint StringResource Id Unique identifier of the private endpoint.
- private
Link StringId - project
Id String - provider
Name String
- aws
Connection stringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status string Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested boolean Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Service stringId - endpoints
Get
Private Link Endpoint Service Endpoint[] Collection of individual private endpoints that comprise your network endpoint group.
- error
Message string Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Status 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.
- interface
Endpoint stringId Unique identifier of the interface endpoint.
- private
Endpoint stringConnection Name Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint stringIp Address Private IP address of the private endpoint network interface.
- private
Endpoint stringResource Id Unique identifier of the private endpoint.
- private
Link stringId - project
Id string - provider
Name string
- aws_
connection_ strstatus 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_ strid - endpoints
Sequence[Get
Private Link Endpoint Service Endpoint] 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_ strid Unique identifier of the interface endpoint.
- private_
endpoint_ strconnection_ name Name of the connection for this private endpoint that Atlas generates.
- private_
endpoint_ strip_ address Private IP address of the private endpoint network interface.
- private_
endpoint_ strresource_ id Unique identifier of the private endpoint.
- private_
link_ strid - project_
id str - provider_
name str
- aws
Connection StringStatus Status of the interface endpoint for AWS. Returns one of the following values:
- azure
Status String Status of the interface endpoint for AZURE. Returns one of the following values:
- delete
Requested Boolean Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
- endpoint
Service StringId - endpoints List<Property Map>
Collection of individual private endpoints that comprise your network endpoint group.
- error
Message String Error message pertaining to the interface endpoint. Returns null if there are no errors.
- gcp
Status 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.
- interface
Endpoint StringId Unique identifier of the interface endpoint.
- private
Endpoint StringConnection Name Name of the connection for this private endpoint that Atlas generates.
- private
Endpoint StringIp Address Private IP address of the private endpoint network interface.
- private
Endpoint StringResource Id Unique identifier of the private endpoint.
- private
Link StringId - project
Id String - provider
Name String
Supporting Types
GetPrivateLinkEndpointServiceEndpoint
- Endpoint
Name string Forwarding rule that corresponds to the endpoint you created in GCP.
- Ip
Address string Private IP address of the network endpoint group you created in GCP.
- Service
Attachment stringName 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 string Forwarding rule that corresponds to the endpoint you created in GCP.
- Ip
Address string Private IP address of the network endpoint group you created in GCP.
- Service
Attachment stringName 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 String Forwarding rule that corresponds to the endpoint you created in GCP.
- ip
Address String Private IP address of the network endpoint group you created in GCP.
- service
Attachment StringName 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 string Forwarding rule that corresponds to the endpoint you created in GCP.
- ip
Address string Private IP address of the network endpoint group you created in GCP.
- service
Attachment stringName 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_ strname 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.
- endpoint
Name String Forwarding rule that corresponds to the endpoint you created in GCP.
- ip
Address String Private IP address of the network endpoint group you created in GCP.
- service
Attachment StringName 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.