-
Notifications
You must be signed in to change notification settings - Fork 82
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CLOUDP-196976: Publish compliancePolicy commands (#2494)
- Loading branch information
Showing
27 changed files
with
1,496 additions
and
9 deletions.
There are no files selected for viewing
70 changes: 70 additions & 0 deletions
70
docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-disable.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| .. _atlas-backups-compliancePolicy-copyProtection-disable: | ||
|
|
||
| ===================================================== | ||
| atlas backups compliancePolicy copyProtection disable | ||
| ===================================================== | ||
|
|
||
| .. default-domain:: mongodb | ||
|
|
||
| .. contents:: On this page | ||
| :local: | ||
| :backlinks: none | ||
| :depth: 1 | ||
| :class: singlecol | ||
|
|
||
| Disable copy protection of the backup compliance policy for your project. | ||
|
|
||
| Syntax | ||
| ------ | ||
|
|
||
| .. code-block:: | ||
| :caption: Command Syntax | ||
|
|
||
| atlas backups compliancePolicy copyProtection disable [options] | ||
|
|
||
| .. Code end marker, please don't delete this comment | ||
|
|
||
| Options | ||
| ------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -h, --help | ||
| - | ||
| - false | ||
| - help for disable | ||
| * - -o, --output | ||
| - string | ||
| - false | ||
| - Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option. | ||
| * - --projectId | ||
| - string | ||
| - false | ||
| - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. | ||
| * - -w, --watch | ||
| - | ||
| - false | ||
| - Flag that indicates whether to watch the command until it completes its execution or the watch times out. | ||
|
|
||
| Inherited Options | ||
| ----------------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -P, --profile | ||
| - string | ||
| - false | ||
| - 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 changes: 70 additions & 0 deletions
70
docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-enable.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| .. _atlas-backups-compliancePolicy-copyProtection-enable: | ||
|
|
||
| ==================================================== | ||
| atlas backups compliancePolicy copyProtection enable | ||
| ==================================================== | ||
|
|
||
| .. default-domain:: mongodb | ||
|
|
||
| .. contents:: On this page | ||
| :local: | ||
| :backlinks: none | ||
| :depth: 1 | ||
| :class: singlecol | ||
|
|
||
| Enable copy protection of the backup compliance policy for your project. | ||
|
|
||
| Syntax | ||
| ------ | ||
|
|
||
| .. code-block:: | ||
| :caption: Command Syntax | ||
|
|
||
| atlas backups compliancePolicy copyProtection enable [options] | ||
|
|
||
| .. Code end marker, please don't delete this comment | ||
|
|
||
| Options | ||
| ------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -h, --help | ||
| - | ||
| - false | ||
| - help for enable | ||
| * - -o, --output | ||
| - string | ||
| - false | ||
| - Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option. | ||
| * - --projectId | ||
| - string | ||
| - false | ||
| - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. | ||
| * - -w, --watch | ||
| - | ||
| - false | ||
| - Flag that indicates whether to watch the command until it completes its execution or the watch times out. | ||
|
|
||
| Inherited Options | ||
| ----------------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -P, --profile | ||
| - string | ||
| - false | ||
| - 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. | ||
|
|
61 changes: 61 additions & 0 deletions
61
docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,61 @@ | ||
| .. _atlas-backups-compliancePolicy-copyProtection: | ||
|
|
||
| ============================================= | ||
| atlas backups compliancePolicy copyProtection | ||
| ============================================= | ||
|
|
||
| .. default-domain:: mongodb | ||
|
|
||
| .. contents:: On this page | ||
| :local: | ||
| :backlinks: none | ||
| :depth: 1 | ||
| :class: singlecol | ||
|
|
||
| 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. | ||
|
|
||
| Options | ||
| ------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -h, --help | ||
| - | ||
| - false | ||
| - help for copyProtection | ||
|
|
||
| Inherited Options | ||
| ----------------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -P, --profile | ||
| - string | ||
| - false | ||
| - 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. | ||
|
|
||
| Related Commands | ||
| ---------------- | ||
|
|
||
| * :ref:`atlas-backups-compliancePolicy-copyProtection-disable` - Disable copy protection of the backup compliance policy for your project. | ||
| * :ref:`atlas-backups-compliancePolicy-copyProtection-enable` - Enable copy protection of the backup compliance policy for your project. | ||
|
|
||
|
|
||
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| disable </command/atlas-backups-compliancePolicy-copyProtection-disable> | ||
| enable </command/atlas-backups-compliancePolicy-copyProtection-enable> | ||
|
|
66 changes: 66 additions & 0 deletions
66
docs/atlascli/command/atlas-backups-compliancePolicy-describe.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| .. _atlas-backups-compliancePolicy-describe: | ||
|
|
||
| ======================================= | ||
| atlas backups compliancePolicy describe | ||
| ======================================= | ||
|
|
||
| .. default-domain:: mongodb | ||
|
|
||
| .. contents:: On this page | ||
| :local: | ||
| :backlinks: none | ||
| :depth: 1 | ||
| :class: singlecol | ||
|
|
||
| Return the backup compliance policy for your project. | ||
|
|
||
| Syntax | ||
| ------ | ||
|
|
||
| .. code-block:: | ||
| :caption: Command Syntax | ||
|
|
||
| atlas backups compliancePolicy describe [options] | ||
|
|
||
| .. Code end marker, please don't delete this comment | ||
|
|
||
| Options | ||
| ------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -h, --help | ||
| - | ||
| - false | ||
| - help for describe | ||
| * - -o, --output | ||
| - string | ||
| - false | ||
| - Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option. | ||
| * - --projectId | ||
| - string | ||
| - false | ||
| - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. | ||
|
|
||
| Inherited Options | ||
| ----------------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -P, --profile | ||
| - string | ||
| - false | ||
| - 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 changes: 86 additions & 0 deletions
86
docs/atlascli/command/atlas-backups-compliancePolicy-enable.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| .. _atlas-backups-compliancePolicy-enable: | ||
|
|
||
| ===================================== | ||
| atlas backups compliancePolicy enable | ||
| ===================================== | ||
|
|
||
| .. default-domain:: mongodb | ||
|
|
||
| .. contents:: On this page | ||
| :local: | ||
| :backlinks: none | ||
| :depth: 1 | ||
| :class: singlecol | ||
|
|
||
| Enable Backup Compliance Policy without any configuration. | ||
|
|
||
| Syntax | ||
| ------ | ||
|
|
||
| .. code-block:: | ||
| :caption: Command Syntax | ||
|
|
||
| atlas backups compliancePolicy enable [options] | ||
|
|
||
| .. Code end marker, please don't delete this comment | ||
|
|
||
| Options | ||
| ------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - --authorizedEmail | ||
| - string | ||
| - true | ||
| - Email address of a security or legal representative. | ||
| * - --authorizedUserFirstName | ||
| - string | ||
| - true | ||
| - First name of the user who is authorized to update the Backup Compliance Policy settings. | ||
| * - --authorizedUserLastName | ||
| - string | ||
| - true | ||
| - Last name of the user who is authorized to update the Backup Compliance Policy settings. | ||
| * - --force | ||
| - | ||
| - false | ||
| - Flag that indicates whether to skip the confirmation prompt before proceeding with the requested action. | ||
| * - -h, --help | ||
| - | ||
| - false | ||
| - help for enable | ||
| * - -o, --output | ||
| - string | ||
| - false | ||
| - Output format. Valid values are json, json-path, go-template, or go-template-file. To see full output, use the -o json option. | ||
| * - --projectId | ||
| - string | ||
| - false | ||
| - Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable. | ||
| * - -w, --watch | ||
| - | ||
| - false | ||
| - Flag that indicates whether to watch the command until it completes its execution or the watch times out. | ||
|
|
||
| Inherited Options | ||
| ----------------- | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
| :widths: 20 10 10 60 | ||
|
|
||
| * - Name | ||
| - Type | ||
| - Required | ||
| - Description | ||
| * - -P, --profile | ||
| - string | ||
| - false | ||
| - 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. | ||
|
|
Oops, something went wrong.