Class NetworkContainer

mongodbatlas..NetworkContainer provides a Network Peering Container resource. The resource lets you create, edit and delete network peering containers. The resource requires your Project ID.

IMPORTANT: This resource creates one Network Peering container into which Atlas can deploy Network Peering connections. An Atlas project can have a maximum of one container for each cloud provider. You must have either the Project Owner or Organization Owner role to successfully call this endpoint.

The following table outlines the maximum number of Network Peering containers per cloud provider:

Cloud Provider: GCP - Container Limit: One container per project.
Cloud Provider: AWS and Azure - Container Limit: 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.

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
public MyStack()
{
    var test = new Mongodbatlas.NetworkContainer(&quot;test&quot;, new Mongodbatlas.NetworkContainerArgs
    {
        AtlasCidrBlock = &quot;10.8.0.0/21&quot;,
        ProjectId = &quot;&lt;YOUR-PROJECT-ID>&quot;,
        ProviderName = &quot;AWS&quot;,
        RegionName = &quot;US_EAST_1&quot;,
    });
}

}

Example with GCP

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
public MyStack()
{
    var test = new Mongodbatlas.NetworkContainer(&quot;test&quot;, new Mongodbatlas.NetworkContainerArgs
    {
        AtlasCidrBlock = &quot;10.8.0.0/21&quot;,
        ProjectId = &quot;&lt;YOUR-PROJECT-ID>&quot;,
        ProviderName = &quot;GCP&quot;,
    });
}

}

Example with Azure

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
public MyStack()
{
    var test = new Mongodbatlas.NetworkContainer(&quot;test&quot;, new Mongodbatlas.NetworkContainerArgs
    {
        AtlasCidrBlock = &quot;10.8.0.0/21&quot;,
        ProjectId = &quot;&lt;YOUR-PROJECT-ID>&quot;,
        ProviderName = &quot;AZURE&quot;,
        Region = &quot;US_EAST_2&quot;,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

NetworkContainer

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Mongodbatlas

Assembly: Pulumi.Mongodbatlas.dll

Syntax

public class NetworkContainer : CustomResource

Constructors

View Source

NetworkContainer(String, NetworkContainerArgs, CustomResourceOptions)

Create a NetworkContainer resource with the given unique name, arguments, and options.

Declaration

public NetworkContainer(string name, NetworkContainerArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
NetworkContainerArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

AtlasCidrBlock

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.

Declaration

public Output<string> AtlasCidrBlock { get; }

Property Value

Type	Description
Output<System.String>

View Source

AzureSubscriptionId

Unique identifer of the Azure subscription in which the VNet resides.

Declaration

public Output<string> AzureSubscriptionId { get; }

Property Value

Type	Description
Output<System.String>

View Source

ContainerId

The Network Peering Container ID.

Declaration

public Output<string> ContainerId { get; }

Property Value

Type	Description
Output<System.String>

View Source

GcpProjectId

Unique identifier of the GCP project in which the Network Peering connection resides.

Declaration

public Output<string> GcpProjectId { get; }

Property Value

Type	Description
Output<System.String>

View Source

NetworkName

Name of the Network Peering connection in the Atlas project.

Declaration

public Output<string> NetworkName { get; }

Property Value

Type	Description
Output<System.String>

View Source

ProjectId

The unique ID for the project to create the database user.

Declaration

public Output<string> ProjectId { get; }

Property Value

Type	Description
Output<System.String>

View Source

ProviderName

Cloud provider for this Network Peering connection. If omitted, Atlas sets this parameter to AWS.

Declaration

public Output<string> ProviderName { get; }

Property Value

Type	Description
Output<System.String>

View Source

Provisioned

Indicates whether the project has Network Peering connections deployed in the container.

Declaration

public Output<bool> Provisioned { get; }

Property Value

Type	Description
Output<System.Boolean>

View Source

Region

The Atlas Azure region name for where this container will exist.

Declaration

public Output<string> Region { get; }

Property Value

Type	Description
Output<System.String>

View Source

RegionName

The Atlas AWS region name for where this container will exist.

Declaration

public Output<string> RegionName { get; }

Property Value

Type	Description
Output<System.String>

View Source

VnetName

The name of the Azure VNet. This value is null until you provision an Azure VNet in the container.

Declaration

public Output<string> VnetName { get; }

Property Value

Type	Description
Output<System.String>

View Source

VpcId

Unique identifier of the project’s VPC.

Declaration

public Output<string> VpcId { get; }

Property Value

Type	Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, NetworkContainerState, CustomResourceOptions)

Get an existing NetworkContainer resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static NetworkContainer Get(string name, Input<string> id, NetworkContainerState 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.
NetworkContainerState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
NetworkContainer