Docs Packages
  1. Pulumi Registry
  2. MongoDB Atlas
  3. API Docs
  4. PrivateEndpointRegionalMode
mongodbatlas logo
MongoDB Atlas v3.7.2, Mar 31 23

mongodbatlas.PrivateEndpointRegionalMode

Explore with Pulumi AI

Import

Private Endpoint Regional Mode can be imported using project id in format {project_id}, e.g.

 $ pulumi import mongodbatlas:index/privateEndpointRegionalMode:PrivateEndpointRegionalMode test 1112222b3bf99403840e8934

See detailed information for arguments and attributesPrivate Endpoints Get Regional Mode | Update Regional Mode

Create PrivateEndpointRegionalMode Resource

new PrivateEndpointRegionalMode(name: string, args: PrivateEndpointRegionalModeArgs, opts?: CustomResourceOptions);
@overload
def PrivateEndpointRegionalMode(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                enabled: Optional[bool] = None,
                                project_id: Optional[str] = None)
@overload
def PrivateEndpointRegionalMode(resource_name: str,
                                args: PrivateEndpointRegionalModeArgs,
                                opts: Optional[ResourceOptions] = None)
func NewPrivateEndpointRegionalMode(ctx *Context, name string, args PrivateEndpointRegionalModeArgs, opts ...ResourceOption) (*PrivateEndpointRegionalMode, error)
public PrivateEndpointRegionalMode(string name, PrivateEndpointRegionalModeArgs args, CustomResourceOptions? opts = null)
public PrivateEndpointRegionalMode(String name, PrivateEndpointRegionalModeArgs args)
public PrivateEndpointRegionalMode(String name, PrivateEndpointRegionalModeArgs args, CustomResourceOptions options)

type: mongodbatlas:PrivateEndpointRegionalMode
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PrivateEndpointRegionalModeArgs
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 PrivateEndpointRegionalModeArgs
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 PrivateEndpointRegionalModeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args PrivateEndpointRegionalModeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args PrivateEndpointRegionalModeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

PrivateEndpointRegionalMode Resource Properties

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

Inputs

The PrivateEndpointRegionalMode resource accepts the following input properties:

ProjectId string

Unique identifier for the project.

Enabled bool

Flag that indicates whether the regionalized private endpoint setting is enabled for the project. Set this value to true to create more than one private endpoint in a cloud provider region to connect to multi-region and global Atlas sharded clusters. You can enable this setting only if your Atlas project contains no replica sets. You can't disable this setting if you have:

  • More than one private endpoint in more than one region, or
  • More than one private endpoint in one region and one private endpoint in one or more regions. You can create only sharded clusters when you enable the regionalized private endpoint setting. You can't create replica sets.
ProjectId string

Unique identifier for the project.

Enabled bool

Flag that indicates whether the regionalized private endpoint setting is enabled for the project. Set this value to true to create more than one private endpoint in a cloud provider region to connect to multi-region and global Atlas sharded clusters. You can enable this setting only if your Atlas project contains no replica sets. You can't disable this setting if you have:

  • More than one private endpoint in more than one region, or
  • More than one private endpoint in one region and one private endpoint in one or more regions. You can create only sharded clusters when you enable the regionalized private endpoint setting. You can't create replica sets.
projectId String

Unique identifier for the project.

enabled Boolean

Flag that indicates whether the regionalized private endpoint setting is enabled for the project. Set this value to true to create more than one private endpoint in a cloud provider region to connect to multi-region and global Atlas sharded clusters. You can enable this setting only if your Atlas project contains no replica sets. You can't disable this setting if you have:

  • More than one private endpoint in more than one region, or
  • More than one private endpoint in one region and one private endpoint in one or more regions. You can create only sharded clusters when you enable the regionalized private endpoint setting. You can't create replica sets.
projectId string

Unique identifier for the project.

enabled boolean

Flag that indicates whether the regionalized private endpoint setting is enabled for the project. Set this value to true to create more than one private endpoint in a cloud provider region to connect to multi-region and global Atlas sharded clusters. You can enable this setting only if your Atlas project contains no replica sets. You can't disable this setting if you have:

  • More than one private endpoint in more than one region, or
  • More than one private endpoint in one region and one private endpoint in one or more regions. You can create only sharded clusters when you enable the regionalized private endpoint setting. You can't create replica sets.
project_id str

Unique identifier for the project.

enabled bool

Flag that indicates whether the regionalized private endpoint setting is enabled for the project. Set this value to true to create more than one private endpoint in a cloud provider region to connect to multi-region and global Atlas sharded clusters. You can enable this setting only if your Atlas project contains no replica sets. You can't disable this setting if you have:

  • More than one private endpoint in more than one region, or
  • More than one private endpoint in one region and one private endpoint in one or more regions. You can create only sharded clusters when you enable the regionalized private endpoint setting. You can't create replica sets.
projectId String

Unique identifier for the project.

enabled Boolean

Flag that indicates whether the regionalized private endpoint setting is enabled for the project. Set this value to true to create more than one private endpoint in a cloud provider region to connect to multi-region and global Atlas sharded clusters. You can enable this setting only if your Atlas project contains no replica sets. You can't disable this setting if you have:

  • More than one private endpoint in more than one region, or
  • More than one private endpoint in one region and one private endpoint in one or more regions. You can create only sharded clusters when you enable the regionalized private endpoint setting. You can't create replica sets.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing PrivateEndpointRegionalMode Resource

Get an existing PrivateEndpointRegionalMode 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?: PrivateEndpointRegionalModeState, opts?: CustomResourceOptions): PrivateEndpointRegionalMode
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enabled: Optional[bool] = None,
        project_id: Optional[str] = None) -> PrivateEndpointRegionalMode
func GetPrivateEndpointRegionalMode(ctx *Context, name string, id IDInput, state *PrivateEndpointRegionalModeState, opts ...ResourceOption) (*PrivateEndpointRegionalMode, error)
public static PrivateEndpointRegionalMode Get(string name, Input<string> id, PrivateEndpointRegionalModeState? state, CustomResourceOptions? opts = null)
public static PrivateEndpointRegionalMode get(String name, Output<String> id, PrivateEndpointRegionalModeState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
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:
Enabled bool

Flag that indicates whether the regionalized private endpoint setting is enabled for the project. Set this value to true to create more than one private endpoint in a cloud provider region to connect to multi-region and global Atlas sharded clusters. You can enable this setting only if your Atlas project contains no replica sets. You can't disable this setting if you have:

  • More than one private endpoint in more than one region, or
  • More than one private endpoint in one region and one private endpoint in one or more regions. You can create only sharded clusters when you enable the regionalized private endpoint setting. You can't create replica sets.
ProjectId string

Unique identifier for the project.

Enabled bool

Flag that indicates whether the regionalized private endpoint setting is enabled for the project. Set this value to true to create more than one private endpoint in a cloud provider region to connect to multi-region and global Atlas sharded clusters. You can enable this setting only if your Atlas project contains no replica sets. You can't disable this setting if you have:

  • More than one private endpoint in more than one region, or
  • More than one private endpoint in one region and one private endpoint in one or more regions. You can create only sharded clusters when you enable the regionalized private endpoint setting. You can't create replica sets.
ProjectId string

Unique identifier for the project.

enabled Boolean

Flag that indicates whether the regionalized private endpoint setting is enabled for the project. Set this value to true to create more than one private endpoint in a cloud provider region to connect to multi-region and global Atlas sharded clusters. You can enable this setting only if your Atlas project contains no replica sets. You can't disable this setting if you have:

  • More than one private endpoint in more than one region, or
  • More than one private endpoint in one region and one private endpoint in one or more regions. You can create only sharded clusters when you enable the regionalized private endpoint setting. You can't create replica sets.
projectId String

Unique identifier for the project.

enabled boolean

Flag that indicates whether the regionalized private endpoint setting is enabled for the project. Set this value to true to create more than one private endpoint in a cloud provider region to connect to multi-region and global Atlas sharded clusters. You can enable this setting only if your Atlas project contains no replica sets. You can't disable this setting if you have:

  • More than one private endpoint in more than one region, or
  • More than one private endpoint in one region and one private endpoint in one or more regions. You can create only sharded clusters when you enable the regionalized private endpoint setting. You can't create replica sets.
projectId string

Unique identifier for the project.

enabled bool

Flag that indicates whether the regionalized private endpoint setting is enabled for the project. Set this value to true to create more than one private endpoint in a cloud provider region to connect to multi-region and global Atlas sharded clusters. You can enable this setting only if your Atlas project contains no replica sets. You can't disable this setting if you have:

  • More than one private endpoint in more than one region, or
  • More than one private endpoint in one region and one private endpoint in one or more regions. You can create only sharded clusters when you enable the regionalized private endpoint setting. You can't create replica sets.
project_id str

Unique identifier for the project.

enabled Boolean

Flag that indicates whether the regionalized private endpoint setting is enabled for the project. Set this value to true to create more than one private endpoint in a cloud provider region to connect to multi-region and global Atlas sharded clusters. You can enable this setting only if your Atlas project contains no replica sets. You can't disable this setting if you have:

  • More than one private endpoint in more than one region, or
  • More than one private endpoint in one region and one private endpoint in one or more regions. You can create only sharded clusters when you enable the regionalized private endpoint setting. You can't create replica sets.
projectId String

Unique identifier for the project.

Package Details

Repository
MongoDB Atlas pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.