doc: Improves documention on how to obtain the peering_id for `mong…

…odbatlas_network_peering` (#2488) * Improve documention how to obtain the peering id * pr comments * Update docs/resources/network_peering.md Co-authored-by: Till Backhaus <[email protected]> * Update docs/resources/network_peering.md Co-authored-by: Till Backhaus <[email protected]> --------- Co-authored-by: Till Backhaus <[email protected]> Co-authored-by: Till Backhaus <[email protected]>
mongodb · Aug 12, 2024 · 68244f2 · 68244f2
1 parent 5f715ab
commit 68244f2
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/docs/resources/network_peering.md b/docs/resources/network_peering.md
@@ -397,6 +397,12 @@ Network Peering Connections can be imported using project ID and network peering
 $ terraform import mongodbatlas_network_peering.my_peering 1112222b3bf99403840e8934-5cbf563d87d9d67253be590a-AWS
 ```
 
+Use the [MongoDB Atlas CLI][https://www.mongodb.com/docs/atlas/cli/current/command/atlas-networking-peering-list/#std-label-atlas-networking-peering-list] to obtain your `project_id` and `peering_id`. Attention gcp and azure users: The `atlas networking peering list` command returns only `AWS` peerings by default. You have to include the `--provider` parameter to list peerings for your cloud provider. Valid values are AWS, AZURE, or GCP.
+
+```
+atlas projects list
+atlas networking peering list --projectId <projectId> --provider <AZURE|GCP|AWS>
+```
 See detailed information for arguments and attributes: [MongoDB API Network Peering Connection](https://docs.atlas.mongodb.com/reference/api/vpc-create-peering-connection/)
 
 -> **NOTE:** If you need to get an existing container ID see the [How-To Guide](https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/guides/howto-guide.html).