Skip to content

Commit 5339f91

Browse files
authored
doc: Adds retain_backups_enabled details on error (#3308)
* doc: Adds `retain_backups_enabled` details on error * chore: apply PR suggestion * remove accidental tab * chore: Remove double specification * chore: consistent `*` usage
1 parent 3e424f8 commit 5339f91

File tree

3 files changed

+6
-10
lines changed

3 files changed

+6
-10
lines changed

docs/resources/advanced_cluster (preview provider 2.0.0).md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -602,11 +602,9 @@ Refer to the following for full privatelink endpoint connection string examples:
602602
Backup uses:
603603
[Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/#std-label-backup-cloud-provider) for dedicated clusters.
604604
[Flex Cluster Backups](https://www.mongodb.com/docs/atlas/backup/cloud-backup/flex-cluster-backup/) for flex clusters.
605-
If "`backup_enabled`" : `false`, the cluster doesn't use Atlas backups.
605+
If "`backup_enabled`" is `false` (default), the cluster doesn't use Atlas backups.
606606

607-
This parameter defaults to false.
608-
609-
* `retain_backups_enabled` - (Optional) Set to true to retain backup snapshots for the deleted cluster. M10 and above only.
607+
* `retain_backups_enabled` - (Optional) Set to true to retain backup snapshots for the deleted cluster. M10 and above only. This only applies to the `Delete` operation. If you see the `CANNOT_DELETE_SNAPSHOT_WITH_BACKUP_COMPLIANCE_POLICY` error code, set it to explicit `true`.
610608

611609
**NOTE** Prior version of provider had parameter as `bi_connector` state will migrate it to new value you only need to update parameter in your terraform file
612610

docs/resources/advanced_cluster.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -429,11 +429,9 @@ Refer to the following for full privatelink endpoint connection string examples:
429429
Backup uses:
430430
[Cloud Backups](https://docs.atlas.mongodb.com/backup/cloud-backup/overview/#std-label-backup-cloud-provider) for dedicated clusters.
431431
[Flex Cluster Backups](https://www.mongodb.com/docs/atlas/backup/cloud-backup/flex-cluster-backup/) for flex clusters.
432-
If "`backup_enabled`" : `false`, the cluster doesn't use Atlas backups.
432+
If "`backup_enabled`" is `false` (default), the cluster doesn't use Atlas backups.
433433

434-
This parameter defaults to false.
435-
436-
* `retain_backups_enabled` - (Optional) Set to true to retain backup snapshots for the deleted cluster. M10 and above only.
434+
* `retain_backups_enabled` - (Optional) Set to true to retain backup snapshots for the deleted cluster. M10 and above only. This only applies to the `Delete` operation. If you see the `CANNOT_DELETE_SNAPSHOT_WITH_BACKUP_COMPLIANCE_POLICY` error code, set it to explicit `true`.
437435

438436
**NOTE** Prior version of provider had parameter as `bi_connector` state will migrate it to new value you only need to update parameter in your terraform file
439437

docs/resources/cluster.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -303,9 +303,9 @@ But in order to explicitly change `provider_instance_size_name` comment the `lif
303303
backup_enabled = "false"
304304
cloud_backup = "true"
305305
```
306-
* The default value is false. M10 and above only.
306+
* The default value is false. M10 and above only.
307307

308-
* `retain_backups_enabled` - (Optional) Set to true to retain backup snapshots for the deleted cluster. M10 and above only.
308+
* `retain_backups_enabled` - (Optional) Set to true to retain backup snapshots for the deleted cluster. M10 and above only. This only applies to the `Delete` operation. If you see the `CANNOT_DELETE_SNAPSHOT_WITH_BACKUP_COMPLIANCE_POLICY` error code, set it to explicit `true`.
309309
* `bi_connector_config` - (Optional) Specifies BI Connector for Atlas configuration on this cluster. BI Connector for Atlas is only available for M10+ clusters. See [BI Connector](#bi-connector) below for more details.
310310
* `cluster_type` - (Required) Specifies the type of the cluster that you want to modify. You cannot convert a sharded cluster deployment to a replica set deployment.
311311

0 commit comments

Comments
 (0)