MongoDB Atlas

Pulumi Official
Package maintained by Pulumi
v3.3.0 published on Thursday, Mar 17, 2022 by Pulumi

getNetworkContainer

mongodbatlas.NetworkContainer describes a Network Peering Container. The resource requires your Project ID and container 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.

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

Using getNetworkContainer

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 getNetworkContainer(args: GetNetworkContainerArgs, opts?: InvokeOptions): Promise<GetNetworkContainerResult>
function getNetworkContainerOutput(args: GetNetworkContainerOutputArgs, opts?: InvokeOptions): Output<GetNetworkContainerResult>
def get_network_container(container_id: Optional[str] = None,
                          project_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetNetworkContainerResult
def get_network_container_output(container_id: Optional[pulumi.Input[str]] = None,
                          project_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetNetworkContainerResult]
func LookupNetworkContainer(ctx *Context, args *LookupNetworkContainerArgs, opts ...InvokeOption) (*LookupNetworkContainerResult, error)
func LookupNetworkContainerOutput(ctx *Context, args *LookupNetworkContainerOutputArgs, opts ...InvokeOption) LookupNetworkContainerResultOutput

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

public static class GetNetworkContainer 
{
    public static Task<GetNetworkContainerResult> InvokeAsync(GetNetworkContainerArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkContainerResult> Invoke(GetNetworkContainerInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNetworkContainerResult> getNetworkContainer(GetNetworkContainerArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: mongodbatlas:index/getNetworkContainer:getNetworkContainer
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ContainerId string

The Network Peering Container ID.

ProjectId string

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

ContainerId string

The Network Peering Container ID.

ProjectId string

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

containerId String

The Network Peering Container ID.

projectId String

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

containerId string

The Network Peering Container ID.

projectId string

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

container_id str

The Network Peering Container ID.

project_id str

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

containerId String

The Network Peering Container ID.

projectId String

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

getNetworkContainer Result

The following output properties are available:

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.

ContainerId string
GcpProjectId string

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

Id string

The provider-assigned unique ID for this managed resource.

NetworkName string

Name of the Network Peering connection in the Atlas project.

ProjectId string
ProviderName string

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

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

RegionName string

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

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.

ContainerId string
GcpProjectId string

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

Id string

The provider-assigned unique ID for this managed resource.

NetworkName string

Name of the Network Peering connection in the Atlas project.

ProjectId string
ProviderName string

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

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

RegionName string

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

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.

containerId String
gcpProjectId String

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

id String

The provider-assigned unique ID for this managed resource.

networkName String

Name of the Network Peering connection in the Atlas project.

projectId String
providerName String

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

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

regionName String

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

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.

containerId string
gcpProjectId string

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

id string

The provider-assigned unique ID for this managed resource.

networkName string

Name of the Network Peering connection in the Atlas project.

projectId string
providerName string

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

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

regionName string

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

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.

container_id str
gcp_project_id str

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

id str

The provider-assigned unique ID for this managed resource.

network_name str

Name of the Network Peering connection in the Atlas project.

project_id str
provider_name str

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

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

region_name str

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

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.

containerId String
gcpProjectId String

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

id String

The provider-assigned unique ID for this managed resource.

networkName String

Name of the Network Peering connection in the Atlas project.

projectId String
providerName String

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

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

regionName String

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

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
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.