NetworkPeering

Create a NetworkPeering Resource

new NetworkPeering(name: string, args: NetworkPeeringArgs, opts?: CustomResourceOptions);

def NetworkPeering(resource_name, opts=None, accepter_region_name=None, atlas_cidr_block=None, atlas_gcp_project_id=None, atlas_vpc_name=None, aws_account_id=None, azure_directory_id=None, azure_subscription_id=None, container_id=None, gcp_project_id=None, network_name=None, project_id=None, provider_name=None, resource_group_name=None, route_table_cidr_block=None, vnet_name=None, vpc_id=None, __props__=None);

func NewNetworkPeering(ctx *Context, name string, args NetworkPeeringArgs, opts ...ResourceOption) (*NetworkPeering, error)

public NetworkPeering(string name, NetworkPeeringArgs args, CustomResourceOptions? opts = null)

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 Atlas VPC container for the region. You can create an Atlas VPC container using the Create Container endpoint. You cannot create more than one container per region. To retrieve a list of container IDs, use the Get list of VPC containers endpoint.
ProjectId string: The unique ID for the project to create the database user.
ProviderName string: Cloud provider for this VPC peering connection. (Possible Values AWS, AZURE, GCP).
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.
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: The Atlas VPC Name is used by your atlas clister that it is need to set up the reciprocal connection.
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.
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: Peer VPC CIDR block or subnet.
VnetName string: Name of your Azure VNet.
VpcId string: Unique identifier of the peer VPC.

ContainerId string: Unique identifier of the Atlas VPC container for the region. You can create an Atlas VPC container using the Create Container endpoint. You cannot create more than one container per region. To retrieve a list of container IDs, use the Get list of VPC containers endpoint.
ProjectId string: The unique ID for the project to create the database user.
ProviderName string: Cloud provider for this VPC peering connection. (Possible Values AWS, AZURE, GCP).
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.
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: The Atlas VPC Name is used by your atlas clister that it is need to set up the reciprocal connection.
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.
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: Peer VPC CIDR block or subnet.
VnetName string: Name of your Azure VNet.
VpcId string: Unique identifier of the peer VPC.

containerId string: Unique identifier of the Atlas VPC container for the region. You can create an Atlas VPC container using the Create Container endpoint. You cannot create more than one container per region. To retrieve a list of container IDs, use the Get list of VPC containers endpoint.
projectId string: The unique ID for the project to create the database user.
providerName string: Cloud provider for this VPC peering connection. (Possible Values AWS, AZURE, GCP).
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.
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: The Atlas VPC Name is used by your atlas clister that it is need to set up the reciprocal connection.
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.
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: Peer VPC CIDR block or subnet.
vnetName string: Name of your Azure VNet.
vpcId string: Unique identifier of the peer VPC.

container_id str: Unique identifier of the Atlas VPC container for the region. You can create an Atlas VPC container using the Create Container endpoint. You cannot create more than one container per region. To retrieve a list of container IDs, use the Get list of VPC containers endpoint.
project_id str: The unique ID for the project to create the database user.
provider_name str: Cloud provider for this VPC peering connection. (Possible Values AWS, AZURE, GCP).
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_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: The Atlas VPC Name is used by your atlas clister that it is need to set up the reciprocal connection.
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.
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: Peer VPC CIDR block or subnet.
vnet_name str: Name of your Azure VNet.
vpc_id str: Unique identifier of the peer VPC.

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 for the peering connection.
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: The Network Peering Container ID.
Status string: (Azure/GCP Only) 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 for the peering connection.
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: The Network Peering Container ID.
Status string: (Azure/GCP Only) 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 for the peering connection.
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: The Network Peering Container ID.
status string: (Azure/GCP Only) 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 for the peering connection.
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: The Network Peering Container ID.
status str: (Azure/GCP Only) 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

static get(resource_name, id, opts=None, accepter_region_name=None, atlas_cidr_block=None, atlas_gcp_project_id=None, atlas_id=None, atlas_vpc_name=None, aws_account_id=None, azure_directory_id=None, azure_subscription_id=None, connection_id=None, container_id=None, error_message=None, error_state=None, error_state_name=None, gcp_project_id=None, network_name=None, peer_id=None, project_id=None, provider_name=None, resource_group_name=None, route_table_cidr_block=None, status=None, status_name=None, vnet_name=None, vpc_id=None, __props__=None);

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 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.
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: The Atlas VPC Name is used by your atlas clister that it is need to set up the reciprocal connection.
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: Unique identifier of the Atlas VPC container for the region. You can create an Atlas VPC container using the Create Container endpoint. You cannot create more than one container per region. To retrieve a list of container IDs, use the Get list of VPC containers endpoint.
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: The Network Peering Container ID.
ProjectId string: The unique ID for the project to create the database user.
ProviderName string: Cloud provider for this VPC peering connection. (Possible Values AWS, AZURE, GCP).
ResourceGroupName string: Name of your Azure resource group.
RouteTableCidrBlock string: Peer VPC CIDR block or subnet.
Status string: (Azure/GCP Only) 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 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.
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: The Atlas VPC Name is used by your atlas clister that it is need to set up the reciprocal connection.
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: Unique identifier of the Atlas VPC container for the region. You can create an Atlas VPC container using the Create Container endpoint. You cannot create more than one container per region. To retrieve a list of container IDs, use the Get list of VPC containers endpoint.
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: The Network Peering Container ID.
ProjectId string: The unique ID for the project to create the database user.
ProviderName string: Cloud provider for this VPC peering connection. (Possible Values AWS, AZURE, GCP).
ResourceGroupName string: Name of your Azure resource group.
RouteTableCidrBlock string: Peer VPC CIDR block or subnet.
Status string: (Azure/GCP Only) 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 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.
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: The Atlas VPC Name is used by your atlas clister that it is need to set up the reciprocal connection.
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: Unique identifier of the Atlas VPC container for the region. You can create an Atlas VPC container using the Create Container endpoint. You cannot create more than one container per region. To retrieve a list of container IDs, use the Get list of VPC containers endpoint.
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: The Network Peering Container ID.
projectId string: The unique ID for the project to create the database user.
providerName string: Cloud provider for this VPC peering connection. (Possible Values AWS, AZURE, GCP).
resourceGroupName string: Name of your Azure resource group.
routeTableCidrBlock string: Peer VPC CIDR block or subnet.
status string: (Azure/GCP Only) 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 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_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: The Atlas VPC Name is used by your atlas clister that it is need to set up the reciprocal connection.
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: Unique identifier of the Atlas VPC container for the region. You can create an Atlas VPC container using the Create Container endpoint. You cannot create more than one container per region. To retrieve a list of container IDs, use the Get list of VPC containers endpoint.
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: The Network Peering Container ID.
project_id str: The unique ID for the project to create the database user.
provider_name str: Cloud provider for this VPC peering connection. (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: (Azure/GCP Only) 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 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