Docs Packages
  1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getNetworkPeering
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

mongodbatlas.getNetworkPeering

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.16.2 published on Friday, Jun 21, 2024 by Pulumi
pulumi/pulumi-mongodbatlas

    mongodbatlas.NetworkPeering describes a Network Peering Connection.

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

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

    Example Usage

    Basic Example (AWS).

    import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const testNetworkPeering = new mongodbatlas.NetworkPeering("test", {
    accepterRegionName: "us-east-1",
    projectId: "<YOUR-PROJEC-ID>",
    containerId: "507f1f77bcf86cd799439011",
    providerName: "AWS",
    routeTableCidrBlock: "192.168.0.0/24",
    vpcId: "vpc-abc123abc123",
    awsAccountId: "abc123abc123",
});
const test = mongodbatlas.getNetworkPeeringOutput({
    projectId: testNetworkPeering.projectId,
    peeringId: testNetworkPeering.id,
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_network_peering = mongodbatlas.NetworkPeering("test",
    accepter_region_name="us-east-1",
    project_id="<YOUR-PROJEC-ID>",
    container_id="507f1f77bcf86cd799439011",
    provider_name="AWS",
    route_table_cidr_block="192.168.0.0/24",
    vpc_id="vpc-abc123abc123",
    aws_account_id="abc123abc123")
test = mongodbatlas.get_network_peering_output(project_id=test_network_peering.project_id,
    peering_id=test_network_peering.id)

    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 {
		testNetworkPeering, err := mongodbatlas.NewNetworkPeering(ctx, "test", &mongodbatlas.NetworkPeeringArgs{
			AccepterRegionName:  pulumi.String("us-east-1"),
			ProjectId:           pulumi.String("<YOUR-PROJEC-ID>"),
			ContainerId:         pulumi.String("507f1f77bcf86cd799439011"),
			ProviderName:        pulumi.String("AWS"),
			RouteTableCidrBlock: pulumi.String("192.168.0.0/24"),
			VpcId:               pulumi.String("vpc-abc123abc123"),
			AwsAccountId:        pulumi.String("abc123abc123"),
		})
		if err != nil {
			return err
		}
		_ = mongodbatlas.LookupNetworkPeeringOutput(ctx, mongodbatlas.GetNetworkPeeringOutputArgs{
			ProjectId: testNetworkPeering.ProjectId,
			PeeringId: testNetworkPeering.ID(),
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var testNetworkPeering = new Mongodbatlas.NetworkPeering("test", new()
    {
        AccepterRegionName = "us-east-1",
        ProjectId = "<YOUR-PROJEC-ID>",
        ContainerId = "507f1f77bcf86cd799439011",
        ProviderName = "AWS",
        RouteTableCidrBlock = "192.168.0.0/24",
        VpcId = "vpc-abc123abc123",
        AwsAccountId = "abc123abc123",
    });

    var test = Mongodbatlas.GetNetworkPeering.Invoke(new()
    {
        ProjectId = testNetworkPeering.ProjectId,
        PeeringId = testNetworkPeering.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.NetworkPeering;
import com.pulumi.mongodbatlas.NetworkPeeringArgs;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetNetworkPeeringArgs;
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 testNetworkPeering = new NetworkPeering("testNetworkPeering", NetworkPeeringArgs.builder()
            .accepterRegionName("us-east-1")
            .projectId("<YOUR-PROJEC-ID>")
            .containerId("507f1f77bcf86cd799439011")
            .providerName("AWS")
            .routeTableCidrBlock("192.168.0.0/24")
            .vpcId("vpc-abc123abc123")
            .awsAccountId("abc123abc123")
            .build());

        final var test = MongodbatlasFunctions.getNetworkPeering(GetNetworkPeeringArgs.builder()
            .projectId(testNetworkPeering.projectId())
            .peeringId(testNetworkPeering.id())
            .build());

    }
}

    resources:
  testNetworkPeering:
    type: mongodbatlas:NetworkPeering
    name: test
    properties:
      accepterRegionName: us-east-1
      projectId: <YOUR-PROJEC-ID>
      containerId: 507f1f77bcf86cd799439011
      providerName: AWS
      routeTableCidrBlock: 192.168.0.0/24
      vpcId: vpc-abc123abc123
      awsAccountId: abc123abc123
variables:
  test:
    fn::invoke:
      Function: mongodbatlas:getNetworkPeering
      Arguments:
        projectId: ${testNetworkPeering.projectId}
        peeringId: ${testNetworkPeering.id}

    Using getNetworkPeering

    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 getNetworkPeering(args: GetNetworkPeeringArgs, opts?: InvokeOptions): Promise<GetNetworkPeeringResult>
function getNetworkPeeringOutput(args: GetNetworkPeeringOutputArgs, opts?: InvokeOptions): Output<GetNetworkPeeringResult>
    def get_network_peering(peering_id: Optional[str] = None,
                        project_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetNetworkPeeringResult
def get_network_peering_output(peering_id: Optional[pulumi.Input[str]] = None,
                        project_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetNetworkPeeringResult]
    func LookupNetworkPeering(ctx *Context, args *LookupNetworkPeeringArgs, opts ...InvokeOption) (*LookupNetworkPeeringResult, error)
func LookupNetworkPeeringOutput(ctx *Context, args *LookupNetworkPeeringOutputArgs, opts ...InvokeOption) LookupNetworkPeeringResultOutput

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

    public static class GetNetworkPeering 
{
    public static Task<GetNetworkPeeringResult> InvokeAsync(GetNetworkPeeringArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkPeeringResult> Invoke(GetNetworkPeeringInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNetworkPeeringResult> getNetworkPeering(GetNetworkPeeringArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: mongodbatlas:index/getNetworkPeering:getNetworkPeering
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PeeringId string
    Atlas assigned unique ID for the peering connection.
    ProjectId string
    The unique ID for the project to create the database user.
    PeeringId string
    Atlas assigned unique ID for the peering connection.
    ProjectId string
    The unique ID for the project to create the database user.
    peeringId String
    Atlas assigned unique ID for the peering connection.
    projectId String
    The unique ID for the project to create the database user.
    peeringId string
    Atlas assigned unique ID for the peering connection.
    projectId string
    The unique ID for the project to create the database user.
    peering_id str
    Atlas assigned unique ID for the peering connection.
    project_id str
    The unique ID for the project to create the database user.
    peeringId String
    Atlas assigned unique ID for the peering connection.
    projectId String
    The unique ID for the project to create the database user.

    getNetworkPeering Result

    The following output properties are available:

    AccepterRegionName string
    Specifies the region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.
    AtlasCidrBlock string
    AtlasId string
    AwsAccountId string
    Account ID of the owner of the peer VPC.
    AzureDirectoryId string
    Unique identifier for an Azure AD directory.
    AzureSubscriptionId string
    Unique identifer of the Azure subscription in which the VNet resides.
    ConnectionId string
    Unique identifier for the peering connection.
    ContainerId string
    ErrorMessage string
    When "status" : "FAILED", Atlas provides a description of the error.
    ErrorState string
    Description of the Atlas error when status is Failed, Otherwise, Atlas returns null.
    ErrorStateName string
    Error state, if any. The VPC peering connection error state value can be one of the following: REJECTED, EXPIRED, INVALID_ARGUMENT.
    GcpProjectId string
    GCP project ID of the owner of the network peer.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkName string
    Name of the network peer to which Atlas connects.
    PeeringId string
    ProjectId string
    ProviderName string
    Cloud provider for this VPC peering connection. If omitted, Atlas sets this parameter to AWS. (Possible Values AWS, AZURE, GCP).
    ResourceGroupName string
    Name of your Azure resource group.
    RouteTableCidrBlock string
    Peer VPC CIDR block or subnet.
    Status string
    Status of the Atlas network peering connection: ADDING_PEER, AVAILABLE, FAILED, DELETING, WAITING_FOR_USER.
    StatusName string
    The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.
    VnetName string
    Name of your Azure VNet.
    VpcId string
    Unique identifier of the peer VPC.
    AccepterRegionName string
    Specifies the region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.
    AtlasCidrBlock string
    AtlasId string
    AwsAccountId string
    Account ID of the owner of the peer VPC.
    AzureDirectoryId string
    Unique identifier for an Azure AD directory.
    AzureSubscriptionId string
    Unique identifer of the Azure subscription in which the VNet resides.
    ConnectionId string
    Unique identifier for the peering connection.
    ContainerId string
    ErrorMessage string
    When "status" : "FAILED", Atlas provides a description of the error.
    ErrorState string
    Description of the Atlas error when status is Failed, Otherwise, Atlas returns null.
    ErrorStateName string
    Error state, if any. The VPC peering connection error state value can be one of the following: REJECTED, EXPIRED, INVALID_ARGUMENT.
    GcpProjectId string
    GCP project ID of the owner of the network peer.
    Id string
    The provider-assigned unique ID for this managed resource.
    NetworkName string
    Name of the network peer to which Atlas connects.
    PeeringId string
    ProjectId string
    ProviderName string
    Cloud provider for this VPC peering connection. If omitted, Atlas sets this parameter to AWS. (Possible Values AWS, AZURE, GCP).
    ResourceGroupName string
    Name of your Azure resource group.
    RouteTableCidrBlock string
    Peer VPC CIDR block or subnet.
    Status string
    Status of the Atlas network peering connection: ADDING_PEER, AVAILABLE, FAILED, DELETING, WAITING_FOR_USER.
    StatusName string
    The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.
    VnetName string
    Name of your Azure VNet.
    VpcId string
    Unique identifier of the peer VPC.
    accepterRegionName String
    Specifies the region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.
    atlasCidrBlock String
    atlasId String
    awsAccountId String
    Account ID of the owner of the peer VPC.
    azureDirectoryId String
    Unique identifier for an Azure AD directory.
    azureSubscriptionId String
    Unique identifer of the Azure subscription in which the VNet resides.
    connectionId String
    Unique identifier for the peering connection.
    containerId String
    errorMessage String
    When "status" : "FAILED", Atlas provides a description of the error.
    errorState String
    Description of the Atlas error when status is Failed, Otherwise, Atlas returns null.
    errorStateName String
    Error state, if any. The VPC peering connection error state value can be one of the following: REJECTED, EXPIRED, INVALID_ARGUMENT.
    gcpProjectId String
    GCP project ID of the owner of the network peer.
    id String
    The provider-assigned unique ID for this managed resource.
    networkName String
    Name of the network peer to which Atlas connects.
    peeringId String
    projectId String
    providerName String
    Cloud provider for this VPC peering connection. If omitted, Atlas sets this parameter to AWS. (Possible Values AWS, AZURE, GCP).
    resourceGroupName String
    Name of your Azure resource group.
    routeTableCidrBlock String
    Peer VPC CIDR block or subnet.
    status String
    Status of the Atlas network peering connection: ADDING_PEER, AVAILABLE, FAILED, DELETING, WAITING_FOR_USER.
    statusName String
    The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.
    vnetName String
    Name of your Azure VNet.
    vpcId String
    Unique identifier of the peer VPC.
    accepterRegionName string
    Specifies the region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.
    atlasCidrBlock string
    atlasId string
    awsAccountId string
    Account ID of the owner of the peer VPC.
    azureDirectoryId string
    Unique identifier for an Azure AD directory.
    azureSubscriptionId string
    Unique identifer of the Azure subscription in which the VNet resides.
    connectionId string
    Unique identifier for the peering connection.
    containerId string
    errorMessage string
    When "status" : "FAILED", Atlas provides a description of the error.
    errorState string
    Description of the Atlas error when status is Failed, Otherwise, Atlas returns null.
    errorStateName string
    Error state, if any. The VPC peering connection error state value can be one of the following: REJECTED, EXPIRED, INVALID_ARGUMENT.
    gcpProjectId string
    GCP project ID of the owner of the network peer.
    id string
    The provider-assigned unique ID for this managed resource.
    networkName string
    Name of the network peer to which Atlas connects.
    peeringId string
    projectId string
    providerName string
    Cloud provider for this VPC peering connection. If omitted, Atlas sets this parameter to AWS. (Possible Values AWS, AZURE, GCP).
    resourceGroupName string
    Name of your Azure resource group.
    routeTableCidrBlock string
    Peer VPC CIDR block or subnet.
    status string
    Status of the Atlas network peering connection: ADDING_PEER, AVAILABLE, FAILED, DELETING, WAITING_FOR_USER.
    statusName string
    The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.
    vnetName string
    Name of your Azure VNet.
    vpcId string
    Unique identifier of the peer VPC.
    accepter_region_name str
    Specifies the region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.
    atlas_cidr_block str
    atlas_id str
    aws_account_id str
    Account ID of the owner of the peer VPC.
    azure_directory_id str
    Unique identifier for an Azure AD directory.
    azure_subscription_id str
    Unique identifer of the Azure subscription in which the VNet resides.
    connection_id str
    Unique identifier for the peering connection.
    container_id str
    error_message str
    When "status" : "FAILED", Atlas provides a description of the error.
    error_state str
    Description of the Atlas error when status is Failed, Otherwise, Atlas returns null.
    error_state_name str
    Error state, if any. The VPC peering connection error state value can be one of the following: REJECTED, EXPIRED, INVALID_ARGUMENT.
    gcp_project_id str
    GCP project ID of the owner of the network peer.
    id str
    The provider-assigned unique ID for this managed resource.
    network_name str
    Name of the network peer to which Atlas connects.
    peering_id str
    project_id str
    provider_name str
    Cloud provider for this VPC peering connection. If omitted, Atlas sets this parameter to AWS. (Possible Values AWS, AZURE, GCP).
    resource_group_name str
    Name of your Azure resource group.
    route_table_cidr_block str
    Peer VPC CIDR block or subnet.
    status str
    Status of the Atlas network peering connection: ADDING_PEER, AVAILABLE, FAILED, DELETING, WAITING_FOR_USER.
    status_name str
    The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.
    vnet_name str
    Name of your Azure VNet.
    vpc_id str
    Unique identifier of the peer VPC.
    accepterRegionName String
    Specifies the region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.
    atlasCidrBlock String
    atlasId String
    awsAccountId String
    Account ID of the owner of the peer VPC.
    azureDirectoryId String
    Unique identifier for an Azure AD directory.
    azureSubscriptionId String
    Unique identifer of the Azure subscription in which the VNet resides.
    connectionId String
    Unique identifier for the peering connection.
    containerId String
    errorMessage String
    When "status" : "FAILED", Atlas provides a description of the error.
    errorState String
    Description of the Atlas error when status is Failed, Otherwise, Atlas returns null.
    errorStateName String
    Error state, if any. The VPC peering connection error state value can be one of the following: REJECTED, EXPIRED, INVALID_ARGUMENT.
    gcpProjectId String
    GCP project ID of the owner of the network peer.
    id String
    The provider-assigned unique ID for this managed resource.
    networkName String
    Name of the network peer to which Atlas connects.
    peeringId String
    projectId String
    providerName String
    Cloud provider for this VPC peering connection. If omitted, Atlas sets this parameter to AWS. (Possible Values AWS, AZURE, GCP).
    resourceGroupName String
    Name of your Azure resource group.
    routeTableCidrBlock String
    Peer VPC CIDR block or subnet.
    status String
    Status of the Atlas network peering connection: ADDING_PEER, AVAILABLE, FAILED, DELETING, WAITING_FOR_USER.
    statusName String
    The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.
    vnetName String
    Name of your Azure VNet.
    vpcId String
    Unique identifier of the peer 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.16.2 published on Friday, Jun 21, 2024 by Pulumi
    pulumi/pulumi-mongodbatlas