doc: Updates export_status description, add Cancelled status, and rem…

…ove required for custom_data for `cloud_backup_snapshot_export_job` (#2929) * docs: Update export_status description, add Cancelled status, and remove required for custom_data * fix: Make custom_data field optional in cloud backup snapshot export job schema * chore: Add changelog entry for custom_data attribute change from required to optional in cloud backup snapshot export job
mongodb · Dec 31, 2024 · 3189d4e · 3189d4e
1 parent 014d5f4
commit 3189d4e
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 4 deletions.
diff --git a/.changelog/2929.txt b/.changelog/2929.txt
@@ -0,0 +1,3 @@
+```release-note:note
+resource/mongodbatlas_cloud_backup_snapshot_export_job: Changes `custom_data` changed attribute from required -> optional
+```
diff --git a/docs/data-sources/cloud_backup_snapshot_export_job.md b/docs/data-sources/cloud_backup_snapshot_export_job.md
@@ -49,7 +49,7 @@ 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` - _Returned for replica set only._ Status of the export job.
+* `export_status` - Status of the export job.
 * `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}`
@@ -58,6 +58,7 @@ In addition to all arguments above, the following attributes are exported:
     * `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.

diff --git a/docs/data-sources/cloud_backup_snapshot_export_jobs.md b/docs/data-sources/cloud_backup_snapshot_export_jobs.md
@@ -58,7 +58,7 @@ 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` - _Returned for replica set only._ Status of the export job.
+* `export_status` - Status of the export job.
 * `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}`
@@ -67,6 +67,7 @@ In addition to all arguments above, the following attributes are exported:
     * `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.

diff --git a/docs/resources/cloud_backup_snapshot_export_job.md b/docs/resources/cloud_backup_snapshot_export_job.md
@@ -101,7 +101,7 @@ In addition to all arguments above, the following attributes are exported:
 
 * `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` - _Returned for replica set only._ Status of the export job.
+* `export_status` - Status of the export job.
 * `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}`
@@ -110,6 +110,7 @@ In addition to all arguments above, the following attributes are exported:
     * `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
 
 ### components
 * `export_id` - _Returned for sharded clusters only._ Export job details for each replica set in the sharded cluster.

diff --git a/internal/service/cloudbackupsnapshotexportjob/resource_cloud_backup_snapshot_export_job.go b/internal/service/cloudbackupsnapshotexportjob/resource_cloud_backup_snapshot_export_job.go
@@ -57,7 +57,7 @@ func returnCloudBackupSnapshotExportJobSchema() map[string]*schema.Schema {
 		},
 		"custom_data": {
 			Type:     schema.TypeSet,
-			Required: true,
+			Optional: true,
 			ForceNew: true,
 			Elem: &schema.Resource{
 				Schema: map[string]*schema.Schema{