1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. NetworkContainer
MongoDB Atlas v3.16.1 published on Saturday, Jun 15, 2024 by Pulumi

mongodbatlas.NetworkContainer

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.1 published on Saturday, Jun 15, 2024 by Pulumi

    mongodbatlas.NetworkContainer provides a Network Peering Container resource. The resource lets you create, edit and delete network peering containers. You must delete network peering containers before creating clusters in your project. You can’t delete a network peering container if your project contains clusters. The resource requires your Project ID. Each cloud provider requires slightly different attributes so read the argument reference carefully.

    Network peering container is a general term used to describe any cloud providers’ VPC/VNet concept. Containers only need to be created if the peering connection to the cloud provider will be created before the first cluster that requires the container. If the cluster has been/will be created first Atlas automatically creates the required container per the “containers per cloud provider” information that follows (in this case you can obtain the container id from the cluster resource attribute container_id).

    The following is the maximum number of Network Peering containers per cloud provider:
    • GCP - One container per project.
    • AWS and Azure - One container per cloud provider region.

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

    Example Usage

    Example with AWS

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const test = new mongodbatlas.NetworkContainer("test", {
        projectId: "<YOUR-PROJECT-ID>",
        atlasCidrBlock: "10.8.0.0/21",
        providerName: "AWS",
        regionName: "US_EAST_1",
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test = mongodbatlas.NetworkContainer("test",
        project_id="<YOUR-PROJECT-ID>",
        atlas_cidr_block="10.8.0.0/21",
        provider_name="AWS",
        region_name="US_EAST_1")
    
    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 {
    		_, err := mongodbatlas.NewNetworkContainer(ctx, "test", &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
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Mongodbatlas.NetworkContainer("test", new()
        {
            ProjectId = "<YOUR-PROJECT-ID>",
            AtlasCidrBlock = "10.8.0.0/21",
            ProviderName = "AWS",
            RegionName = "US_EAST_1",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mongodbatlas.NetworkContainer;
    import com.pulumi.mongodbatlas.NetworkContainerArgs;
    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) {
            var test = new NetworkContainer("test", NetworkContainerArgs.builder()
                .projectId("<YOUR-PROJECT-ID>")
                .atlasCidrBlock("10.8.0.0/21")
                .providerName("AWS")
                .regionName("US_EAST_1")
                .build());
    
        }
    }
    
    resources:
      test:
        type: mongodbatlas:NetworkContainer
        properties:
          projectId: <YOUR-PROJECT-ID>
          atlasCidrBlock: 10.8.0.0/21
          providerName: AWS
          regionName: US_EAST_1
    

    Example with GCP

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const test = new mongodbatlas.NetworkContainer("test", {
        projectId: "<YOUR-PROJECT-ID>",
        atlasCidrBlock: "10.8.0.0/21",
        providerName: "GCP",
        regions: [
            "US_EAST_4",
            "US_WEST_3",
        ],
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test = mongodbatlas.NetworkContainer("test",
        project_id="<YOUR-PROJECT-ID>",
        atlas_cidr_block="10.8.0.0/21",
        provider_name="GCP",
        regions=[
            "US_EAST_4",
            "US_WEST_3",
        ])
    
    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 {
    		_, err := mongodbatlas.NewNetworkContainer(ctx, "test", &mongodbatlas.NetworkContainerArgs{
    			ProjectId:      pulumi.String("<YOUR-PROJECT-ID>"),
    			AtlasCidrBlock: pulumi.String("10.8.0.0/21"),
    			ProviderName:   pulumi.String("GCP"),
    			Regions: pulumi.StringArray{
    				pulumi.String("US_EAST_4"),
    				pulumi.String("US_WEST_3"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Mongodbatlas.NetworkContainer("test", new()
        {
            ProjectId = "<YOUR-PROJECT-ID>",
            AtlasCidrBlock = "10.8.0.0/21",
            ProviderName = "GCP",
            Regions = new[]
            {
                "US_EAST_4",
                "US_WEST_3",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mongodbatlas.NetworkContainer;
    import com.pulumi.mongodbatlas.NetworkContainerArgs;
    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) {
            var test = new NetworkContainer("test", NetworkContainerArgs.builder()
                .projectId("<YOUR-PROJECT-ID>")
                .atlasCidrBlock("10.8.0.0/21")
                .providerName("GCP")
                .regions(            
                    "US_EAST_4",
                    "US_WEST_3")
                .build());
    
        }
    }
    
    resources:
      test:
        type: mongodbatlas:NetworkContainer
        properties:
          projectId: <YOUR-PROJECT-ID>
          atlasCidrBlock: 10.8.0.0/21
          providerName: GCP
          regions:
            - US_EAST_4
            - US_WEST_3
    

    Example with Azure

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const test = new mongodbatlas.NetworkContainer("test", {
        projectId: "<YOUR-PROJECT-ID>",
        atlasCidrBlock: "10.8.0.0/21",
        providerName: "AZURE",
        region: "US_EAST_2",
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    test = mongodbatlas.NetworkContainer("test",
        project_id="<YOUR-PROJECT-ID>",
        atlas_cidr_block="10.8.0.0/21",
        provider_name="AZURE",
        region="US_EAST_2")
    
    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 {
    		_, err := mongodbatlas.NewNetworkContainer(ctx, "test", &mongodbatlas.NetworkContainerArgs{
    			ProjectId:      pulumi.String("<YOUR-PROJECT-ID>"),
    			AtlasCidrBlock: pulumi.String("10.8.0.0/21"),
    			ProviderName:   pulumi.String("AZURE"),
    			Region:         pulumi.String("US_EAST_2"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Mongodbatlas.NetworkContainer("test", new()
        {
            ProjectId = "<YOUR-PROJECT-ID>",
            AtlasCidrBlock = "10.8.0.0/21",
            ProviderName = "AZURE",
            Region = "US_EAST_2",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mongodbatlas.NetworkContainer;
    import com.pulumi.mongodbatlas.NetworkContainerArgs;
    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) {
            var test = new NetworkContainer("test", NetworkContainerArgs.builder()
                .projectId("<YOUR-PROJECT-ID>")
                .atlasCidrBlock("10.8.0.0/21")
                .providerName("AZURE")
                .region("US_EAST_2")
                .build());
    
        }
    }
    
    resources:
      test:
        type: mongodbatlas:NetworkContainer
        properties:
          projectId: <YOUR-PROJECT-ID>
          atlasCidrBlock: 10.8.0.0/21
          providerName: AZURE
          region: US_EAST_2
    

    Create NetworkContainer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NetworkContainer(name: string, args: NetworkContainerArgs, opts?: CustomResourceOptions);
    @overload
    def NetworkContainer(resource_name: str,
                         args: NetworkContainerArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def NetworkContainer(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         atlas_cidr_block: Optional[str] = None,
                         project_id: Optional[str] = None,
                         provider_name: Optional[str] = None,
                         region: Optional[str] = None,
                         region_name: Optional[str] = None,
                         regions: Optional[Sequence[str]] = None)
    func NewNetworkContainer(ctx *Context, name string, args NetworkContainerArgs, opts ...ResourceOption) (*NetworkContainer, error)
    public NetworkContainer(string name, NetworkContainerArgs args, CustomResourceOptions? opts = null)
    public NetworkContainer(String name, NetworkContainerArgs args)
    public NetworkContainer(String name, NetworkContainerArgs args, CustomResourceOptions options)
    
    type: mongodbatlas:NetworkContainer
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Example

    The following reference example uses placeholder values for all input properties.

    var networkContainerResource = new Mongodbatlas.NetworkContainer("networkContainerResource", new()
    {
        AtlasCidrBlock = "string",
        ProjectId = "string",
        ProviderName = "string",
        Region = "string",
        RegionName = "string",
        Regions = new[]
        {
            "string",
        },
    });
    
    example, err := mongodbatlas.NewNetworkContainer(ctx, "networkContainerResource", &mongodbatlas.NetworkContainerArgs{
    	AtlasCidrBlock: pulumi.String("string"),
    	ProjectId:      pulumi.String("string"),
    	ProviderName:   pulumi.String("string"),
    	Region:         pulumi.String("string"),
    	RegionName:     pulumi.String("string"),
    	Regions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var networkContainerResource = new NetworkContainer("networkContainerResource", NetworkContainerArgs.builder()
        .atlasCidrBlock("string")
        .projectId("string")
        .providerName("string")
        .region("string")
        .regionName("string")
        .regions("string")
        .build());
    
    network_container_resource = mongodbatlas.NetworkContainer("networkContainerResource",
        atlas_cidr_block="string",
        project_id="string",
        provider_name="string",
        region="string",
        region_name="string",
        regions=["string"])
    
    const networkContainerResource = new mongodbatlas.NetworkContainer("networkContainerResource", {
        atlasCidrBlock: "string",
        projectId: "string",
        providerName: "string",
        region: "string",
        regionName: "string",
        regions: ["string"],
    });
    
    type: mongodbatlas:NetworkContainer
    properties:
        atlasCidrBlock: string
        projectId: string
        providerName: string
        region: string
        regionName: string
        regions:
            - string
    

    NetworkContainer 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 NetworkContainer resource accepts the following input properties:

    AtlasCidrBlock string

    CIDR block that Atlas uses for the Network Peering containers in your project. 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:

    • Lower bound: 10.0.0.0 - Upper bound: 10.255.255.255 - Prefix: 10/8
    • Lower bound: 172.16.0.0 - Upper bound:172.31.255.255 - Prefix: 172.16/12
    • Lower bound: 192.168.0.0 - Upper bound:192.168.255.255 - Prefix: 192.168/16

    Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other Network Peering connections in the project.

    Important: Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per Network Peering connection.

    ProjectId string
    Unique identifier for the Atlas project for this Network Peering Container.
    ProviderName string
    Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.
    Region string
    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.
    RegionName string
    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.
    Regions List<string>
    Atlas regions where the container resides. Provide this field only if you provide an atlas_cidr_block smaller than /18. GCP Regions values.
    AtlasCidrBlock string

    CIDR block that Atlas uses for the Network Peering containers in your project. 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:

    • Lower bound: 10.0.0.0 - Upper bound: 10.255.255.255 - Prefix: 10/8
    • Lower bound: 172.16.0.0 - Upper bound:172.31.255.255 - Prefix: 172.16/12
    • Lower bound: 192.168.0.0 - Upper bound:192.168.255.255 - Prefix: 192.168/16

    Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other Network Peering connections in the project.

    Important: Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per Network Peering connection.

    ProjectId string
    Unique identifier for the Atlas project for this Network Peering Container.
    ProviderName string
    Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.
    Region string
    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.
    RegionName string
    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.
    Regions []string
    Atlas regions where the container resides. Provide this field only if you provide an atlas_cidr_block smaller than /18. GCP Regions values.
    atlasCidrBlock String

    CIDR block that Atlas uses for the Network Peering containers in your project. 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:

    • Lower bound: 10.0.0.0 - Upper bound: 10.255.255.255 - Prefix: 10/8
    • Lower bound: 172.16.0.0 - Upper bound:172.31.255.255 - Prefix: 172.16/12
    • Lower bound: 192.168.0.0 - Upper bound:192.168.255.255 - Prefix: 192.168/16

    Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other Network Peering connections in the project.

    Important: Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per Network Peering connection.

    projectId String
    Unique identifier for the Atlas project for this Network Peering Container.
    providerName String
    Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.
    region String
    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.
    regionName String
    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.
    regions List<String>
    Atlas regions where the container resides. Provide this field only if you provide an atlas_cidr_block smaller than /18. GCP Regions values.
    atlasCidrBlock string

    CIDR block that Atlas uses for the Network Peering containers in your project. 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:

    • Lower bound: 10.0.0.0 - Upper bound: 10.255.255.255 - Prefix: 10/8
    • Lower bound: 172.16.0.0 - Upper bound:172.31.255.255 - Prefix: 172.16/12
    • Lower bound: 192.168.0.0 - Upper bound:192.168.255.255 - Prefix: 192.168/16

    Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other Network Peering connections in the project.

    Important: Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per Network Peering connection.

    projectId string
    Unique identifier for the Atlas project for this Network Peering Container.
    providerName string
    Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.
    region string
    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.
    regionName string
    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.
    regions string[]
    Atlas regions where the container resides. Provide this field only if you provide an atlas_cidr_block smaller than /18. GCP Regions values.
    atlas_cidr_block str

    CIDR block that Atlas uses for the Network Peering containers in your project. 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:

    • Lower bound: 10.0.0.0 - Upper bound: 10.255.255.255 - Prefix: 10/8
    • Lower bound: 172.16.0.0 - Upper bound:172.31.255.255 - Prefix: 172.16/12
    • Lower bound: 192.168.0.0 - Upper bound:192.168.255.255 - Prefix: 192.168/16

    Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other Network Peering connections in the project.

    Important: Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per Network Peering connection.

    project_id str
    Unique identifier for the Atlas project for this Network Peering Container.
    provider_name str
    Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.
    region str
    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.
    region_name str
    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.
    regions Sequence[str]
    Atlas regions where the container resides. Provide this field only if you provide an atlas_cidr_block smaller than /18. GCP Regions values.
    atlasCidrBlock String

    CIDR block that Atlas uses for the Network Peering containers in your project. 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:

    • Lower bound: 10.0.0.0 - Upper bound: 10.255.255.255 - Prefix: 10/8
    • Lower bound: 172.16.0.0 - Upper bound:172.31.255.255 - Prefix: 172.16/12
    • Lower bound: 192.168.0.0 - Upper bound:192.168.255.255 - Prefix: 192.168/16

    Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other Network Peering connections in the project.

    Important: Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per Network Peering connection.

    projectId String
    Unique identifier for the Atlas project for this Network Peering Container.
    providerName String
    Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.
    region String
    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.
    regionName String
    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.
    regions List<String>
    Atlas regions where the container resides. Provide this field only if you provide an atlas_cidr_block smaller than /18. GCP Regions values.

    Outputs

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

    AzureSubscriptionId string
    Unique identifier of the Azure subscription in which the VNet resides.
    ContainerId string
    The Network Peering Container ID.
    GcpProjectId string
    Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkName string
    Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    Provisioned bool
    Indicates whether the project has Network Peering connections deployed in the container.
    VnetName string
    The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    VpcId string
    Unique identifier of Atlas' AWS VPC.
    AzureSubscriptionId string
    Unique identifier of the Azure subscription in which the VNet resides.
    ContainerId string
    The Network Peering Container ID.
    GcpProjectId string
    Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkName string
    Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    Provisioned bool
    Indicates whether the project has Network Peering connections deployed in the container.
    VnetName string
    The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    VpcId string
    Unique identifier of Atlas' AWS VPC.
    azureSubscriptionId String
    Unique identifier of the Azure subscription in which the VNet resides.
    containerId String
    The Network Peering Container ID.
    gcpProjectId String
    Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    id String
    The provider-assigned unique ID for this managed resource.
    networkName String
    Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    provisioned Boolean
    Indicates whether the project has Network Peering connections deployed in the container.
    vnetName String
    The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    vpcId String
    Unique identifier of Atlas' AWS VPC.
    azureSubscriptionId string
    Unique identifier of the Azure subscription in which the VNet resides.
    containerId string
    The Network Peering Container ID.
    gcpProjectId string
    Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    id string
    The provider-assigned unique ID for this managed resource.
    networkName string
    Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    provisioned boolean
    Indicates whether the project has Network Peering connections deployed in the container.
    vnetName string
    The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    vpcId string
    Unique identifier of Atlas' AWS VPC.
    azure_subscription_id str
    Unique identifier of the Azure subscription in which the VNet resides.
    container_id str
    The Network Peering Container ID.
    gcp_project_id str
    Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    id str
    The provider-assigned unique ID for this managed resource.
    network_name str
    Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    provisioned bool
    Indicates whether the project has Network Peering connections deployed in the container.
    vnet_name str
    The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    vpc_id str
    Unique identifier of Atlas' AWS VPC.
    azureSubscriptionId String
    Unique identifier of the Azure subscription in which the VNet resides.
    containerId String
    The Network Peering Container ID.
    gcpProjectId String
    Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    id String
    The provider-assigned unique ID for this managed resource.
    networkName String
    Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    provisioned Boolean
    Indicates whether the project has Network Peering connections deployed in the container.
    vnetName String
    The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    vpcId String
    Unique identifier of Atlas' AWS VPC.

    Look up Existing NetworkContainer Resource

    Get an existing NetworkContainer 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?: NetworkContainerState, opts?: CustomResourceOptions): NetworkContainer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            atlas_cidr_block: Optional[str] = None,
            azure_subscription_id: Optional[str] = None,
            container_id: Optional[str] = None,
            gcp_project_id: Optional[str] = None,
            network_name: Optional[str] = None,
            project_id: Optional[str] = None,
            provider_name: Optional[str] = None,
            provisioned: Optional[bool] = None,
            region: Optional[str] = None,
            region_name: Optional[str] = None,
            regions: Optional[Sequence[str]] = None,
            vnet_name: Optional[str] = None,
            vpc_id: Optional[str] = None) -> NetworkContainer
    func GetNetworkContainer(ctx *Context, name string, id IDInput, state *NetworkContainerState, opts ...ResourceOption) (*NetworkContainer, error)
    public static NetworkContainer Get(string name, Input<string> id, NetworkContainerState? state, CustomResourceOptions? opts = null)
    public static NetworkContainer get(String name, Output<String> id, NetworkContainerState 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:
    AtlasCidrBlock string

    CIDR block that Atlas uses for the Network Peering containers in your project. 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:

    • Lower bound: 10.0.0.0 - Upper bound: 10.255.255.255 - Prefix: 10/8
    • Lower bound: 172.16.0.0 - Upper bound:172.31.255.255 - Prefix: 172.16/12
    • Lower bound: 192.168.0.0 - Upper bound:192.168.255.255 - Prefix: 192.168/16

    Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other Network Peering connections in the project.

    Important: Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per Network Peering connection.

    AzureSubscriptionId string
    Unique identifier of the Azure subscription in which the VNet resides.
    ContainerId string
    The Network Peering Container ID.
    GcpProjectId string
    Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    NetworkName string
    Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    ProjectId string
    Unique identifier for the Atlas project for this Network Peering Container.
    ProviderName string
    Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.
    Provisioned bool
    Indicates whether the project has Network Peering connections deployed in the container.
    Region string
    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.
    RegionName string
    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.
    Regions List<string>
    Atlas regions where the container resides. Provide this field only if you provide an atlas_cidr_block smaller than /18. GCP Regions values.
    VnetName string
    The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    VpcId string
    Unique identifier of Atlas' AWS VPC.
    AtlasCidrBlock string

    CIDR block that Atlas uses for the Network Peering containers in your project. 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:

    • Lower bound: 10.0.0.0 - Upper bound: 10.255.255.255 - Prefix: 10/8
    • Lower bound: 172.16.0.0 - Upper bound:172.31.255.255 - Prefix: 172.16/12
    • Lower bound: 192.168.0.0 - Upper bound:192.168.255.255 - Prefix: 192.168/16

    Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other Network Peering connections in the project.

    Important: Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per Network Peering connection.

    AzureSubscriptionId string
    Unique identifier of the Azure subscription in which the VNet resides.
    ContainerId string
    The Network Peering Container ID.
    GcpProjectId string
    Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    NetworkName string
    Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    ProjectId string
    Unique identifier for the Atlas project for this Network Peering Container.
    ProviderName string
    Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.
    Provisioned bool
    Indicates whether the project has Network Peering connections deployed in the container.
    Region string
    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.
    RegionName string
    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.
    Regions []string
    Atlas regions where the container resides. Provide this field only if you provide an atlas_cidr_block smaller than /18. GCP Regions values.
    VnetName string
    The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    VpcId string
    Unique identifier of Atlas' AWS VPC.
    atlasCidrBlock String

    CIDR block that Atlas uses for the Network Peering containers in your project. 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:

    • Lower bound: 10.0.0.0 - Upper bound: 10.255.255.255 - Prefix: 10/8
    • Lower bound: 172.16.0.0 - Upper bound:172.31.255.255 - Prefix: 172.16/12
    • Lower bound: 192.168.0.0 - Upper bound:192.168.255.255 - Prefix: 192.168/16

    Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other Network Peering connections in the project.

    Important: Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per Network Peering connection.

    azureSubscriptionId String
    Unique identifier of the Azure subscription in which the VNet resides.
    containerId String
    The Network Peering Container ID.
    gcpProjectId String
    Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    networkName String
    Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    projectId String
    Unique identifier for the Atlas project for this Network Peering Container.
    providerName String
    Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.
    provisioned Boolean
    Indicates whether the project has Network Peering connections deployed in the container.
    region String
    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.
    regionName String
    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.
    regions List<String>
    Atlas regions where the container resides. Provide this field only if you provide an atlas_cidr_block smaller than /18. GCP Regions values.
    vnetName String
    The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    vpcId String
    Unique identifier of Atlas' AWS VPC.
    atlasCidrBlock string

    CIDR block that Atlas uses for the Network Peering containers in your project. 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:

    • Lower bound: 10.0.0.0 - Upper bound: 10.255.255.255 - Prefix: 10/8
    • Lower bound: 172.16.0.0 - Upper bound:172.31.255.255 - Prefix: 172.16/12
    • Lower bound: 192.168.0.0 - Upper bound:192.168.255.255 - Prefix: 192.168/16

    Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other Network Peering connections in the project.

    Important: Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per Network Peering connection.

    azureSubscriptionId string
    Unique identifier of the Azure subscription in which the VNet resides.
    containerId string
    The Network Peering Container ID.
    gcpProjectId string
    Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    networkName string
    Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    projectId string
    Unique identifier for the Atlas project for this Network Peering Container.
    providerName string
    Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.
    provisioned boolean
    Indicates whether the project has Network Peering connections deployed in the container.
    region string
    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.
    regionName string
    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.
    regions string[]
    Atlas regions where the container resides. Provide this field only if you provide an atlas_cidr_block smaller than /18. GCP Regions values.
    vnetName string
    The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    vpcId string
    Unique identifier of Atlas' AWS VPC.
    atlas_cidr_block str

    CIDR block that Atlas uses for the Network Peering containers in your project. 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:

    • Lower bound: 10.0.0.0 - Upper bound: 10.255.255.255 - Prefix: 10/8
    • Lower bound: 172.16.0.0 - Upper bound:172.31.255.255 - Prefix: 172.16/12
    • Lower bound: 192.168.0.0 - Upper bound:192.168.255.255 - Prefix: 192.168/16

    Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other Network Peering connections in the project.

    Important: Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per Network Peering connection.

    azure_subscription_id str
    Unique identifier of the Azure subscription in which the VNet resides.
    container_id str
    The Network Peering Container ID.
    gcp_project_id str
    Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    network_name str
    Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    project_id str
    Unique identifier for the Atlas project for this Network Peering Container.
    provider_name str
    Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.
    provisioned bool
    Indicates whether the project has Network Peering connections deployed in the container.
    region str
    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.
    region_name str
    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.
    regions Sequence[str]
    Atlas regions where the container resides. Provide this field only if you provide an atlas_cidr_block smaller than /18. GCP Regions values.
    vnet_name str
    The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    vpc_id str
    Unique identifier of Atlas' AWS VPC.
    atlasCidrBlock String

    CIDR block that Atlas uses for the Network Peering containers in your project. 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:

    • Lower bound: 10.0.0.0 - Upper bound: 10.255.255.255 - Prefix: 10/8
    • Lower bound: 172.16.0.0 - Upper bound:172.31.255.255 - Prefix: 172.16/12
    • Lower bound: 192.168.0.0 - Upper bound:192.168.255.255 - Prefix: 192.168/16

    Atlas locks this value if an M10+ cluster or a Network Peering connection already exists. To modify the CIDR block, ensure there are no M10+ clusters in the project and no other Network Peering connections in the project.

    Important: Atlas limits the number of MongoDB nodes per Network Peering connection based on the CIDR block and the region selected for the project. Contact MongoDB Support for any questions on Atlas limits of MongoDB nodes per Network Peering connection.

    azureSubscriptionId String
    Unique identifier of the Azure subscription in which the VNet resides.
    containerId String
    The Network Peering Container ID.
    gcpProjectId String
    Unique identifier of the GCP project in which the network peer resides. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    networkName String
    Unique identifier of the Network Peering connection in the Atlas project. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    projectId String
    Unique identifier for the Atlas project for this Network Peering Container.
    providerName String
    Cloud provider for this Network Peering connection. Accepted values are GCP, AWS, AZURE. If omitted, Atlas sets this parameter to AWS.
    provisioned Boolean
    Indicates whether the project has Network Peering connections deployed in the container.
    region String
    Atlas region where the container resides, see the reference list for Atlas Azure region names Azure.
    regionName String
    The Atlas AWS region name for where this container will exist, see the reference list for Atlas AWS region names AWS.
    regions List<String>
    Atlas regions where the container resides. Provide this field only if you provide an atlas_cidr_block smaller than /18. GCP Regions values.
    vnetName String
    The name of the Azure VNet. Returns null. This value is populated once you create a new network peering connection with the network peering resource.
    vpcId String
    Unique identifier of Atlas' AWS VPC.

    Import

    Network Peering Containers can be imported using project ID and network peering container id, in the format PROJECTID-CONTAINER-ID, e.g.

    $ pulumi import mongodbatlas:index/networkContainer:NetworkContainer my_container 1112222b3bf99403840e8934-5cbf563d87d9d67253be590a
    

    See detailed information for arguments and attributes: MongoDB API Network Peering Container

    -> NOTE: If you need to get an existing container ID see the How-To Guide.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.16.1 published on Saturday, Jun 15, 2024 by Pulumi