Skip to content

Commit 3189d4e

Browse files
authored
doc: Updates export_status description, add Cancelled status, and remove 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
1 parent 014d5f4 commit 3189d4e

File tree

5 files changed

+10
-4
lines changed

5 files changed

+10
-4
lines changed

.changelog/2929.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
```release-note:note
2+
resource/mongodbatlas_cloud_backup_snapshot_export_job: Changes `custom_data` changed attribute from required -> optional
3+
```

docs/data-sources/cloud_backup_snapshot_export_job.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ In addition to all arguments above, the following attributes are exported:
4949
* `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.
5050
* `components` - _Returned for sharded clusters only._ Export job details for each replica set in the sharded cluster.
5151
* `created_at` - Timestamp in ISO 8601 date and time format in UTC when the export job was created.
52-
* `export_status` - _Returned for replica set only._ Status of the export job.
52+
* `export_status` - Status of the export job.
5353
* `finished_at` - Timestamp in ISO 8601 date and time format in UTC when the export job completes.
5454
* `export_job_id` - Unique identifier of the export job.
5555
* `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:
5858
* `InProgress` - indicates that the snapshot is being exported
5959
* `Successful` - indicates that the export job has completed successfully
6060
* `Failed` - indicates that the export job has failed
61+
* `Cancelled` - indicates that the export job has cancelled
6162

6263
### Custom Data
6364
* `key` - Custom data specified as key in the key and value pair.

docs/data-sources/cloud_backup_snapshot_export_jobs.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ In addition to all arguments above, the following attributes are exported:
5858
* `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.
5959
* `components` - _Returned for sharded clusters only._ Export job details for each replica set in the sharded cluster.
6060
* `created_at` - Timestamp in ISO 8601 date and time format in UTC when the export job was created.
61-
* `export_status` - _Returned for replica set only._ Status of the export job.
61+
* `export_status` - Status of the export job.
6262
* `finished_at` - Timestamp in ISO 8601 date and time format in UTC when the export job completes.
6363
* `export_job_id` - Unique identifier of the export job.
6464
* `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:
6767
* `InProgress` - indicates that the snapshot is being exported
6868
* `Successful` - indicates that the export job has completed successfully
6969
* `Failed` - indicates that the export job has failed
70+
* `Cancelled` - indicates that the export job has cancelled
7071

7172
#### Custom Data
7273
* `key` - Custom data specified as key in the key and value pair.

docs/resources/cloud_backup_snapshot_export_job.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ In addition to all arguments above, the following attributes are exported:
101101

102102
* `components` - _Returned for sharded clusters only._ Export job details for each replica set in the sharded cluster.
103103
* `created_at` - Timestamp in ISO 8601 date and time format in UTC when the export job was created.
104-
* `export_status` - _Returned for replica set only._ Status of the export job.
104+
* `export_status` - Status of the export job.
105105
* `finished_at` - Timestamp in ISO 8601 date and time format in UTC when the export job completes.
106106
* `export_job_id` - Unique identifier of the export job.
107107
* `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:
110110
* `InProgress` - indicates that the snapshot is being exported
111111
* `Successful` - indicates that the export job has completed successfully
112112
* `Failed` - indicates that the export job has failed
113+
* `Cancelled` - indicates that the export job has cancelled
113114

114115
### components
115116
* `export_id` - _Returned for sharded clusters only._ Export job details for each replica set in the sharded cluster.

internal/service/cloudbackupsnapshotexportjob/resource_cloud_backup_snapshot_export_job.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ func returnCloudBackupSnapshotExportJobSchema() map[string]*schema.Schema {
5757
},
5858
"custom_data": {
5959
Type: schema.TypeSet,
60-
Required: true,
60+
Optional: true,
6161
ForceNew: true,
6262
Elem: &schema.Resource{
6363
Schema: map[string]*schema.Schema{

0 commit comments

Comments
 (0)