1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getNetworkContainers
MongoDB Atlas v3.14.2 published on Monday, Mar 18, 2024 by Pulumi

mongodbatlas.getNetworkContainers

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.14.2 published on Monday, Mar 18, 2024 by Pulumi

    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.

    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.getNetworkContainersOutput({
        projectId: projectId,
        providerName: providerName,
    }));
    
    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_output(project_id=project_id,
        provider_name=provider_name))
    
    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
    		}
    		_ = pulumi.All(testNetworkContainer.ProjectId, testNetworkContainer.ProviderName).ApplyT(func(_args []interface{}) (mongodbatlas.GetNetworkContainersResult, error) {
    			projectId := _args[0].(string)
    			providerName := _args[1].(*string)
    			return mongodbatlas.LookupNetworkContainersOutput(ctx, mongodbatlas.GetNetworkContainersOutputArgs{
    				ProjectId:    projectId,
    				ProviderName: providerName,
    			}, nil), nil
    		}).(mongodbatlas.GetNetworkContainersResultOutput)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var testNetworkContainer = new Mongodbatlas.NetworkContainer("testNetworkContainer", new()
        {
            ProjectId = "<YOUR-PROJECT-ID>",
            AtlasCidrBlock = "10.8.0.0/21",
            ProviderName = "AWS",
            RegionName = "US_EAST_1",
        });
    
        var testNetworkContainers = Mongodbatlas.GetNetworkContainers.Invoke(new()
        {
            ProjectId = testNetworkContainer.ProjectId,
            ProviderName = testNetworkContainer.ProviderName,
        });
    
    });
    
    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 com.pulumi.mongodbatlas.MongodbatlasFunctions;
    import com.pulumi.mongodbatlas.inputs.GetNetworkContainersArgs;
    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 testNetworkContainer = new NetworkContainer("testNetworkContainer", NetworkContainerArgs.builder()        
                .projectId("<YOUR-PROJECT-ID>")
                .atlasCidrBlock("10.8.0.0/21")
                .providerName("AWS")
                .regionName("US_EAST_1")
                .build());
    
            final var testNetworkContainers = MongodbatlasFunctions.getNetworkContainers(GetNetworkContainersArgs.builder()
                .projectId(testNetworkContainer.projectId())
                .providerName(testNetworkContainer.providerName())
                .build());
    
        }
    }
    
    resources:
      testNetworkContainer:
        type: mongodbatlas:NetworkContainer
        properties:
          projectId: <YOUR-PROJECT-ID>
          atlasCidrBlock: 10.8.0.0/21
          providerName: AWS
          regionName: US_EAST_1
    variables:
      testNetworkContainers:
        fn::invoke:
          Function: mongodbatlas:getNetworkContainers
          Arguments:
            projectId: ${testNetworkContainer.projectId}
            providerName: ${testNetworkContainer.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 LookupNetworkContainers(ctx *Context, args *LookupNetworkContainersArgs, opts ...InvokeOption) (*LookupNetworkContainersResult, error)
    func LookupNetworkContainersOutput(ctx *Context, args *LookupNetworkContainersOutputArgs, opts ...InvokeOption) LookupNetworkContainersResultOutput

    > Note: This function is named LookupNetworkContainers 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)
    }
    public static CompletableFuture<GetNetworkContainersResult> getNetworkContainers(GetNetworkContainersArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: mongodbatlas:index/getNetworkContainers:getNetworkContainers
      arguments:
        # arguments dictionary

    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.
    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.
    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.

    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 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 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.
    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<Property Map>
    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 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 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.
    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 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.

    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.14.2 published on Monday, Mar 18, 2024 by Pulumi