Skip to content

Commit b9443c9

Browse files
kyuan-mongodbkyuan-mongodb
committed
MM suggestions
1 parent 56e640b commit b9443c9

File tree

1 file changed

+64
-79
lines changed

1 file changed

+64
-79
lines changed

‎source/reference/json/cloud-backup-schedule-config-file.txt

Lines changed: 64 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,13 @@ settings required when you update a cloud backup schedule using the
1515
{+atlas-cli+}. The {+atlas-cli+} accepts ``.json`` cloud backup schedule
1616
configuration files.
1717

18-
Use the following resources to:
19-
20-
- Learn the :ref:`settings <cloud-backup-schedule-settings>`
21-
you can specify in the cloud backup schedule configuration file.
22-
- View and copy :ref:`sample configuration files
23-
<example-cloud-backup-schedule-config-file>`.
24-
2518
.. _cloud-backup-schedule-settings:
2619

2720
Cloud Backup Schedule Settings
2821
------------------------------
2922

30-
|service| allows you to specify the following settings to update a cloud
31-
backup schedule with the {+atlas-cli+}. You can specify these cloud backup
32-
schedule settings either in the configuration file or as flags in the
23+
You can specify the following settings to update a cloud
24+
backup schedule either in the configuration file or as flags in the
3325
command:
3426

3527
.. list-table::
@@ -42,47 +34,46 @@ command:
4234

4335
* - ``autoExportEnabled``
4436
- boolean
45-
- Flag that indicates whether MongoDB Cloud automatically exports
37+
- Flag that indicates whether |service| automatically exports
4638
cloud backup snapshots to the |aws| bucket.
4739

4840
* - ``copySettings``
4941
- array
5042
- List that contains a document for each copy setting item in the
5143
desired backup policy.
5244

53-
* - ``copySettings.``
54-
``cloudProvider``
45+
* - | ``copySettings.``
46+
| ``cloudProvider``
5547
- string
5648
- Human-readable label that identifies the cloud provider that
5749
stores the snapshot copy.
5850

59-
* - ``copySettings.``
60-
``frequencies``
51+
* - | ``copySettings.``
52+
| ``frequencies``
6153
- array of strings
6254
- List that describes which types of snapshots to copy.
6355

64-
* - ``copySettings.``
65-
``regionName``
56+
* - | ``copySettings.``
57+
| ``regionName``
6658
- string
67-
- Target region to copy snapshots belonging to ``replicationSpecId``
68-
to. Please supply the 'Atlas Region' which can be found under
69-
`Cloud Providers <https://www.mongodb.com/docs/atlas/reference/cloud-providers/>`__
70-
'regions' link.
59+
- Target Atlas region to copy snapshots belonging to ``replicationSpecId``
60+
to. Please supply the **Atlas Region** that corresponds to your
61+
:ref:`AWS <amazon-aws>`, :ref:`GCP <google-gcp>` or :ref:`Azure
62+
<microsoft-azure>` region.
7163

72-
* - ``copySettings.``
73-
``replicationSpecId``
64+
* - | ``copySettings.``
65+
| ``replicationSpecId``
7466
- string
7567
- Unique 24-hexadecimal digit string that identifies the
7668
replication object for a zone in a cluster. For global clusters,
7769
there can be multiple zones to choose from. For sharded clusters
7870
and replica set clusters, there is only one zone in the cluster.
79-
To find the Replication Spec Id, do a GET request to Return One
80-
Cluster in One Project and consult the replicationSpecs array
71+
To find ``thereplicationSpecId``, do a GET request to
8172
:oas-atlas-op:`Return One Cluster in One Project
82-
</getLegacyCluster>`.
73+
</getLegacyCluster>` and consult its ``replicationSpecs`` array.
8374

84-
* - ``copySettings.``
85-
``shouldCopyOplogs``
75+
* - | ``copySettings.``
76+
| ``shouldCopyOplogs``
8677
- boolean
8778
- Flag that indicates whether to copy the oplogs to the target
8879
region. You can use the oplogs to perform point-in-time restores.
@@ -92,46 +83,44 @@ command:
9283
- List that contains a document for each copy setting item in the
9384
desired backup policy.
9485

95-
* - ``deleteCopiedBackups.``
96-
``cloudProvider``
86+
* - | ``deleteCopiedBackups.``
87+
| ``cloudProvider``
9788
- string
9889
- Human-readable label that identifies the cloud provider for the
9990
deleted copy setting whose backup copies you want to delete.
10091

101-
* - ``deleteCopiedBackups.``
102-
``regionName``
92+
* - | ``deleteCopiedBackups.``
93+
| ``regionName``
10394
- string
104-
- Target region for the deleted copy setting whose backup copies
105-
you want to delete. Please supply the 'Atlas Region' which can be
106-
found under `Cloud Providers
107-
<https://www.mongodb.com/docs/atlas/reference/cloud-providers/>`__
108-
'regions' link.
109-
110-
* - ``deleteCopiedBackups.``
111-
``replicationSpecId``
95+
- Target Atlas region to copy snapshots belonging to ``replicationSpecId``
96+
to. Please supply the **Atlas Region** that corresponds to your
97+
:ref:`AWS <amazon-aws>`, :ref:`GCP <google-gcp>` or :ref:`Azure
98+
<microsoft-azure>` region.
99+
100+
* - | ``deleteCopiedBackups.``
101+
| ``replicationSpecId``
112102
- string
113103
- Unique 24-hexadecimal digit string that identifies the
114104
replication object for a zone in a cluster. For global clusters,
115105
there can be multiple zones to choose from. For sharded clusters
116106
and replica setclusters, there is only one zone in the cluster.
117-
To find the Replication Spec Id, do a GET request to Return One
118-
Cluster in One Project and consult the replicationSpecs array
107+
To find ``thereplicationSpecId``, do a GET request to
119108
:oas-atlas-op:`Return One Cluster in One Project
120-
</getLegacyCluster>`.
109+
</getLegacyCluster>` and consult its ``replicationSpecs`` array.
121110

122111
* - ``export``
123112
- object
124113
- List that contains a document for each copy setting item in the
125114
desired backup policy.
126115

127-
* - ``export.``
128-
``exportBucketId``
116+
* - | ``export.``
117+
| ``exportBucketId``
129118
- string
130119
- Unique 24-hexadecimal character string that identifies the |aws|
131120
Bucket.
132121

133-
* - ``export.``
134-
``frequencyType``
122+
* - | ``export.``
123+
| ``frequencyType``
135124
- string
136125
- Human-readable label that indicates the rate at which the export
137126
policy item occurs.
@@ -140,20 +129,20 @@ command:
140129
- array
141130
- Rules set for this backup schedule.
142131

143-
* - ``policies.``
144-
``id``
132+
* - | ``policies.``
133+
| ``id``
145134
- string
146135
- Unique 24-hexadecimal digit string that identifies this backup
147136
policy.
148137

149-
* - ``policies.``
150-
``policyItems``
138+
* - | ``policies.``
139+
| ``policyItems``
151140
- array
152141
- List that contains the specifications for one policy.
153142

154-
* - ``policies.``
155-
``policyItems.``
156-
``frequencyInterval``
143+
* - | ``policies.``
144+
| ``policyItems.``
145+
| ``frequencyInterval``
157146
- integer
158147
- Number that indicates the frequency interval for a set of
159148
snapshots. A value of ``1`` specifies the first instance of the
@@ -168,28 +157,28 @@ command:
168157

169158
- In an hourly policy item, you can set the frequency interval to
170159
``1``, ``2``, ``4``, ``6``, ``8``, or ``12``. For hourly policy
171-
items for NVMe clusters, MongoDB Cloud only accepts ``12`` as
160+
items for NVMe clusters, |service| only accepts ``12`` as
172161
the frequency interval value.
173162

174-
* - ``policies.``
175-
``policyItems.``
176-
``frequencyType``
163+
* - | ``policies.``
164+
| ``policyItems.``
165+
| ``frequencyType``
177166
- string
178167
- Human-readable label that identifies the frequency type
179168
associated with the backup policy.
180169

181-
* - ``policies.``
182-
``policyItems.``
183-
``retentionUnit``
170+
* - | ``policies.``
171+
| ``policyItems.``
172+
| ``retentionUnit``
184173
- string
185-
- Unit of time in which MongoDB Cloud measures snapshot retention.
174+
- Unit of time in which |service| measures snapshot retention.
186175

187-
* - ``policies.``
188-
``policyItems.``
189-
``retentionValue``
176+
* - | ``policies.``
177+
| ``policyItems.``
178+
| ``retentionValue``
190179
- integer
191-
- Duration in days, weeks, or months that MongoDB Cloud retains the
192-
snapshot. For less frequent policy items, MongoDB Cloud requires
180+
- Duration in days, weeks, or months that |service| retains the
181+
snapshot. For less frequent policy items, |service| requires
193182
that you specify a value greater than or equal to the value
194183
specified for more frequent policy items.
195184

@@ -200,42 +189,38 @@ command:
200189
* - ``referenceHourOfDay``
201190
- integer
202191
- Hour of day in Coordinated Universal Time (UTC) that represents
203-
when MongoDB Cloud takes the snapshot.
192+
when |service| takes the snapshot.
204193

205194
* - ``referenceMinuteOfHour``
206195
- integer
207-
- Minute of the ``referenceHourOfDay`` that represents when MongoDB
208-
Cloud takes the snapshot.
196+
- Minute of the ``referenceHourOfDay`` that represents when
197+
|service| takes the snapshot.
209198

210199
* - ``restoreWindowDays``
211200
- integer
212201
- Number of previous days that you can restore back to with
213-
Continuous Cloud Backup accuracy. You must specify a positive,
202+
continuous cloud backup accuracy. You must specify a positive,
214203
non-zero integer. This parameter applies to continuous cloud
215204
backups only.
216205

217206
* - ``updateSnapshots``
218207
- boolean
219208
- Flag that indicates whether to apply the retention changes in the
220-
updated backup policy to snapshots that MongoDB Cloud took
209+
updated backup policy to snapshots that |service| took
221210
previously.
222211

223212
* - ``useOrgAndGroupNamesInExportPrefix``
224213
- boolean
225214
- Flag that indicates whether to use organization and project names
226215
instead of organization and project UUIDs in the path to the
227-
metadata files that MongoDB Cloud uploads to your |aws| bucket.
228-
229-
For a full list of available settings, see the API documentation for
230-
:oas-atlas-op:`Update Cloud Backup Schedule for One Cluster </cloudProvider>`.
216+
metadata files that |service| uploads to your |aws| bucket.
231217

232218
.. _example-cloud-backup-schedule-config-file:
233219

234220
Example Cloud Backup Schedule Configuration File
235221
------------------------------------------------
236222

237-
To update a cloud backup schedule for a single cluster, specify the same
238-
service provider for your ``regionConfigs`` objects as shown in the
239-
following example file:
223+
To update a cloud backup schedule for a single cluster, specify the
224+
fields you want to update as shown in the following example file:
240225

241226
.. literalinclude:: /includes/update-cloud-backup-schedule-config-file.json

0 commit comments

Comments
 (0)