Skip to content

Commit c347c5e

Browse files
blvablva
authored
CLOUDP-196976: Publish compliancePolicy commands (#2494)
1 parent addfae9 commit c347c5e

27 files changed

+1496
-9
lines changed

‎docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-disable.txt

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
.. _atlas-backups-compliancePolicy-copyProtection-disable:
2+
3+
=====================================================
4+
atlas backups compliancePolicy copyProtection disable
5+
=====================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Disable copy protection of the backup compliance policy for your project.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
:caption: Command Syntax
22+
23+
atlas backups compliancePolicy copyProtection disable [options]
24+
25+
.. Code end marker, please don't delete this comment
26+
27+
Options
28+
-------
29+
30+
.. list-table::
31+
:header-rows: 1
32+
:widths: 20 10 10 60
33+
34+
* - Name
35+
- Type
36+
- Required
37+
- Description
38+
* - -h, --help
39+
-
40+
- false
41+
- help for disable
42+
* - -o, --output
43+
- string
44+
- false
45+
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option.
46+
* - --projectId
47+
- string
48+
- false
49+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
50+
* - -w, --watch
51+
-
52+
- false
53+
- Flag that indicates whether to watch the command until it completes its execution or the watch times out.
54+
55+
Inherited Options
56+
-----------------
57+
58+
.. list-table::
59+
:header-rows: 1
60+
:widths: 20 10 10 60
61+
62+
* - Name
63+
- Type
64+
- Required
65+
- Description
66+
* - -P, --profile
67+
- string
68+
- false
69+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
70+

‎docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-enable.txt

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
.. _atlas-backups-compliancePolicy-copyProtection-enable:
2+
3+
====================================================
4+
atlas backups compliancePolicy copyProtection enable
5+
====================================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Enable copy protection of the backup compliance policy for your project.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
:caption: Command Syntax
22+
23+
atlas backups compliancePolicy copyProtection enable [options]
24+
25+
.. Code end marker, please don't delete this comment
26+
27+
Options
28+
-------
29+
30+
.. list-table::
31+
:header-rows: 1
32+
:widths: 20 10 10 60
33+
34+
* - Name
35+
- Type
36+
- Required
37+
- Description
38+
* - -h, --help
39+
-
40+
- false
41+
- help for enable
42+
* - -o, --output
43+
- string
44+
- false
45+
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option.
46+
* - --projectId
47+
- string
48+
- false
49+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
50+
* - -w, --watch
51+
-
52+
- false
53+
- Flag that indicates whether to watch the command until it completes its execution or the watch times out.
54+
55+
Inherited Options
56+
-----------------
57+
58+
.. list-table::
59+
:header-rows: 1
60+
:widths: 20 10 10 60
61+
62+
* - Name
63+
- Type
64+
- Required
65+
- Description
66+
* - -P, --profile
67+
- string
68+
- false
69+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
70+

‎docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection.txt

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
.. _atlas-backups-compliancePolicy-copyProtection:
2+
3+
=============================================
4+
atlas backups compliancePolicy copyProtection
5+
=============================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Manage copy protection of the backup compliance policy for your project. Learn more: https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/#-optional--keep-all-snapshots-when-removing-additional-snapshot-regions.
16+
17+
Options
18+
-------
19+
20+
.. list-table::
21+
:header-rows: 1
22+
:widths: 20 10 10 60
23+
24+
* - Name
25+
- Type
26+
- Required
27+
- Description
28+
* - -h, --help
29+
-
30+
- false
31+
- help for copyProtection
32+
33+
Inherited Options
34+
-----------------
35+
36+
.. list-table::
37+
:header-rows: 1
38+
:widths: 20 10 10 60
39+
40+
* - Name
41+
- Type
42+
- Required
43+
- Description
44+
* - -P, --profile
45+
- string
46+
- false
47+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
48+
49+
Related Commands
50+
----------------
51+
52+
* :ref:`atlas-backups-compliancePolicy-copyProtection-disable` - Disable copy protection of the backup compliance policy for your project.
53+
* :ref:`atlas-backups-compliancePolicy-copyProtection-enable` - Enable copy protection of the backup compliance policy for your project.
54+
55+
56+
.. toctree::
57+
:titlesonly:
58+
59+
disable </command/atlas-backups-compliancePolicy-copyProtection-disable>
60+
enable </command/atlas-backups-compliancePolicy-copyProtection-enable>
61+

‎docs/atlascli/command/atlas-backups-compliancePolicy-describe.txt

+66
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
.. _atlas-backups-compliancePolicy-describe:
2+
3+
=======================================
4+
atlas backups compliancePolicy describe
5+
=======================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Return the backup compliance policy for your project.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
:caption: Command Syntax
22+
23+
atlas backups compliancePolicy describe [options]
24+
25+
.. Code end marker, please don't delete this comment
26+
27+
Options
28+
-------
29+
30+
.. list-table::
31+
:header-rows: 1
32+
:widths: 20 10 10 60
33+
34+
* - Name
35+
- Type
36+
- Required
37+
- Description
38+
* - -h, --help
39+
-
40+
- false
41+
- help for describe
42+
* - -o, --output
43+
- string
44+
- false
45+
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option.
46+
* - --projectId
47+
- string
48+
- false
49+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
50+
51+
Inherited Options
52+
-----------------
53+
54+
.. list-table::
55+
:header-rows: 1
56+
:widths: 20 10 10 60
57+
58+
* - Name
59+
- Type
60+
- Required
61+
- Description
62+
* - -P, --profile
63+
- string
64+
- false
65+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
66+

‎docs/atlascli/command/atlas-backups-compliancePolicy-enable.txt

+86
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
.. _atlas-backups-compliancePolicy-enable:
2+
3+
=====================================
4+
atlas backups compliancePolicy enable
5+
=====================================
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 1
13+
:class: singlecol
14+
15+
Enable Backup Compliance Policy without any configuration.
16+
17+
Syntax
18+
------
19+
20+
.. code-block::
21+
:caption: Command Syntax
22+
23+
atlas backups compliancePolicy enable [options]
24+
25+
.. Code end marker, please don't delete this comment
26+
27+
Options
28+
-------
29+
30+
.. list-table::
31+
:header-rows: 1
32+
:widths: 20 10 10 60
33+
34+
* - Name
35+
- Type
36+
- Required
37+
- Description
38+
* - --authorizedEmail
39+
- string
40+
- true
41+
- Email address of a security or legal representative.
42+
* - --authorizedUserFirstName
43+
- string
44+
- true
45+
- First name of the user who is authorized to update the Backup Compliance Policy settings.
46+
* - --authorizedUserLastName
47+
- string
48+
- true
49+
- Last name of the user who is authorized to update the Backup Compliance Policy settings.
50+
* - --force
51+
-
52+
- false
53+
- Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action.
54+
* - -h, --help
55+
-
56+
- false
57+
- help for enable
58+
* - -o, --output
59+
- string
60+
- false
61+
- Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option.
62+
* - --projectId
63+
- string
64+
- false
65+
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
66+
* - -w, --watch
67+
-
68+
- false
69+
- Flag that indicates whether to watch the command until it completes its execution or the watch times out.
70+
71+
Inherited Options
72+
-----------------
73+
74+
.. list-table::
75+
:header-rows: 1
76+
:widths: 20 10 10 60
77+
78+
* - Name
79+
- Type
80+
- Required
81+
- Description
82+
* - -P, --profile
83+
- string
84+
- false
85+
- Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.
86+

0 commit comments

Comments
 (0)