GetNetworkPeering

mongodbatlas..NetworkPeering describes a Network Peering Connection.

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

Example Usage

Basic Example (AWS).

Coming soon!

Using GetNetworkPeering

function getNetworkPeering(args: GetNetworkPeeringArgs, opts?: InvokeOptions): Promise<GetNetworkPeeringResult>

function  get_network_peering(peering_id=None, project_id=None, opts=None)

func LookupNetworkPeering(ctx *Context, args *LookupNetworkPeeringArgs, opts ...InvokeOption) (*LookupNetworkPeeringResult, error)

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

public static class GetNetworkPeering {
    public static Task<GetNetworkPeeringResult> InvokeAsync(GetNetworkPeeringArgs args, InvokeOptions? opts = null)
}

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.

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.

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: Unique identifier for an Azure AD directory.
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: Unique identifier for an Azure AD directory.
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: Unique identifier for an Azure AD directory.
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: Unique identifier for an Azure AD directory.
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.

Package Details

Repository: https://github.com/pulumi/pulumi-mongodbatlas
License: Apache-2.0
Notes: This Pulumi package is based on the mongodbatlas Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetNetworkPeering

Example Usage

Basic Example (AWS).

Using GetNetworkPeering

GetNetworkPeering Result

Package Details

On This Page