Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getPrivateEndpointRegionalMode
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getPrivateEndpointRegionalMode

Explore with Pulumi AI

MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas

# Data Source: private_endpoint_regional_mode

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.

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>
Copy
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]
Copy
func LookupPrivateEndpointRegionalMode(ctx *Context, args *LookupPrivateEndpointRegionalModeArgs, opts ...InvokeOption) (*LookupPrivateEndpointRegionalModeResult, error)
func LookupPrivateEndpointRegionalModeOutput(ctx *Context, args *LookupPrivateEndpointRegionalModeOutputArgs, opts ...InvokeOption) LookupPrivateEndpointRegionalModeResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetPrivateEndpointRegionalModeResult> getPrivateEndpointRegionalMode(GetPrivateEndpointRegionalModeArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointRegionalModeResult> getPrivateEndpointRegionalMode(GetPrivateEndpointRegionalModeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getPrivateEndpointRegionalMode:getPrivateEndpointRegionalMode
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ProjectId This property is required. string
Unique identifier for the project.
Enabled bool
Flag that indicates whether the regionalized private endpoitn setting is enabled for the project.
ProjectId This property is required. string
Unique identifier for the project.
Enabled bool
Flag that indicates whether the regionalized private endpoitn setting is enabled for the project.
projectId This property is required. String
Unique identifier for the project.
enabled Boolean
Flag that indicates whether the regionalized private endpoitn setting is enabled for the project.
projectId This property is required. string
Unique identifier for the project.
enabled boolean
Flag that indicates whether the regionalized private endpoitn setting is enabled for the project.
project_id This property is required. str
Unique identifier for the project.
enabled bool
Flag that indicates whether the regionalized private endpoitn setting is enabled for the project.
projectId This property is required. 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.
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi
pulumi/pulumi-mongodbatlas