You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/data-sources/mongodb_instance.md
+16-16Lines changed: 16 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
---
2
-
subcategory: "MongoDB"
2
+
subcategory: "MongoDB™"
3
3
page_title: "Scaleway: scaleway_mongodb_instance"
4
4
---
5
5
6
6
# scaleway_mongodb_instance
7
7
8
-
Gets information about a MongoDB Instance.
8
+
Gets information about a MongoDB™ Instance.
9
9
10
-
For further information refer to the Managed Databases for MongoDB [API documentation](https://developers.scaleway.com/en/products/mongodb/api/)
10
+
For further information refer to the Managed Databases for MongoDB™[API documentation](https://developers.scaleway.com/en/products/mongodb/api/)
11
11
12
12
## Example Usage
13
13
@@ -31,31 +31,31 @@ output "mongodb_version" {
31
31
32
32
## Argument Reference
33
33
34
-
-`name` - (Optional) The name of the MongoDB instance.
34
+
-`name` - (Optional) The name of the MongoDB™ instance.
35
35
36
-
-`instance_id` - (Optional) The MongoDB instance ID.
36
+
-`instance_id` - (Optional) The MongoDB™ instance ID.
37
37
38
38
-> **Note** You must specify at least one: `name` or `instance_id`.
39
39
40
-
-`project_id` - (Optional) The ID of the project the MongoDB instance is in. Can be used to filter instances when using `name`.
40
+
-`project_id` - (Optional) The ID of the project the MongoDB™ instance is in. Can be used to filter instances when using `name`.
41
41
42
-
-`region` - (Defaults to [provider](../index.md#region)`region`) The [region](../guides/regions_and_zones.md#zones) in which the MongoDB Instance exists.
42
+
-`region` - (Defaults to [provider](../index.md#region)`region`) The [region](../guides/regions_and_zones.md#zones) in which the MongoDB™ Instance exists.
43
43
44
-
-`organization_id` - (Defaults to [provider](../index.md#organization_id)`organization_id`) The ID of the organization the MongoDB instance is in.
44
+
-`organization_id` - (Defaults to [provider](../index.md#organization_id)`organization_id`) The ID of the organization the MongoDB™ instance is in.
45
45
46
46
## Attributes Reference
47
47
48
48
In addition to all above arguments, the following attributes are exported:
49
49
50
-
-`id` - The ID of the MongoDB Instance.
51
-
-`name` - The name of the MongoDB instance.
52
-
-`version` - The version of MongoDB running on the instance.
53
-
-`node_type` - The type of MongoDB node.
54
-
-`node_number` - The number of nodes in the MongoDB cluster.
55
-
-`created_at` - The date and time the MongoDB instance was created.
50
+
-`id` - The ID of the MongoDB™ Instance.
51
+
-`name` - The name of the MongoDB™ instance.
52
+
-`version` - The version of MongoDB™ running on the instance.
53
+
-`node_type` - The type of MongoDB™ node.
54
+
-`node_number` - The number of nodes in the MongoDB™ cluster.
55
+
-`created_at` - The date and time the MongoDB™ instance was created.
56
56
-`project_id` - The ID of the project the instance belongs to.
57
-
-`tags` - A list of tags attached to the MongoDB instance.
58
-
-`volume_type` - The type of volume attached to the MongoDB instance.
57
+
-`tags` - A list of tags attached to the MongoDB™ instance.
58
+
-`volume_type` - The type of volume attached to the MongoDB™ instance.
59
59
-`volume_size_in_gb` - The size of the attached volume, in GB.
60
60
-`public_network` - The details of the public network configuration, if applicable.
-`instance_id` - (Required) The ID of the MongoDB instance from which the snapshot was created.
28
+
-`instance_id` - (Required) The ID of the MongoDB™ instance from which the snapshot was created.
29
29
30
-
-`name` - (Optional) The name of the MongoDB snapshot.
30
+
-`name` - (Optional) The name of the MongoDB™ snapshot.
31
31
32
-
-`expires_at` - (Required) The expiration date of the MongoDB snapshot in ISO 8601 format (e.g. `2024-12-31T23:59:59Z`).
32
+
-`expires_at` - (Required) The expiration date of the MongoDB™ snapshot in ISO 8601 format (e.g. `2024-12-31T23:59:59Z`).
33
33
34
34
~> **Important:** Once set, `expires_at` cannot be removed.
35
35
36
-
-`region` - (Defaults to [provider](../index.md)`region`) The [region](../guides/regions_and_zones.md#regions) in which the MongoDB snapshot should be created.
36
+
-`region` - (Defaults to [provider](../index.md)`region`) The [region](../guides/regions_and_zones.md#regions) in which the MongoDB™ snapshot should be created.
37
37
38
38
## Attributes Reference
39
39
40
40
In addition to all arguments above, the following attributes are exported:
41
41
42
-
-`id` - The unique identifier of the MongoDB snapshot.
42
+
-`id` - The unique identifier of the MongoDB™ snapshot.
43
43
44
-
-`instance_name` - The name of the MongoDB instance from which the snapshot was created.
44
+
-`instance_name` - The name of the MongoDB™ instance from which the snapshot was created.
45
45
46
-
-`size` - The size of the MongoDB snapshot in bytes.
46
+
-`size` - The size of the MongoDB™ snapshot in bytes.
47
47
48
-
-`node_type` - The type of node associated with the MongoDB snapshot.
48
+
-`node_type` - The type of node associated with the MongoDB™ snapshot.
49
49
50
-
-`volume_type` - The type of volume used for the MongoDB snapshot.
50
+
-`volume_type` - The type of volume used for the MongoDB™ snapshot.
51
51
52
-
-`created_at` - The date and time when the MongoDB snapshot was created.
52
+
-`created_at` - The date and time when the MongoDB™ snapshot was created.
53
53
54
-
-`updated_at` - The date and time of the last update of the MongoDB snapshot.
54
+
-`updated_at` - The date and time of the last update of the MongoDB™ snapshot.
55
55
56
56
## Import
57
57
58
-
MongoDB snapshots can be imported using the `{region}/{id}`, e.g.
58
+
MongoDB™ snapshots can be imported using the `{region}/{id}`, e.g.
0 commit comments