Get started with Pulumi in a free one hour introductory workshop. Register Now

NetworkPeering

Create a NetworkPeering Resource

def NetworkPeering(resource_name: str, opts: Optional[ResourceOptions] = None, accepter_region_name: Optional[str] = None, atlas_cidr_block: Optional[str] = None, atlas_gcp_project_id: Optional[str] = None, atlas_vpc_name: Optional[str] = None, aws_account_id: Optional[str] = None, azure_directory_id: Optional[str] = None, azure_subscription_id: Optional[str] = None, container_id: Optional[str] = None, gcp_project_id: Optional[str] = None, network_name: Optional[str] = None, project_id: Optional[str] = None, provider_name: Optional[str] = None, resource_group_name: Optional[str] = None, route_table_cidr_block: Optional[str] = None, vnet_name: Optional[str] = None, vpc_id: Optional[str] = None)
name string
The unique name of the resource.
args NetworkPeeringArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args NetworkPeeringArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args NetworkPeeringArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

NetworkPeering Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The NetworkPeering resource accepts the following input properties:

ContainerId string

Unique identifier of the MongoDB Atlas container for the provider (GCP) or provider/region (AWS, AZURE). You can create an MongoDB Atlas container using the network_container resource or it can be obtained from the cluster returned values if a cluster has been created before the first container.

ProjectId string

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

ProviderName string

Cloud provider to whom the peering connection is being made. (Possible Values AWS, AZURE, GCP).

AccepterRegionName string

Specifies the AWS region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.

AtlasCidrBlock string
AtlasGcpProjectId string

The Atlas GCP Project ID for the GCP VPC used by your atlas cluster that it is need to set up the reciprocal connection.

AtlasVpcName string
AwsAccountId string

AWS Account ID of the owner of the peer VPC.

AzureDirectoryId string

Unique identifier for an Azure AD directory.

AzureSubscriptionId string

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

GcpProjectId string

GCP project ID of the owner of the network peer.

NetworkName string

Name of the network peer to which Atlas connects.

ResourceGroupName string

Name of your Azure resource group.

RouteTableCidrBlock string

AWS VPC CIDR block or subnet.

VnetName string

Name of your Azure VNet.

VpcId string

Unique identifier of the AWS peer VPC (Note: this is not the same as the Atlas AWS VPC that is returned by the network_container resource).

ContainerId string

Unique identifier of the MongoDB Atlas container for the provider (GCP) or provider/region (AWS, AZURE). You can create an MongoDB Atlas container using the network_container resource or it can be obtained from the cluster returned values if a cluster has been created before the first container.

ProjectId string

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

ProviderName string

Cloud provider to whom the peering connection is being made. (Possible Values AWS, AZURE, GCP).

AccepterRegionName string

Specifies the AWS region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.

AtlasCidrBlock string
AtlasGcpProjectId string

The Atlas GCP Project ID for the GCP VPC used by your atlas cluster that it is need to set up the reciprocal connection.

AtlasVpcName string
AwsAccountId string

AWS Account ID of the owner of the peer VPC.

AzureDirectoryId string

Unique identifier for an Azure AD directory.

AzureSubscriptionId string

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

GcpProjectId string

GCP project ID of the owner of the network peer.

NetworkName string

Name of the network peer to which Atlas connects.

ResourceGroupName string

Name of your Azure resource group.

RouteTableCidrBlock string

AWS VPC CIDR block or subnet.

VnetName string

Name of your Azure VNet.

VpcId string

Unique identifier of the AWS peer VPC (Note: this is not the same as the Atlas AWS VPC that is returned by the network_container resource).

containerId string

Unique identifier of the MongoDB Atlas container for the provider (GCP) or provider/region (AWS, AZURE). You can create an MongoDB Atlas container using the network_container resource or it can be obtained from the cluster returned values if a cluster has been created before the first container.

projectId string

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

providerName string

Cloud provider to whom the peering connection is being made. (Possible Values AWS, AZURE, GCP).

accepterRegionName string

Specifies the AWS region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.

atlasCidrBlock string
atlasGcpProjectId string

The Atlas GCP Project ID for the GCP VPC used by your atlas cluster that it is need to set up the reciprocal connection.

atlasVpcName string
awsAccountId string

AWS Account ID of the owner of the peer VPC.

azureDirectoryId string

Unique identifier for an Azure AD directory.

azureSubscriptionId string

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

gcpProjectId string

GCP project ID of the owner of the network peer.

networkName string

Name of the network peer to which Atlas connects.

resourceGroupName string

Name of your Azure resource group.

routeTableCidrBlock string

AWS VPC CIDR block or subnet.

vnetName string

Name of your Azure VNet.

vpcId string

Unique identifier of the AWS peer VPC (Note: this is not the same as the Atlas AWS VPC that is returned by the network_container resource).

container_id str

Unique identifier of the MongoDB Atlas container for the provider (GCP) or provider/region (AWS, AZURE). You can create an MongoDB Atlas container using the network_container resource or it can be obtained from the cluster returned values if a cluster has been created before the first container.

project_id str

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

provider_name str

Cloud provider to whom the peering connection is being made. (Possible Values AWS, AZURE, GCP).

accepter_region_name str

Specifies the AWS region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.

atlas_cidr_block str
atlas_gcp_project_id str

The Atlas GCP Project ID for the GCP VPC used by your atlas cluster that it is need to set up the reciprocal connection.

atlas_vpc_name str
aws_account_id str

AWS 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 identifier of the Azure subscription in which the VNet resides.

gcp_project_id str

GCP project ID of the owner of the network peer.

network_name str

Name of the network peer to which Atlas connects.

resource_group_name str

Name of your Azure resource group.

route_table_cidr_block str

AWS VPC CIDR block or subnet.

vnet_name str

Name of your Azure VNet.

vpc_id str

Unique identifier of the AWS peer VPC (Note: this is not the same as the Atlas AWS VPC that is returned by the network_container resource).

Outputs

All input properties are implicitly available as output properties. Additionally, the NetworkPeering resource produces the following output properties:

AtlasId string
ConnectionId string

Unique identifier of the Atlas network peering container.

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.

Id string
The provider-assigned unique ID for this managed resource.
PeerId string

Unique identifier of the Atlas network peer.

Status string

Status of the Atlas network peering connection. Azure/GCP: ADDING_PEER, AVAILABLE, FAILED, DELETING GCP Only: WAITING_FOR_USER.

StatusName string

(AWS Only) The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.

AtlasId string
ConnectionId string

Unique identifier of the Atlas network peering container.

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.

Id string
The provider-assigned unique ID for this managed resource.
PeerId string

Unique identifier of the Atlas network peer.

Status string

Status of the Atlas network peering connection. Azure/GCP: ADDING_PEER, AVAILABLE, FAILED, DELETING GCP Only: WAITING_FOR_USER.

StatusName string

(AWS Only) The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.

atlasId string
connectionId string

Unique identifier of the Atlas network peering container.

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.

id string
The provider-assigned unique ID for this managed resource.
peerId string

Unique identifier of the Atlas network peer.

status string

Status of the Atlas network peering connection. Azure/GCP: ADDING_PEER, AVAILABLE, FAILED, DELETING GCP Only: WAITING_FOR_USER.

statusName string

(AWS Only) The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.

atlas_id str
connection_id str

Unique identifier of the Atlas network peering container.

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.

id str
The provider-assigned unique ID for this managed resource.
peer_id str

Unique identifier of the Atlas network peer.

status str

Status of the Atlas network peering connection. Azure/GCP: ADDING_PEER, AVAILABLE, FAILED, DELETING GCP Only: WAITING_FOR_USER.

status_name str

(AWS Only) The VPC peering connection status value can be one of the following: INITIATING, PENDING_ACCEPTANCE, FAILED, FINALIZING, AVAILABLE, TERMINATING.

Look up an Existing NetworkPeering Resource

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

public static get(name: string, id: Input<ID>, state?: NetworkPeeringState, opts?: CustomResourceOptions): NetworkPeering
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, accepter_region_name: Optional[str] = None, atlas_cidr_block: Optional[str] = None, atlas_gcp_project_id: Optional[str] = None, atlas_id: Optional[str] = None, atlas_vpc_name: Optional[str] = None, aws_account_id: Optional[str] = None, azure_directory_id: Optional[str] = None, azure_subscription_id: Optional[str] = None, connection_id: Optional[str] = None, container_id: Optional[str] = None, error_message: Optional[str] = None, error_state: Optional[str] = None, error_state_name: Optional[str] = None, gcp_project_id: Optional[str] = None, network_name: Optional[str] = None, peer_id: Optional[str] = None, project_id: Optional[str] = None, provider_name: Optional[str] = None, resource_group_name: Optional[str] = None, route_table_cidr_block: Optional[str] = None, status: Optional[str] = None, status_name: Optional[str] = None, vnet_name: Optional[str] = None, vpc_id: Optional[str] = None) -> NetworkPeering
func GetNetworkPeering(ctx *Context, name string, id IDInput, state *NetworkPeeringState, opts ...ResourceOption) (*NetworkPeering, error)
public static NetworkPeering Get(string name, Input<string> id, NetworkPeeringState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

AccepterRegionName string

Specifies the AWS region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.

AtlasCidrBlock string
AtlasGcpProjectId string

The Atlas GCP Project ID for the GCP VPC used by your atlas cluster that it is need to set up the reciprocal connection.

AtlasId string
AtlasVpcName string
AwsAccountId string

AWS Account ID of the owner of the peer VPC.

AzureDirectoryId string

Unique identifier for an Azure AD directory.

AzureSubscriptionId string

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

ConnectionId string

Unique identifier of the Atlas network peering container.

ContainerId string

Unique identifier of the MongoDB Atlas container for the provider (GCP) or provider/region (AWS, AZURE). You can create an MongoDB Atlas container using the network_container resource or it can be obtained from the cluster returned values if a cluster has been created before the first container.

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.

NetworkName string

Name of the network peer to which Atlas connects.

PeerId string

Unique identifier of the Atlas network peer.

ProjectId string

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

ProviderName string

Cloud provider to whom the peering connection is being made. (Possible Values AWS, AZURE, GCP).

ResourceGroupName string

Name of your Azure resource group.

RouteTableCidrBlock string

AWS VPC CIDR block or subnet.

Status string

Status of the Atlas network peering connection. Azure/GCP: ADDING_PEER, AVAILABLE, FAILED, DELETING GCP Only: WAITING_FOR_USER.

StatusName string

(AWS Only) 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 AWS peer VPC (Note: this is not the same as the Atlas AWS VPC that is returned by the network_container resource).

AccepterRegionName string

Specifies the AWS region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.

AtlasCidrBlock string
AtlasGcpProjectId string

The Atlas GCP Project ID for the GCP VPC used by your atlas cluster that it is need to set up the reciprocal connection.

AtlasId string
AtlasVpcName string
AwsAccountId string

AWS Account ID of the owner of the peer VPC.

AzureDirectoryId string

Unique identifier for an Azure AD directory.

AzureSubscriptionId string

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

ConnectionId string

Unique identifier of the Atlas network peering container.

ContainerId string

Unique identifier of the MongoDB Atlas container for the provider (GCP) or provider/region (AWS, AZURE). You can create an MongoDB Atlas container using the network_container resource or it can be obtained from the cluster returned values if a cluster has been created before the first container.

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.

NetworkName string

Name of the network peer to which Atlas connects.

PeerId string

Unique identifier of the Atlas network peer.

ProjectId string

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

ProviderName string

Cloud provider to whom the peering connection is being made. (Possible Values AWS, AZURE, GCP).

ResourceGroupName string

Name of your Azure resource group.

RouteTableCidrBlock string

AWS VPC CIDR block or subnet.

Status string

Status of the Atlas network peering connection. Azure/GCP: ADDING_PEER, AVAILABLE, FAILED, DELETING GCP Only: WAITING_FOR_USER.

StatusName string

(AWS Only) 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 AWS peer VPC (Note: this is not the same as the Atlas AWS VPC that is returned by the network_container resource).

accepterRegionName string

Specifies the AWS region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.

atlasCidrBlock string
atlasGcpProjectId string

The Atlas GCP Project ID for the GCP VPC used by your atlas cluster that it is need to set up the reciprocal connection.

atlasId string
atlasVpcName string
awsAccountId string

AWS Account ID of the owner of the peer VPC.

azureDirectoryId string

Unique identifier for an Azure AD directory.

azureSubscriptionId string

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

connectionId string

Unique identifier of the Atlas network peering container.

containerId string

Unique identifier of the MongoDB Atlas container for the provider (GCP) or provider/region (AWS, AZURE). You can create an MongoDB Atlas container using the network_container resource or it can be obtained from the cluster returned values if a cluster has been created before the first container.

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.

networkName string

Name of the network peer to which Atlas connects.

peerId string

Unique identifier of the Atlas network peer.

projectId string

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

providerName string

Cloud provider to whom the peering connection is being made. (Possible Values AWS, AZURE, GCP).

resourceGroupName string

Name of your Azure resource group.

routeTableCidrBlock string

AWS VPC CIDR block or subnet.

status string

Status of the Atlas network peering connection. Azure/GCP: ADDING_PEER, AVAILABLE, FAILED, DELETING GCP Only: WAITING_FOR_USER.

statusName string

(AWS Only) 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 AWS peer VPC (Note: this is not the same as the Atlas AWS VPC that is returned by the network_container resource).

accepter_region_name str

Specifies the AWS region where the peer VPC resides. For complete lists of supported regions, see Amazon Web Services.

atlas_cidr_block str
atlas_gcp_project_id str

The Atlas GCP Project ID for the GCP VPC used by your atlas cluster that it is need to set up the reciprocal connection.

atlas_id str
atlas_vpc_name str
aws_account_id str

AWS 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 identifier of the Azure subscription in which the VNet resides.

connection_id str

Unique identifier of the Atlas network peering container.

container_id str

Unique identifier of the MongoDB Atlas container for the provider (GCP) or provider/region (AWS, AZURE). You can create an MongoDB Atlas container using the network_container resource or it can be obtained from the cluster returned values if a cluster has been created before the first container.

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.

network_name str

Name of the network peer to which Atlas connects.

peer_id str

Unique identifier of the Atlas network peer.

project_id str

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

provider_name str

Cloud provider to whom the peering connection is being made. (Possible Values AWS, AZURE, GCP).

resource_group_name str

Name of your Azure resource group.

route_table_cidr_block str

AWS VPC CIDR block or subnet.

status str

Status of the Atlas network peering connection. Azure/GCP: ADDING_PEER, AVAILABLE, FAILED, DELETING GCP Only: WAITING_FOR_USER.

status_name str

(AWS Only) 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 AWS peer VPC (Note: this is not the same as the Atlas AWS VPC that is returned by the network_container resource).

Package Details

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