Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

MongoDB Atlas

v3.0.1 published on Monday, Nov 1, 2021 by Pulumi

getNetworkContainers

mongodbatlas.getNetworkContainers describes all Network Peering Containers. The data source requires your Project ID.

NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.

Example Usage

Basic Example.

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var testNetworkContainer = new Mongodbatlas.NetworkContainer("testNetworkContainer", new Mongodbatlas.NetworkContainerArgs
        {
            ProjectId = "<YOUR-PROJECT-ID>",
            AtlasCidrBlock = "10.8.0.0/21",
            ProviderName = "AWS",
            RegionName = "US_EAST_1",
        });
        var testNetworkContainers = Output.Tuple(testNetworkContainer.ProjectId, testNetworkContainer.ProviderName).Apply(values =>
        {
            var projectId = values.Item1;
            var providerName = values.Item2;
            return Mongodbatlas.GetNetworkContainers.InvokeAsync(new Mongodbatlas.GetNetworkContainersArgs
            {
                ProjectId = projectId,
                ProviderName = providerName,
            });
        });
    }

}
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 {
		testNetworkContainer, err := mongodbatlas.NewNetworkContainer(ctx, "testNetworkContainer", &mongodbatlas.NetworkContainerArgs{
			ProjectId:      pulumi.String("<YOUR-PROJECT-ID>"),
			AtlasCidrBlock: pulumi.String("10.8.0.0/21"),
			ProviderName:   pulumi.String("AWS"),
			RegionName:     pulumi.String("US_EAST_1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_network_container = mongodbatlas.NetworkContainer("testNetworkContainer",
    project_id="<YOUR-PROJECT-ID>",
    atlas_cidr_block="10.8.0.0/21",
    provider_name="AWS",
    region_name="US_EAST_1")
test_network_containers = pulumi.Output.all(test_network_container.project_id, test_network_container.provider_name).apply(lambda project_id, provider_name: mongodbatlas.get_network_containers(project_id=project_id,
    provider_name=provider_name))
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const testNetworkContainer = new mongodbatlas.NetworkContainer("testNetworkContainer", {
    projectId: "<YOUR-PROJECT-ID>",
    atlasCidrBlock: "10.8.0.0/21",
    providerName: "AWS",
    regionName: "US_EAST_1",
});
const testNetworkContainers = pulumi.all([testNetworkContainer.projectId, testNetworkContainer.providerName]).apply(([projectId, providerName]) => mongodbatlas.getNetworkContainers({
    projectId: projectId,
    providerName: providerName,
}));

Using getNetworkContainers

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 getNetworkContainers(args: GetNetworkContainersArgs, opts?: InvokeOptions): Promise<GetNetworkContainersResult>
function getNetworkContainersOutput(args: GetNetworkContainersOutputArgs, opts?: InvokeOptions): Output<GetNetworkContainersResult>
def get_network_containers(project_id: Optional[str] = None,
                           provider_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetNetworkContainersResult
def get_network_containers_output(project_id: Optional[pulumi.Input[str]] = None,
                           provider_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetNetworkContainersResult]
func GetNetworkContainers(ctx *Context, args *GetNetworkContainersArgs, opts ...InvokeOption) (*GetNetworkContainersResult, error)
func GetNetworkContainersOutput(ctx *Context, args *GetNetworkContainersOutputArgs, opts ...InvokeOption) GetNetworkContainersResultOutput

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

public static class GetNetworkContainers 
{
    public static Task<GetNetworkContainersResult> InvokeAsync(GetNetworkContainersArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkContainersResult> Invoke(GetNetworkContainersInvokeArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

ProjectId string
The unique ID for the project to create the database user.
ProviderName string
Cloud provider for this Network peering container. Accepted values are AWS, GCP, and Azure.
ProjectId string
The unique ID for the project to create the database user.
ProviderName string
Cloud provider for this Network peering container. Accepted values are AWS, GCP, and Azure.
projectId string
The unique ID for the project to create the database user.
providerName string
Cloud provider for this Network peering container. Accepted values are AWS, GCP, and Azure.
project_id str
The unique ID for the project to create the database user.
provider_name str
Cloud provider for this Network peering container. Accepted values are AWS, GCP, and Azure.

getNetworkContainers Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
ProjectId string
ProviderName string
Cloud provider for this Network Peering connection. If omitted, Atlas sets this parameter to AWS.
Results List<GetNetworkContainersResult>
A list where each represents a Network Peering Container.
Id string
The provider-assigned unique ID for this managed resource.
ProjectId string
ProviderName string
Cloud provider for this Network Peering connection. If omitted, Atlas sets this parameter to AWS.
Results []GetNetworkContainersResult
A list where each represents a Network Peering Container.
id string
The provider-assigned unique ID for this managed resource.
projectId string
providerName string
Cloud provider for this Network Peering connection. If omitted, Atlas sets this parameter to AWS.
results GetNetworkContainersResult[]
A list where each represents a Network Peering Container.
id str
The provider-assigned unique ID for this managed resource.
project_id str
provider_name str
Cloud provider for this Network Peering connection. If omitted, Atlas sets this parameter to AWS.
results Sequence[GetNetworkContainersResult]
A list where each represents a Network Peering Container.

Supporting Types

GetNetworkContainersResult

AtlasCidrBlock string
CIDR block that Atlas uses for your clusters. Atlas uses the specified CIDR block for all other Network Peering connections created in the project. The Atlas CIDR block must be at least a /24 and at most a /21 in one of the following private networks.
AzureSubscriptionId string
Unique identifer of the Azure subscription in which the VNet resides.
GcpProjectId string
Unique identifier of the GCP project in which the Network Peering connection resides.
Id string
The Network Peering Container ID.
NetworkName string
Name of the Network Peering connection in the Atlas project.
ProviderName string
Cloud provider for this Network peering container. Accepted values are AWS, GCP, and Azure.
Provisioned bool
Indicates whether the project has Network Peering connections deployed in the container.
Region string
The Atlas Azure region name for where this container exists.
RegionName string
The Atlas AWS region name for where this container exists.
Regions List<string>
Atlas GCP regions where the container resides.
VnetName string
The name of the Azure VNet. This value is null until you provision an Azure VNet in the container.
VpcId string
Unique identifier of the project’s VPC.
AtlasCidrBlock string
CIDR block that Atlas uses for your clusters. Atlas uses the specified CIDR block for all other Network Peering connections created in the project. The Atlas CIDR block must be at least a /24 and at most a /21 in one of the following private networks.
AzureSubscriptionId string
Unique identifer of the Azure subscription in which the VNet resides.
GcpProjectId string
Unique identifier of the GCP project in which the Network Peering connection resides.
Id string
The Network Peering Container ID.
NetworkName string
Name of the Network Peering connection in the Atlas project.
ProviderName string
Cloud provider for this Network peering container. Accepted values are AWS, GCP, and Azure.
Provisioned bool
Indicates whether the project has Network Peering connections deployed in the container.
Region string
The Atlas Azure region name for where this container exists.
RegionName string
The Atlas AWS region name for where this container exists.
Regions []string
Atlas GCP regions where the container resides.
VnetName string
The name of the Azure VNet. This value is null until you provision an Azure VNet in the container.
VpcId string
Unique identifier of the project’s VPC.
atlasCidrBlock string
CIDR block that Atlas uses for your clusters. Atlas uses the specified CIDR block for all other Network Peering connections created in the project. The Atlas CIDR block must be at least a /24 and at most a /21 in one of the following private networks.
azureSubscriptionId string
Unique identifer of the Azure subscription in which the VNet resides.
gcpProjectId string
Unique identifier of the GCP project in which the Network Peering connection resides.
id string
The Network Peering Container ID.
networkName string
Name of the Network Peering connection in the Atlas project.
providerName string
Cloud provider for this Network peering container. Accepted values are AWS, GCP, and Azure.
provisioned boolean
Indicates whether the project has Network Peering connections deployed in the container.
region string
The Atlas Azure region name for where this container exists.
regionName string
The Atlas AWS region name for where this container exists.
regions string[]
Atlas GCP regions where the container resides.
vnetName string
The name of the Azure VNet. This value is null until you provision an Azure VNet in the container.
vpcId string
Unique identifier of the project’s VPC.
atlas_cidr_block str
CIDR block that Atlas uses for your clusters. Atlas uses the specified CIDR block for all other Network Peering connections created in the project. The Atlas CIDR block must be at least a /24 and at most a /21 in one of the following private networks.
azure_subscription_id str
Unique identifer of the Azure subscription in which the VNet resides.
gcp_project_id str
Unique identifier of the GCP project in which the Network Peering connection resides.
id str
The Network Peering Container ID.
network_name str
Name of the Network Peering connection in the Atlas project.
provider_name str
Cloud provider for this Network peering container. Accepted values are AWS, GCP, and Azure.
provisioned bool
Indicates whether the project has Network Peering connections deployed in the container.
region str
The Atlas Azure region name for where this container exists.
region_name str
The Atlas AWS region name for where this container exists.
regions Sequence[str]
Atlas GCP regions where the container resides.
vnet_name str
The name of the Azure VNet. This value is null until you provision an Azure VNet in the container.
vpc_id str
Unique identifier of the project’s VPC.

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.