Class PrivateIpMode
mongodbatlas..PrivateIpMode provides a Private IP Mode resource. This allows one to disable Connect via Peering Only mode for a MongoDB Atlas Project.
Deprecated Feature: <br> This feature has been deprecated. Use Split Horizon connection strings to connect to your cluster. These connection strings allow you to connect using both VPC/VNet Peering and whitelisted public IP addresses. To learn more about support for Split Horizon, see this FAQ. You need this endpoint to disable Peering Only.
Example Usage
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
class MyStack : Stack
{
public MyStack()
{
var myPrivateIpMode = new Mongodbatlas.PrivateIpMode("myPrivateIpMode", new Mongodbatlas.PrivateIpModeArgs
{
Enabled = false,
ProjectId = "<YOUR PROJECT ID>",
});
}
}
Inherited Members
Namespace: Pulumi.Mongodbatlas
Assembly: Pulumi.Mongodbatlas.dll
Syntax
public class PrivateIpMode : CustomResource
Constructors
View SourcePrivateIpMode(String, PrivateIpModeArgs, CustomResourceOptions)
Create a PrivateIpMode resource with the given unique name, arguments, and options.
Declaration
public PrivateIpMode(string name, PrivateIpModeArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| PrivateIpModeArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceEnabled
Indicates whether Connect via Peering Only mode is enabled or disabled for an Atlas project
Declaration
public Output<bool> Enabled { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Boolean> |
ProjectId
The unique ID for the project to enable Only Private IP Mode.
Declaration
public Output<string> ProjectId { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Methods
View SourceGet(String, Input<String>, PrivateIpModeState, CustomResourceOptions)
Get an existing PrivateIpMode resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static PrivateIpMode Get(string name, Input<string> id, PrivateIpModeState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| PrivateIpModeState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| PrivateIpMode |