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

mongodbatlas.getControlPlaneIpAddresses

Explore with Pulumi AI

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

# Data Source: mongodbatlas.getControlPlaneIpAddresses

mongodbatlas.getControlPlaneIpAddresses returns all control plane IP addresses.

Example Usage

S

import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

export = async () => {
    const test = await mongodbatlas.getControlPlaneIpAddresses({});
    return {
        "outbound-aws-ip-addresses": test.outbound?.aws,
    };
}
Copy
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_control_plane_ip_addresses()
pulumi.export("outbound-aws-ip-addresses", test.outbound.aws)
Copy
package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := mongodbatlas.GetControlPlaneIpAddresses(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		ctx.Export("outbound-aws-ip-addresses", test.Outbound.Aws)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test = Mongodbatlas.GetControlPlaneIpAddresses.Invoke();

    return new Dictionary<string, object?>
    {
        ["outbound-aws-ip-addresses"] = test.Apply(getControlPlaneIpAddressesResult => getControlPlaneIpAddressesResult.Outbound?.Aws),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
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) {
        final var test = MongodbatlasFunctions.getControlPlaneIpAddresses();

        ctx.export("outbound-aws-ip-addresses", test.applyValue(getControlPlaneIpAddressesResult -> getControlPlaneIpAddressesResult.outbound().aws()));
    }
}
Copy
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getControlPlaneIpAddresses
      arguments: {}
outputs:
  outbound-aws-ip-addresses: ${test.outbound.aws}
Copy

Using getControlPlaneIpAddresses

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 getControlPlaneIpAddresses(opts?: InvokeOptions): Promise<GetControlPlaneIpAddressesResult>
function getControlPlaneIpAddressesOutput(opts?: InvokeOptions): Output<GetControlPlaneIpAddressesResult>
Copy
def get_control_plane_ip_addresses(opts: Optional[InvokeOptions] = None) -> GetControlPlaneIpAddressesResult
def get_control_plane_ip_addresses_output(opts: Optional[InvokeOptions] = None) -> Output[GetControlPlaneIpAddressesResult]
Copy
func GetControlPlaneIpAddresses(ctx *Context, opts ...InvokeOption) (*GetControlPlaneIpAddressesResult, error)
func GetControlPlaneIpAddressesOutput(ctx *Context, opts ...InvokeOption) GetControlPlaneIpAddressesResultOutput
Copy

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

public static class GetControlPlaneIpAddresses 
{
    public static Task<GetControlPlaneIpAddressesResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetControlPlaneIpAddressesResult> Invoke(InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetControlPlaneIpAddressesResult> getControlPlaneIpAddresses(InvokeOptions options)
public static Output<GetControlPlaneIpAddressesResult> getControlPlaneIpAddresses(InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getControlPlaneIpAddresses:getControlPlaneIpAddresses
  arguments:
    # arguments dictionary
Copy

getControlPlaneIpAddresses Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
Inbound GetControlPlaneIpAddressesInbound
List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.
Outbound GetControlPlaneIpAddressesOutbound
List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.
Id string
The provider-assigned unique ID for this managed resource.
Inbound GetControlPlaneIpAddressesInbound
List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.
Outbound GetControlPlaneIpAddressesOutbound
List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.
id String
The provider-assigned unique ID for this managed resource.
inbound GetControlPlaneIpAddressesInbound
List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.
outbound GetControlPlaneIpAddressesOutbound
List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.
id string
The provider-assigned unique ID for this managed resource.
inbound GetControlPlaneIpAddressesInbound
List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.
outbound GetControlPlaneIpAddressesOutbound
List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.
id str
The provider-assigned unique ID for this managed resource.
inbound GetControlPlaneIpAddressesInbound
List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.
outbound GetControlPlaneIpAddressesOutbound
List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.
id String
The provider-assigned unique ID for this managed resource.
inbound Property Map
List of inbound IP addresses to the Atlas control plane, categorized by cloud provider. If your application allows outbound HTTP requests only to specific IP addresses, you must allow access to the following IP addresses so that your API requests can reach the Atlas control plane.
outbound Property Map
List of outbound IP addresses from the Atlas control plane, categorized by cloud provider. If your network allows inbound HTTP requests only from specific IP addresses, you must allow access from the following IP addresses so that Atlas can communicate with your webhooks and KMS.

Supporting Types

GetControlPlaneIpAddressesInbound

Aws This property is required. Dictionary<string, ImmutableArray<string>>
Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.
Azure This property is required. Dictionary<string, ImmutableArray<string>>
Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.
Gcp This property is required. Dictionary<string, ImmutableArray<string>>
Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.
Aws This property is required. map[string][]string
Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.
Azure This property is required. map[string][]string
Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.
Gcp This property is required. map[string][]string
Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.
aws This property is required. Map<String,List<String>>
Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.
azure This property is required. Map<String,List<String>>
Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.
gcp This property is required. Map<String,List<String>>
Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.
aws This property is required. {[key: string]: string[]}
Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.
azure This property is required. {[key: string]: string[]}
Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.
gcp This property is required. {[key: string]: string[]}
Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.
aws This property is required. Mapping[str, Sequence[str]]
Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.
azure This property is required. Mapping[str, Sequence[str]]
Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.
gcp This property is required. Mapping[str, Sequence[str]]
Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.
aws This property is required. Map<List<String>>
Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.
azure This property is required. Map<List<String>>
Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.
gcp This property is required. Map<List<String>>
Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.

GetControlPlaneIpAddressesOutbound

Aws This property is required. Dictionary<string, ImmutableArray<string>>
Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.
Azure This property is required. Dictionary<string, ImmutableArray<string>>
Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.
Gcp This property is required. Dictionary<string, ImmutableArray<string>>
Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.
Aws This property is required. map[string][]string
Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.
Azure This property is required. map[string][]string
Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.
Gcp This property is required. map[string][]string
Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.
aws This property is required. Map<String,List<String>>
Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.
azure This property is required. Map<String,List<String>>
Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.
gcp This property is required. Map<String,List<String>>
Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.
aws This property is required. {[key: string]: string[]}
Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.
azure This property is required. {[key: string]: string[]}
Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.
gcp This property is required. {[key: string]: string[]}
Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.
aws This property is required. Mapping[str, Sequence[str]]
Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.
azure This property is required. Mapping[str, Sequence[str]]
Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.
gcp This property is required. Mapping[str, Sequence[str]]
Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.
aws This property is required. Map<List<String>>
Control plane IP addresses in AWS. Each key identifies an Amazon Web Services (AWS) region. Each value identifies control plane IP addresses in the AWS region.
azure This property is required. Map<List<String>>
Control plane IP addresses in Azure. Each key identifies an Azure region. Each value identifies control plane IP addresses in the Azure region.
gcp This property is required. Map<List<String>>
Control plane IP addresses in GCP. Each key identifies a Google Cloud (GCP) region. Each value identifies control plane IP addresses in the GCP region.

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