Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
560 changes: 405 additions & 155 deletions docs/data-sources/advanced_cluster.md

Large diffs are not rendered by default.

5 changes: 1 addition & 4 deletions docs/data-sources/alert_configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,6 @@ data "mongodbatlas_alert_configuration" "test" {
* `project_id` - (Required) The ID of the project where the alert configuration will create.
* `alert_configuration_id` - (Required) Unique identifier for the alert configuration.
* `output` - (Optional) List of formatted output requested for this alert configuration
* `output.#.type` - (Required) If the output is requested, you must specify its type. The format is computed as `output.#.value`, the following are the supported types:
- `resource_hcl`: This string is used to define the resource as it exists in MongoDB Atlas.
- `resource_import`: This string is used to import the existing resource into the state file.

## Attributes Reference

Expand All @@ -120,7 +117,7 @@ In addition to all arguments above, the following attributes are exported:
* `matcher` - Rules to apply when matching an object against this alert configuration. See [matchers](#matchers).
* `metric_threshold_config` - The threshold that causes an alert to be triggered. Required if `event_type_name` : `OUTSIDE_METRIC_THRESHOLD` or `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`. See [metric threshold config](#metric-threshold-config).
* `threshold_config` - Threshold that triggers an alert. Required if `event_type_name` is any value other than `OUTSIDE_METRIC_THRESHOLD` or `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`. See [threshold config](#threshold-config).
* `notifications` - List of notifications to send when an alert condition is detected. See [notifications](#notifications).
* `notification` - List of notifications to send when an alert condition is detected. See [notification](#notification).
* `severity_override` - Severity of the event.

-> ***IMPORTANT:*** Event Type has many possible values. Details for both conditional and metric based alerts can be found by selecting the tabs on the [alert config page](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/operation/operation-createalertconfiguration) and checking the latest eventTypeName options.
Expand Down
2 changes: 1 addition & 1 deletion docs/data-sources/alert_configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ In addition to all arguments above, the following attributes are exported:
* `matcher` - Rules to apply when matching an object against this alert configuration. See [matchers](#matchers).
* `metric_threshold_config` - The threshold that causes an alert to be triggered. Required if `event_type_name` : `OUTSIDE_METRIC_THRESHOLD` or `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`. See [metric threshold config](#metric-threshold-config).
* `threshold_config` - Threshold that triggers an alert. Required if `event_type_name` is any value other than `OUTSIDE_METRIC_THRESHOLD` or `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`. See [threshold config](#threshold-config).
* `notifications` - List of notifications to send when an alert condition is detected. See [notifications](#notifications).
* `notification` - List of notifications to send when an alert condition is detected. See [notification](#notification).
* `severity_override` - Severity of the event.
* `output` - Requested output string format for the alert configuration

Expand Down
1 change: 0 additions & 1 deletion docs/data-sources/backup_compliance_policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,6 @@ In addition to all arguments above, the following attributes are exported:
* `copy_protection_enabled` - Flag that indicates whether to enable additional backup copies for the cluster. If unspecified, this value defaults to false.
* `pit_enabled` - Flag that indicates whether the cluster uses Continuous Cloud Backups with a Backup Compliance Policy. If unspecified, this value defaults to false.
* `encryption_at_rest_enabled` - Flag that indicates whether Encryption at Rest using Customer Key Management is required for all clusters with a Backup Compliance Policy. If unspecified, this value defaults to false.
* `reference_minute_of_hour` - Integer between 0 and 59 representing which minute of the referenceHourOfDay that Atlas takes the snapshot.
* `restore_window_days` - Number of previous days that you can restore back to with Continuous Cloud Backup with a Backup Compliance Policy. You must specify a positive, non-zero integer, and the maximum retention window can't exceed the hourly retention time. This parameter applies only to Continuous Cloud Backups with a Backup Compliance Policy.
* `state` - Label that indicates the state of the Backup Compliance Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
* `updated_date` - ISO 8601 timestamp format in UTC that indicates when the user updated the Data Protection Policy settings. MongoDB Cloud ignores this setting when you enable or update the Backup Compliance Policy settings.
Expand Down
3 changes: 1 addition & 2 deletions docs/data-sources/cloud_backup_snapshot_export_buckets.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ data "mongodbatlas_cloud_backup_snapshot_export_buckets" "test" {

In addition to all arguments above, the following attributes are exported:

* `links` - One or more links to sub-resources and/or related resources.
* `results` - Includes CloudProviderSnapshotExportBucket object for each item detailed in the results array section.
* `totalCount` - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
* `total_count` - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.


### CloudProviderSnapshotExportBucket
Expand Down
17 changes: 7 additions & 10 deletions docs/data-sources/cloud_backup_snapshot_export_job.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,17 @@ In addition to all arguments above, the following attributes are exported:
* `custom_data` - Custom data to include in the metadata file named `.complete` that Atlas uploads to the bucket when the export job finishes. Custom data can be specified as key and value pairs.
* `components` - _Returned for sharded clusters only._ Export job details for each replica set in the sharded cluster.
* `created_at` - Timestamp in ISO 8601 date and time format in UTC when the export job was created.
* `export_status` - Status of the export job.
* `export_status_exported_collections` - _Returned for replica set only._ Number of collections that have been exported.
* `export_status_total_collections` - _Returned for replica set only._ Total number of collections to export.
* `finished_at` - Timestamp in ISO 8601 date and time format in UTC when the export job completes.
* `export_job_id` - Unique identifier of the export job.
* `prefix ` - Full path on the cloud provider bucket to the folder where the snapshot is exported. The path is in the following format:`/exported_snapshots/{ORG-NAME}/{PROJECT-NAME}/{CLUSTER-NAME}/{SNAPSHOT-INITIATION-DATE}/{TIMESTAMP}`
* `state` - Status of the export job. Value can be one of the following:
* `Queued` - indicates that the export job is queued
* `InProgress` - indicates that the snapshot is being exported
* `Successful` - indicates that the export job has completed successfully
* `Failed` - indicates that the export job has failed
* `Cancelled` - indicates that the export job has cancelled
* "Queued" - indicates that the export job is queued
* "InProgress" - indicates that the snapshot is being exported
* "Successful" - indicates that the export job has completed successfully
* "Failed" - indicates that the export job has failed
* "Cancelled" - indicates that the export job has cancelled

### Custom Data
* `key` - Custom data specified as key in the key and value pair.
Expand All @@ -72,9 +73,5 @@ In addition to all arguments above, the following attributes are exported:
* `export_id` - _Returned for sharded clusters only._ Export job details for each replica set in the sharded cluster.
* `replica_set_name` - _Returned for sharded clusters only._ Unique identifier of the export job for the replica set.

### export_status
* `exported_collections` - _Returned for replica set only._ Number of collections that have been exported.
* `total_collections` - _Returned for replica set only._ Total number of collections to export.


For more information see: [MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/cloud-backup/export/get-one-export-job/)
21 changes: 8 additions & 13 deletions docs/data-sources/cloud_backup_snapshot_export_jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,29 +49,28 @@ data "mongodbatlas_cloud_backup_snapshot_export_jobs" "test" {

In addition to all arguments above, the following attributes are exported:

* `links` - One or more links to sub-resources and/or related resources.
* `results` - Includes CloudProviderSnapshotExportJob object for each item detailed in the results array section.
* `totalCount` - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
* `total_count` - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.


### CloudProviderSnapshotExportJob
* `project_id` - The unique identifier of the project for the Atlas cluster.
* `export_job_id` - Unique identifier of the S3 bucket.
* `snapshot_id` - Unique identifier of the Cloud Backup snapshot to export.
* `export_bucket_id` - Unique identifier of the AWS bucket to export the Cloud Backup snapshot to.
* `custom_data` - Custom data to include in the metadata file named `.complete` that Atlas uploads to the bucket when the export job finishes. Custom data can be specified as key and value pairs.
* `components` - _Returned for sharded clusters only._ Export job details for each replica set in the sharded cluster.
* `created_at` - Timestamp in ISO 8601 date and time format in UTC when the export job was created.
* `export_status` - Status of the export job.
* `export_status_exported_collections` - _Returned for replica set only._ Number of collections that have been exported.
* `export_status_total_collections` - _Returned for replica set only._ Total number of collections to export.
* `finished_at` - Timestamp in ISO 8601 date and time format in UTC when the export job completes.
* `export_job_id` - Unique identifier of the export job.
* `prefix ` - Full path on the cloud provider bucket to the folder where the snapshot is exported. The path is in the following format:`/exported_snapshots/{ORG-NAME}/{PROJECT-NAME}/{CLUSTER-NAME}/{SNAPSHOT-INITIATION-DATE}/{TIMESTAMP}`
* `state` - Status of the export job. Value can be one of the following:
* `Queued` - indicates that the export job is queued
* `InProgress` - indicates that the snapshot is being exported
* `Successful` - indicates that the export job has completed successfully
* `Failed` - indicates that the export job has failed
* `Cancelled` - indicates that the export job has cancelled
* "Queued" - indicates that the export job is queued
* "InProgress" - indicates that the snapshot is being exported
* "Successful" - indicates that the export job has completed successfully
* "Failed" - indicates that the export job has failed
* "Cancelled" - indicates that the export job has cancelled

#### Custom Data
* `key` - Custom data specified as key in the key and value pair.
Expand All @@ -81,10 +80,6 @@ In addition to all arguments above, the following attributes are exported:
* `export_id` - _Returned for sharded clusters only._ Export job details for each replica set in the sharded cluster.
* `replica_set_name` - _Returned for sharded clusters only._ Unique identifier of the export job for the replica set.

#### export_status
* `exported_collections` - _Returned for replica set only._ Number of collections that have been exported.
* `total_collections` - _Returned for replica set only._ Total number of collections to export.




Expand Down
7 changes: 3 additions & 4 deletions docs/data-sources/cloud_backup_snapshot_restore_job.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ data "mongodbatlas_cloud_backup_snapshot_restore_job" "test" {
In addition to all arguments above, the following attributes are exported:

* `cancelled` - Indicates whether the restore job was canceled.
* `created_at` - UTC ISO 8601 formatted point in time when Atlas created the restore job.
* `delivery_type` - Type of restore job to create. Possible values are: automated and download.
* `delivery_url` - One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
* `expired` - Indicates whether the restore job expired.
Expand All @@ -60,8 +59,8 @@ In addition to all arguments above, the following attributes are exported:
* `target_project_id` - Name of the target Atlas project of the restore job. Only visible if deliveryType is automated.
* `target_cluster_name` - Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
* `timestamp` - Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
* `oplogTs` - Timestamp in the number of seconds that have elapsed since the UNIX epoch.
* `oplogInc` - Oplog operation number from which to you want to restore this snapshot.
* `pointInTimeUTCSeconds` - Timestamp in the number of seconds that have elapsed since the UNIX epoch.
* `oplog_ts` - Timestamp in the number of seconds that have elapsed since the UNIX epoch.
* `oplog_inc` - Oplog operation number from which to you want to restore this snapshot.
* `point_in_time_utc_seconds` - Timestamp in the number of seconds that have elapsed since the UNIX epoch.

For more information see: [MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/cloud-backup/restore/get-one-restore-job/)
9 changes: 4 additions & 5 deletions docs/data-sources/cloud_backup_snapshot_restore_jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,11 @@ data "mongodbatlas_cloud_backup_snapshot_restore_jobs" "test" {
In addition to all arguments above, the following attributes are exported:

* `results` - Includes cloudProviderSnapshotRestoreJob object for each item detailed in the results array section.
* `totalCount` - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
* `total_count` - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

### CloudProviderSnapshotRestoreJob

* `cancelled` - Indicates whether the restore job was canceled.
* `created_at` - UTC ISO 8601 formatted point in time when Atlas created the restore job.
* `delivery_type` - Type of restore job to create. Possible values are: automated and download.
* `delivery_url` - One or more URLs for the compressed snapshot files for manual download. Only visible if deliveryType is download.
* `expired` - Indicates whether the restore job expired.
Expand All @@ -67,9 +66,9 @@ In addition to all arguments above, the following attributes are exported:
* `target_project_id` - Name of the target Atlas project of the restore job. Only visible if deliveryType is automated.
* `target_cluster_name` - Name of the target Atlas cluster to which the restore job restores the snapshot. Only visible if deliveryType is automated.
* `timestamp` - Timestamp in ISO 8601 date and time format in UTC when the snapshot associated to snapshotId was taken.
* `oplogTs` - Timestamp in the number of seconds that have elapsed since the UNIX epoch.
* `oplogInc` - Oplog operation number from which to you want to restore this snapshot.
* `pointInTimeUTCSeconds` - Timestamp in the number of seconds that have elapsed since the UNIX epoch.
* `oplog_ts` - Timestamp in the number of seconds that have elapsed since the UNIX epoch.
* `oplog_inc` - Oplog operation number from which to you want to restore this snapshot.
* `point_in_time_utc_seconds` - Timestamp in the number of seconds that have elapsed since the UNIX epoch.


For more information see: [MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/cloud-backup/restore/get-all-restore-jobs/)
8 changes: 4 additions & 4 deletions docs/data-sources/cloud_backup_snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ subcategory: "Cloud Backups"

```terraform
resource "mongodbatlas_cloud_backup_snapshots" "test" {
group_id = "5d0f1f73cf09a29120e173cf"
project_id = "5d0f1f73cf09a29120e173cf"
cluster_name = "MyClusterTest"
description = "SomeDescription"
retention_in_days = 1
}

data "mongodbatlas_cloud_backup_snapshots" "test" {
group_id = mongodbatlas_cloud_backup_snapshots.test.group_id
project_id = mongodbatlas_cloud_backup_snapshots.test.project_id
cluster_name = mongodbatlas_cloud_backup_snapshots.test.cluster_name
page_num = 1
items_per_page = 5
Expand All @@ -29,7 +29,7 @@ data "mongodbatlas_cloud_backup_snapshots" "test" {
## Argument Reference

* `cluster_name` - (Required) The name of the Atlas cluster that contains the snapshot you want to retrieve.
* `group_id` - (Required) The unique identifier of the project for the Atlas cluster.
* `project_id` - (Required) The unique identifier of the project for the Atlas cluster.
* `page_num` - (Optional) The page to return. Defaults to `1`.
* `items_per_page` - (Optional) Number of items to return per page, up to a maximum of 500. Defaults to `100`.

Expand All @@ -38,7 +38,7 @@ data "mongodbatlas_cloud_backup_snapshots" "test" {
In addition to all arguments above, the following attributes are exported:

* `results` - Includes cloudProviderSnapshot object for each item detailed in the results array section.
* `totalCount` - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
* `total_count` - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

### CloudProviderSnapshot

Expand Down
Loading