1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. PrivateLinkEndpointService
MongoDB Atlas v3.36.0 published on Friday, Aug 22, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.PrivateLinkEndpointService

Get Started
mongodbatlas logo
MongoDB Atlas v3.36.0 published on Friday, Aug 22, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

    Import

    Private Endpoint Link Connection can be imported using project ID and username, in the format {project_id}--{private_link_id}--{endpoint_service_id}--{provider_name}, e.g.

    $ pulumi import mongodbatlas:index/privateLinkEndpointService:PrivateLinkEndpointService test 1112222b3bf99403840e8934--3242342343112--vpce-4242342343--AWS

    See detailed information for arguments and attributes: MongoDB API Private Endpoint Link Connection

    Create PrivateLinkEndpointService Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PrivateLinkEndpointService(name: string, args: PrivateLinkEndpointServiceArgs, opts?: CustomResourceOptions);
    @overload
def PrivateLinkEndpointService(resource_name: str,
                               args: PrivateLinkEndpointServiceArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def PrivateLinkEndpointService(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               endpoint_service_id: Optional[str] = None,
                               private_link_id: Optional[str] = None,
                               project_id: Optional[str] = None,
                               provider_name: Optional[str] = None,
                               endpoints: Optional[Sequence[PrivateLinkEndpointServiceEndpointArgs]] = None,
                               gcp_project_id: Optional[str] = None,
                               private_endpoint_ip_address: Optional[str] = None)
    func NewPrivateLinkEndpointService(ctx *Context, name string, args PrivateLinkEndpointServiceArgs, opts ...ResourceOption) (*PrivateLinkEndpointService, error)
    public PrivateLinkEndpointService(string name, PrivateLinkEndpointServiceArgs args, CustomResourceOptions? opts = null)
    public PrivateLinkEndpointService(String name, PrivateLinkEndpointServiceArgs args)
public PrivateLinkEndpointService(String name, PrivateLinkEndpointServiceArgs args, CustomResourceOptions options)

    type: mongodbatlas:PrivateLinkEndpointService
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PrivateLinkEndpointServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PrivateLinkEndpointServiceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PrivateLinkEndpointServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateLinkEndpointServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateLinkEndpointServiceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var privateLinkEndpointServiceResource = new Mongodbatlas.PrivateLinkEndpointService("privateLinkEndpointServiceResource", new()
{
    EndpointServiceId = "string",
    PrivateLinkId = "string",
    ProjectId = "string",
    ProviderName = "string",
    Endpoints = new[]
    {
        new Mongodbatlas.Inputs.PrivateLinkEndpointServiceEndpointArgs
        {
            EndpointName = "string",
            IpAddress = "string",
            Status = "string",
        },
    },
    GcpProjectId = "string",
    PrivateEndpointIpAddress = "string",
});

    example, err := mongodbatlas.NewPrivateLinkEndpointService(ctx, "privateLinkEndpointServiceResource", &mongodbatlas.PrivateLinkEndpointServiceArgs{
	EndpointServiceId: pulumi.String("string"),
	PrivateLinkId:     pulumi.String("string"),
	ProjectId:         pulumi.String("string"),
	ProviderName:      pulumi.String("string"),
	Endpoints: mongodbatlas.PrivateLinkEndpointServiceEndpointArray{
		&mongodbatlas.PrivateLinkEndpointServiceEndpointArgs{
			EndpointName: pulumi.String("string"),
			IpAddress:    pulumi.String("string"),
			Status:       pulumi.String("string"),
		},
	},
	GcpProjectId:             pulumi.String("string"),
	PrivateEndpointIpAddress: pulumi.String("string"),
})

    var privateLinkEndpointServiceResource = new PrivateLinkEndpointService("privateLinkEndpointServiceResource", PrivateLinkEndpointServiceArgs.builder()
    .endpointServiceId("string")
    .privateLinkId("string")
    .projectId("string")
    .providerName("string")
    .endpoints(PrivateLinkEndpointServiceEndpointArgs.builder()
        .endpointName("string")
        .ipAddress("string")
        .status("string")
        .build())
    .gcpProjectId("string")
    .privateEndpointIpAddress("string")
    .build());

    private_link_endpoint_service_resource = mongodbatlas.PrivateLinkEndpointService("privateLinkEndpointServiceResource",
    endpoint_service_id="string",
    private_link_id="string",
    project_id="string",
    provider_name="string",
    endpoints=[{
        "endpoint_name": "string",
        "ip_address": "string",
        "status": "string",
    }],
    gcp_project_id="string",
    private_endpoint_ip_address="string")

    const privateLinkEndpointServiceResource = new mongodbatlas.PrivateLinkEndpointService("privateLinkEndpointServiceResource", {
    endpointServiceId: "string",
    privateLinkId: "string",
    projectId: "string",
    providerName: "string",
    endpoints: [{
        endpointName: "string",
        ipAddress: "string",
        status: "string",
    }],
    gcpProjectId: "string",
    privateEndpointIpAddress: "string",
});

    type: mongodbatlas:PrivateLinkEndpointService
properties:
    endpointServiceId: string
    endpoints:
        - endpointName: string
          ipAddress: string
          status: string
    gcpProjectId: string
    privateEndpointIpAddress: string
    privateLinkId: string
    projectId: string
    providerName: string

    PrivateLinkEndpointService Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PrivateLinkEndpointService resource accepts the following input properties:

    EndpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC with the AWS, AZURE or GCP resource.
    PrivateLinkId string
    Unique identifier of the AWS or AZURE PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    ProjectId string
    Unique identifier for the project.
    ProviderName string
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    Endpoints List<PrivateLinkEndpointServiceEndpoint>
    Collection of individual private endpoints that comprise your endpoint group. Only for GCP. See below.
    GcpProjectId string
    Unique identifier of the GCP project in which you created your endpoints. Only for GCP.
    PrivateEndpointIpAddress string
    Private IP address of the private endpoint network interface you created in your Azure VNet. Only for AZURE.
    EndpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC with the AWS, AZURE or GCP resource.
    PrivateLinkId string
    Unique identifier of the AWS or AZURE PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    ProjectId string
    Unique identifier for the project.
    ProviderName string
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    Endpoints []PrivateLinkEndpointServiceEndpointArgs
    Collection of individual private endpoints that comprise your endpoint group. Only for GCP. See below.
    GcpProjectId string
    Unique identifier of the GCP project in which you created your endpoints. Only for GCP.
    PrivateEndpointIpAddress string
    Private IP address of the private endpoint network interface you created in your Azure VNet. Only for AZURE.
    endpointServiceId String
    Unique identifier of the interface endpoint you created in your VPC with the AWS, AZURE or GCP resource.
    privateLinkId String
    Unique identifier of the AWS or AZURE PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    projectId String
    Unique identifier for the project.
    providerName String
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    endpoints List<PrivateLinkEndpointServiceEndpoint>
    Collection of individual private endpoints that comprise your endpoint group. Only for GCP. See below.
    gcpProjectId String
    Unique identifier of the GCP project in which you created your endpoints. Only for GCP.
    privateEndpointIpAddress String
    Private IP address of the private endpoint network interface you created in your Azure VNet. Only for AZURE.
    endpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC with the AWS, AZURE or GCP resource.
    privateLinkId string
    Unique identifier of the AWS or AZURE PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    projectId string
    Unique identifier for the project.
    providerName string
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    endpoints PrivateLinkEndpointServiceEndpoint[]
    Collection of individual private endpoints that comprise your endpoint group. Only for GCP. See below.
    gcpProjectId string
    Unique identifier of the GCP project in which you created your endpoints. Only for GCP.
    privateEndpointIpAddress string
    Private IP address of the private endpoint network interface you created in your Azure VNet. Only for AZURE.
    endpoint_service_id str
    Unique identifier of the interface endpoint you created in your VPC with the AWS, AZURE or GCP resource.
    private_link_id str
    Unique identifier of the AWS or AZURE PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    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, AZURE or GCP.
    endpoints Sequence[PrivateLinkEndpointServiceEndpointArgs]
    Collection of individual private endpoints that comprise your endpoint group. Only for GCP. See below.
    gcp_project_id str
    Unique identifier of the GCP project in which you created your endpoints. Only for GCP.
    private_endpoint_ip_address str
    Private IP address of the private endpoint network interface you created in your Azure VNet. Only for AZURE.
    endpointServiceId String
    Unique identifier of the interface endpoint you created in your VPC with the AWS, AZURE or GCP resource.
    privateLinkId String
    Unique identifier of the AWS or AZURE PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    projectId String
    Unique identifier for the project.
    providerName String
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    endpoints List<Property Map>
    Collection of individual private endpoints that comprise your endpoint group. Only for GCP. See below.
    gcpProjectId String
    Unique identifier of the GCP project in which you created your endpoints. Only for GCP.
    privateEndpointIpAddress String
    Private IP address of the private endpoint network interface you created in your Azure VNet. Only for AZURE.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PrivateLinkEndpointService resource produces the following output properties:

    AwsConnectionStatus string
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    AzureStatus string
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    DeleteRequested bool
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    EndpointGroupName string
    (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
    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:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    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.
    PrivateEndpointResourceId string
    Unique identifier of the private endpoint.
    AwsConnectionStatus string
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    AzureStatus string
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    DeleteRequested bool
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    EndpointGroupName string
    (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
    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:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    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.
    PrivateEndpointResourceId string
    Unique identifier of the private endpoint.
    awsConnectionStatus String
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    azureStatus String
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    deleteRequested Boolean
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    endpointGroupName String
    (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
    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:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    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.
    privateEndpointResourceId String
    Unique identifier of the private endpoint.
    awsConnectionStatus string
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    azureStatus string
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    deleteRequested boolean
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    endpointGroupName string
    (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
    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:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    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.
    privateEndpointResourceId string
    Unique identifier of the private endpoint.
    aws_connection_status str
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    azure_status str
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    delete_requested bool
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    endpoint_group_name str
    (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
    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:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    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_resource_id str
    Unique identifier of the private endpoint.
    awsConnectionStatus String
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    azureStatus String
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    deleteRequested Boolean
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    endpointGroupName String
    (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
    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:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    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.
    privateEndpointResourceId String
    Unique identifier of the private endpoint.

    Look up Existing PrivateLinkEndpointService Resource

    Get an existing PrivateLinkEndpointService resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PrivateLinkEndpointServiceState, opts?: CustomResourceOptions): PrivateLinkEndpointService
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_connection_status: Optional[str] = None,
        azure_status: Optional[str] = None,
        delete_requested: Optional[bool] = None,
        endpoint_group_name: Optional[str] = None,
        endpoint_service_id: Optional[str] = None,
        endpoints: Optional[Sequence[PrivateLinkEndpointServiceEndpointArgs]] = None,
        error_message: Optional[str] = None,
        gcp_project_id: Optional[str] = None,
        gcp_status: Optional[str] = None,
        interface_endpoint_id: Optional[str] = None,
        private_endpoint_connection_name: Optional[str] = None,
        private_endpoint_ip_address: Optional[str] = None,
        private_endpoint_resource_id: Optional[str] = None,
        private_link_id: Optional[str] = None,
        project_id: Optional[str] = None,
        provider_name: Optional[str] = None) -> PrivateLinkEndpointService
    func GetPrivateLinkEndpointService(ctx *Context, name string, id IDInput, state *PrivateLinkEndpointServiceState, opts ...ResourceOption) (*PrivateLinkEndpointService, error)
    public static PrivateLinkEndpointService Get(string name, Input<string> id, PrivateLinkEndpointServiceState? state, CustomResourceOptions? opts = null)
    public static PrivateLinkEndpointService get(String name, Output<String> id, PrivateLinkEndpointServiceState state, CustomResourceOptions options)
    resources:  _:    type: mongodbatlas:PrivateLinkEndpointService    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AwsConnectionStatus string
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    AzureStatus string
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    DeleteRequested bool
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    EndpointGroupName string
    (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
    EndpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC with the AWS, AZURE or GCP resource.
    Endpoints List<PrivateLinkEndpointServiceEndpoint>
    Collection of individual private endpoints that comprise your endpoint group. Only for GCP. See below.
    ErrorMessage string
    Error message pertaining to the interface endpoint. Returns null if there are no errors.
    GcpProjectId string
    Unique identifier of the GCP project in which you created your endpoints. Only for GCP.
    GcpStatus string
    Status of the interface endpoint for GCP. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    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 you created in your Azure VNet. Only for AZURE.
    PrivateEndpointResourceId string
    Unique identifier of the private endpoint.
    PrivateLinkId string
    Unique identifier of the AWS or AZURE PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    ProjectId string
    Unique identifier for the project.
    ProviderName string
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    AwsConnectionStatus string
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    AzureStatus string
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    DeleteRequested bool
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    EndpointGroupName string
    (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
    EndpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC with the AWS, AZURE or GCP resource.
    Endpoints []PrivateLinkEndpointServiceEndpointArgs
    Collection of individual private endpoints that comprise your endpoint group. Only for GCP. See below.
    ErrorMessage string
    Error message pertaining to the interface endpoint. Returns null if there are no errors.
    GcpProjectId string
    Unique identifier of the GCP project in which you created your endpoints. Only for GCP.
    GcpStatus string
    Status of the interface endpoint for GCP. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    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 you created in your Azure VNet. Only for AZURE.
    PrivateEndpointResourceId string
    Unique identifier of the private endpoint.
    PrivateLinkId string
    Unique identifier of the AWS or AZURE PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    ProjectId string
    Unique identifier for the project.
    ProviderName string
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    awsConnectionStatus String
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    azureStatus String
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    deleteRequested Boolean
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    endpointGroupName String
    (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
    endpointServiceId String
    Unique identifier of the interface endpoint you created in your VPC with the AWS, AZURE or GCP resource.
    endpoints List<PrivateLinkEndpointServiceEndpoint>
    Collection of individual private endpoints that comprise your endpoint group. Only for GCP. See below.
    errorMessage String
    Error message pertaining to the interface endpoint. Returns null if there are no errors.
    gcpProjectId String
    Unique identifier of the GCP project in which you created your endpoints. Only for GCP.
    gcpStatus String
    Status of the interface endpoint for GCP. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    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 you created in your Azure VNet. Only for AZURE.
    privateEndpointResourceId String
    Unique identifier of the private endpoint.
    privateLinkId String
    Unique identifier of the AWS or AZURE PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    projectId String
    Unique identifier for the project.
    providerName String
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    awsConnectionStatus string
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    azureStatus string
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    deleteRequested boolean
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    endpointGroupName string
    (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
    endpointServiceId string
    Unique identifier of the interface endpoint you created in your VPC with the AWS, AZURE or GCP resource.
    endpoints PrivateLinkEndpointServiceEndpoint[]
    Collection of individual private endpoints that comprise your endpoint group. Only for GCP. See below.
    errorMessage string
    Error message pertaining to the interface endpoint. Returns null if there are no errors.
    gcpProjectId string
    Unique identifier of the GCP project in which you created your endpoints. Only for GCP.
    gcpStatus string
    Status of the interface endpoint for GCP. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    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 you created in your Azure VNet. Only for AZURE.
    privateEndpointResourceId string
    Unique identifier of the private endpoint.
    privateLinkId string
    Unique identifier of the AWS or AZURE PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    projectId string
    Unique identifier for the project.
    providerName string
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.
    aws_connection_status str
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    azure_status str
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    delete_requested bool
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    endpoint_group_name str
    (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
    endpoint_service_id str
    Unique identifier of the interface endpoint you created in your VPC with the AWS, AZURE or GCP resource.
    endpoints Sequence[PrivateLinkEndpointServiceEndpointArgs]
    Collection of individual private endpoints that comprise your endpoint group. Only for GCP. See below.
    error_message str
    Error message pertaining to the interface endpoint. Returns null if there are no errors.
    gcp_project_id str
    Unique identifier of the GCP project in which you created your endpoints. Only for GCP.
    gcp_status str
    Status of the interface endpoint for GCP. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    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 you created in your Azure VNet. Only for AZURE.
    private_endpoint_resource_id str
    Unique identifier of the private endpoint.
    private_link_id str
    Unique identifier of the AWS or AZURE PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    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, AZURE or GCP.
    awsConnectionStatus String
    Status of the interface endpoint for AWS. Returns one of the following values:

    • NONE - Atlas created the network load balancer and VPC endpoint service, but AWS hasn't yet created the VPC endpoint.
    • PENDING_ACCEPTANCE - AWS has received the connection request from your VPC endpoint to the Atlas VPC endpoint service.
    • PENDING - AWS is establishing the connection between your VPC endpoint and the Atlas VPC endpoint service.
    • AVAILABLE - Atlas VPC resources are connected to the VPC endpoint in your VPC. You can connect to Atlas clusters in this region using AWS PrivateLink.
    • REJECTED - AWS failed to establish a connection between Atlas VPC resources to the VPC endpoint in your VPC.
    • DELETING - Atlas is removing the interface endpoint from the private endpoint connection.
    azureStatus String
    Status of the interface endpoint for AZURE. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    deleteRequested Boolean
    Indicates if Atlas received a request to remove the interface endpoint from the private endpoint connection.
    endpointGroupName String
    (Optional) Unique identifier of the endpoint group. The endpoint group encompasses all of the endpoints that you created in GCP.
    endpointServiceId String
    Unique identifier of the interface endpoint you created in your VPC with the AWS, AZURE or GCP resource.
    endpoints List<Property Map>
    Collection of individual private endpoints that comprise your endpoint group. Only for GCP. See below.
    errorMessage String
    Error message pertaining to the interface endpoint. Returns null if there are no errors.
    gcpProjectId String
    Unique identifier of the GCP project in which you created your endpoints. Only for GCP.
    gcpStatus String
    Status of the interface endpoint for GCP. Returns one of the following values:

    • INITIATING - Atlas has not yet accepted the connection to your private endpoint.
    • AVAILABLE - Atlas approved the connection to your private endpoint.
    • FAILED - Atlas failed to accept the connection your private endpoint.
    • DELETING - Atlas is removing the connection to your private endpoint from the Private Link service.
    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 you created in your Azure VNet. Only for AZURE.
    privateEndpointResourceId String
    Unique identifier of the private endpoint.
    privateLinkId String
    Unique identifier of the AWS or AZURE PrivateLink connection which is created by mongodbatlas.PrivateLinkEndpoint resource.
    projectId String
    Unique identifier for the project.
    providerName String
    Cloud provider for which you want to create a private endpoint. Atlas accepts AWS, AZURE or GCP.

    Supporting Types

    PrivateLinkEndpointServiceEndpoint, PrivateLinkEndpointServiceEndpointArgs

    EndpointName string
    Forwarding rule that corresponds to the endpoint you created in GCP.
    IpAddress string
    Private IP address of the endpoint you created in GCP.
    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 endpoint you created in GCP.
    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 endpoint you created in GCP.
    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 endpoint you created in GCP.
    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 endpoint you created in GCP.
    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 endpoint you created in GCP.
    status String
    Status of the endpoint. Atlas returns one of the values shown above.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.36.0 published on Friday, Aug 22, 2025 by Pulumi
    pulumi/pulumi-mongodbatlas
      Meet Neo: Your AI Platform Teammate