MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi
mongodbatlas.getPrivateLinkEndpoint
Explore with Pulumi AI
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:
- Private
Link stringId - Unique identifier of the private endpoint service that you want to retrieve.
- Project
Id string - Unique identifier for the project.
- Provider
Name string - Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.
- Private
Link stringId - Unique identifier of the private endpoint service that you want to retrieve.
- Project
Id string - Unique identifier for the project.
- Provider
Name string - Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.
- private
Link StringId - Unique identifier of the private endpoint service that you want to retrieve.
- project
Id String - Unique identifier for the project.
- provider
Name String - Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.
- private
Link stringId - Unique identifier of the private endpoint service that you want to retrieve.
- project
Id string - Unique identifier for the project.
- provider
Name string - Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.
- private_
link_ strid - 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
orGCP
.
- private
Link StringId - Unique identifier of the private endpoint service that you want to retrieve.
- project
Id String - Unique identifier for the project.
- provider
Name String - Cloud provider for which you want to retrieve a private endpoint service. Atlas accepts
AWS
,AZURE
orGCP
.
getPrivateLinkEndpoint Result
The following output properties are available:
- Endpoint
Group List<string>Names - GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- Endpoint
Service stringName - Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- Error
Message 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.
- Interface
Endpoints List<string> - Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
- Private
Endpoints List<string> - All private endpoints that you have added to this Azure Private Link Service.
- Private
Link stringId - Private
Link stringService Name - Name of the Azure Private Link Service that Atlas manages.
- Private
Link stringService Resource Id - Resource ID of the Azure Private Link Service that Atlas manages.
- Project
Id string - Provider
Name string - Region
Name string - GCP region for the Private Service Connect endpoint service.
- Service
Attachment List<string>Names - 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 []stringNames - GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- Endpoint
Service stringName - Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- Error
Message 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.
- Interface
Endpoints []string - Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
- Private
Endpoints []string - All private endpoints that you have added to this Azure Private Link Service.
- Private
Link stringId - Private
Link stringService Name - Name of the Azure Private Link Service that Atlas manages.
- Private
Link stringService Resource Id - Resource ID of the Azure Private Link Service that Atlas manages.
- Project
Id string - Provider
Name string - Region
Name string - GCP region for the Private Service Connect endpoint service.
- Service
Attachment []stringNames - 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 List<String>Names - GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- endpoint
Service StringName - Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- error
Message 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.
- interface
Endpoints List<String> - Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
- private
Endpoints List<String> - All private endpoints that you have added to this Azure Private Link Service.
- private
Link StringId - private
Link StringService Name - Name of the Azure Private Link Service that Atlas manages.
- private
Link StringService Resource Id - Resource ID of the Azure Private Link Service that Atlas manages.
- project
Id String - provider
Name String - region
Name String - GCP region for the Private Service Connect endpoint service.
- service
Attachment List<String>Names - 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 string[]Names - GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- endpoint
Service stringName - Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- error
Message 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.
- interface
Endpoints string[] - Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
- private
Endpoints string[] - All private endpoints that you have added to this Azure Private Link Service.
- private
Link stringId - private
Link stringService Name - Name of the Azure Private Link Service that Atlas manages.
- private
Link stringService Resource Id - Resource ID of the Azure Private Link Service that Atlas manages.
- project
Id string - provider
Name string - region
Name string - GCP region for the Private Service Connect endpoint service.
- service
Attachment string[]Names - 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_ Sequence[str]names - GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- endpoint_
service_ strname - 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_ strid - private_
link_ strservice_ name - Name of the Azure Private Link Service that Atlas manages.
- private_
link_ strservice_ resource_ id - 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_ Sequence[str]names - 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:
- endpoint
Group List<String>Names - GCP network endpoint groups corresponding to the Private Service Connect endpoint service.
- endpoint
Service StringName - Name of the PrivateLink endpoint service in AWS. Returns null while the endpoint service is being created.
- error
Message 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.
- interface
Endpoints List<String> - Unique identifiers of the interface endpoints in your VPC that you added to the AWS PrivateLink connection.
- private
Endpoints List<String> - All private endpoints that you have added to this Azure Private Link Service.
- private
Link StringId - private
Link StringService Name - Name of the Azure Private Link Service that Atlas manages.
- private
Link StringService Resource Id - Resource ID of the Azure Private Link Service that Atlas manages.
- project
Id String - provider
Name String - region
Name String - GCP region for the Private Service Connect endpoint service.
- service
Attachment List<String>Names - 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
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlas
Terraform Provider.