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:
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>",
});
}
}
Coming soon!
import pulumi
import pulumi_mongodbatlas as mongodbatlas
my_private_ip_mode = mongodbatlas.PrivateIpMode("myPrivateIpMode",
enabled=False,
project_id="<YOUR PROJECT ID>")import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const myPrivateIpMode = new mongodbatlas.PrivateIpMode("my_private_ip_mode", {
enabled: false,
projectId: "<YOUR PROJECT ID>",
});Create a PrivateIpMode Resource
new PrivateIpMode(name: string, args: PrivateIpModeArgs, opts?: CustomResourceOptions);def PrivateIpMode(resource_name, opts=None, enabled=None, project_id=None, __props__=None);func NewPrivateIpMode(ctx *Context, name string, args PrivateIpModeArgs, opts ...ResourceOption) (*PrivateIpMode, error)public PrivateIpMode(string name, PrivateIpModeArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args PrivateIpModeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args PrivateIpModeArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PrivateIpModeArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
PrivateIpMode Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The PrivateIpMode resource accepts the following input properties:
- enabled bool
Indicates whether Connect via Peering Only mode is enabled or disabled for an Atlas project
- project_
id str The unique ID for the project to enable Only Private IP Mode.
Outputs
All input properties are implicitly available as output properties. Additionally, the PrivateIpMode resource produces the following output properties:
Look up an Existing PrivateIpMode Resource
Get an existing PrivateIpMode 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?: PrivateIpModeState, opts?: CustomResourceOptions): PrivateIpModestatic get(resource_name, id, opts=None, enabled=None, project_id=None, __props__=None);func GetPrivateIpMode(ctx *Context, name string, id IDInput, state *PrivateIpModeState, opts ...ResourceOption) (*PrivateIpMode, error)public static PrivateIpMode Get(string name, Input<string> id, PrivateIpModeState? state, CustomResourceOptions? opts = null)- 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.
The following state arguments are supported:
- enabled bool
Indicates whether Connect via Peering Only mode is enabled or disabled for an Atlas project
- project_
id str The unique ID for the project to enable Only Private IP Mode.
Package Details
- Repository
- https://github.com/pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlasTerraform Provider.