1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getPrivateEndpointRegionalMode
MongoDB Atlas v4.3.0 published on Thursday, Feb 5, 2026 by Pulumi
mongodbatlas logo
MongoDB Atlas v4.3.0 published on Thursday, Feb 5, 2026 by Pulumi

    private_endpoint_regional_mode describes a Private Endpoint Regional Mode. This represents a Private Endpoint Regional Mode Connection that wants to retrieve settings of an Atlas project.

    NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as _private from "@pulumi/private";
    
    const testEndpointRegionalMode = new _private.index.EndpointRegionalMode("test", {projectId: "<PROJECT-ID>"});
    const test = _private.index.EndpointRegionalMode({
        projectId: testEndpointRegionalMode.projectId,
    });
    
    import pulumi
    import pulumi_private as private
    
    test_endpoint_regional_mode = private.index.EndpointRegionalMode("test", project_id=<PROJECT-ID>)
    test = private.index.endpoint_regional_mode(project_id=test_endpoint_regional_mode["projectId"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-private/sdk/go/private"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		testEndpointRegionalMode, err := private.NewEndpointRegionalMode(ctx, "test", &private.EndpointRegionalModeArgs{
    			ProjectId: "<PROJECT-ID>",
    		})
    		if err != nil {
    			return err
    		}
    		_, err = private.EndpointRegionalMode(ctx, map[string]interface{}{
    			"projectId": testEndpointRegionalMode.ProjectId,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Private = Pulumi.Private;
    
    return await Deployment.RunAsync(() => 
    {
        var testEndpointRegionalMode = new Private.Index.EndpointRegionalMode("test", new()
        {
            ProjectId = "<PROJECT-ID>",
        });
    
        var test = Private.Index.EndpointRegionalMode.Invoke(new()
        {
            ProjectId = testEndpointRegionalMode.ProjectId,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.private.EndpointRegionalMode;
    import com.pulumi.private.EndpointRegionalModeArgs;
    import com.pulumi.private.PrivateFunctions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var testEndpointRegionalMode = new EndpointRegionalMode("testEndpointRegionalMode", EndpointRegionalModeArgs.builder()
                .projectId("<PROJECT-ID>")
                .build());
    
            final var test = PrivateFunctions.EndpointRegionalMode(Map.of("projectId", testEndpointRegionalMode.projectId()));
    
        }
    }
    
    resources:
      testEndpointRegionalMode:
        type: private:EndpointRegionalMode
        name: test
        properties:
          projectId: <PROJECT-ID>
    variables:
      test:
        fn::invoke:
          function: private:EndpointRegionalMode
          arguments:
            projectId: ${testEndpointRegionalMode.projectId}
    

    Using getPrivateEndpointRegionalMode

    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 getPrivateEndpointRegionalMode(args: GetPrivateEndpointRegionalModeArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointRegionalModeResult>
    function getPrivateEndpointRegionalModeOutput(args: GetPrivateEndpointRegionalModeOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointRegionalModeResult>
    def get_private_endpoint_regional_mode(enabled: Optional[bool] = None,
                                           project_id: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointRegionalModeResult
    def get_private_endpoint_regional_mode_output(enabled: Optional[pulumi.Input[bool]] = None,
                                           project_id: Optional[pulumi.Input[str]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointRegionalModeResult]
    func LookupPrivateEndpointRegionalMode(ctx *Context, args *LookupPrivateEndpointRegionalModeArgs, opts ...InvokeOption) (*LookupPrivateEndpointRegionalModeResult, error)
    func LookupPrivateEndpointRegionalModeOutput(ctx *Context, args *LookupPrivateEndpointRegionalModeOutputArgs, opts ...InvokeOption) LookupPrivateEndpointRegionalModeResultOutput

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

    public static class GetPrivateEndpointRegionalMode 
    {
        public static Task<GetPrivateEndpointRegionalModeResult> InvokeAsync(GetPrivateEndpointRegionalModeArgs args, InvokeOptions? opts = null)
        public static Output<GetPrivateEndpointRegionalModeResult> Invoke(GetPrivateEndpointRegionalModeInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetPrivateEndpointRegionalModeResult> getPrivateEndpointRegionalMode(GetPrivateEndpointRegionalModeArgs args, InvokeOptions options)
    public static Output<GetPrivateEndpointRegionalModeResult> getPrivateEndpointRegionalMode(GetPrivateEndpointRegionalModeArgs args, InvokeOptions options)
    
    fn::invoke:
      function: mongodbatlas:index/getPrivateEndpointRegionalMode:getPrivateEndpointRegionalMode
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ProjectId string
    Unique identifier for the project.
    Enabled bool
    Flag that indicates whether the regionalized private endpoitn setting is enabled for the project.
    ProjectId string
    Unique identifier for the project.
    Enabled bool
    Flag that indicates whether the regionalized private endpoitn setting is enabled for the project.
    projectId String
    Unique identifier for the project.
    enabled Boolean
    Flag that indicates whether the regionalized private endpoitn setting is enabled for the project.
    projectId string
    Unique identifier for the project.
    enabled boolean
    Flag that indicates whether the regionalized private endpoitn setting is enabled for the project.
    project_id str
    Unique identifier for the project.
    enabled bool
    Flag that indicates whether the regionalized private endpoitn setting is enabled for the project.
    projectId String
    Unique identifier for the project.
    enabled Boolean
    Flag that indicates whether the regionalized private endpoitn setting is enabled for the project.

    getPrivateEndpointRegionalMode Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    Enabled bool
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    Enabled bool
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    enabled Boolean
    id string
    The provider-assigned unique ID for this managed resource.
    projectId string
    enabled boolean
    id str
    The provider-assigned unique ID for this managed resource.
    project_id str
    enabled bool
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    enabled Boolean

    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 v4.3.0 published on Thursday, Feb 5, 2026 by Pulumi
      Meet Neo: Your AI Platform Teammate