From 6659e52d4d98f6f2b2b86d7ccb39d89bc88ef61d Mon Sep 17 00:00:00 2001 From: Bianca Date: Tue, 5 Dec 2023 09:22:28 +0000 Subject: [PATCH 1/2] Publish compliancePolicy commands --- ...ompliancePolicy-copyProtection-disable.txt | 70 ++++++++++++++ ...compliancePolicy-copyProtection-enable.txt | 70 ++++++++++++++ ...ackups-compliancePolicy-copyProtection.txt | 61 ++++++++++++ ...tlas-backups-compliancePolicy-describe.txt | 66 +++++++++++++ .../atlas-backups-compliancePolicy-enable.txt | 86 +++++++++++++++++ ...pliancePolicy-encryptionAtRest-disable.txt | 70 ++++++++++++++ ...mpliancePolicy-encryptionAtRest-enable.txt | 70 ++++++++++++++ ...kups-compliancePolicy-encryptionAtRest.txt | 61 ++++++++++++ ...iancePolicy-pointInTimeRestores-enable.txt | 74 +++++++++++++++ ...s-compliancePolicy-pointInTimeRestores.txt | 59 ++++++++++++ ...ups-compliancePolicy-policies-describe.txt | 66 +++++++++++++ ...pliancePolicy-policies-ondemand-create.txt | 85 +++++++++++++++++ ...iancePolicy-policies-ondemand-describe.txt | 66 +++++++++++++ ...pliancePolicy-policies-ondemand-update.txt | 85 +++++++++++++++++ ...ups-compliancePolicy-policies-ondemand.txt | 63 +++++++++++++ ...liancePolicy-policies-scheduled-create.txt | 93 +++++++++++++++++++ ...ancePolicy-policies-scheduled-describe.txt | 66 +++++++++++++ ...ps-compliancePolicy-policies-scheduled.txt | 61 ++++++++++++ ...tlas-backups-compliancePolicy-policies.txt | 63 +++++++++++++ .../atlas-backups-compliancePolicy-setup.txt | 78 ++++++++++++++++ .../atlas-backups-compliancePolicy.txt | 72 ++++++++++++++ docs/atlascli/command/atlas-backups.txt | 3 + .../compliancepolicy/compliancepolicy.go | 1 - 23 files changed, 1488 insertions(+), 1 deletion(-) create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-disable.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-enable.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-describe.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-enable.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-policies-describe.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-policies.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy-setup.txt create mode 100644 docs/atlascli/command/atlas-backups-compliancePolicy.txt diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-disable.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-disable.txt new file mode 100644 index 0000000000..329565b724 --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-disable.txt @@ -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. + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-enable.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-enable.txt new file mode 100644 index 0000000000..6c5519247e --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection-enable.txt @@ -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. + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection.txt new file mode 100644 index 0000000000..4a57b44306 --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-copyProtection.txt @@ -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 + enable + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-describe.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-describe.txt new file mode 100644 index 0000000000..b3e1201063 --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-describe.txt @@ -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. + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-enable.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-enable.txt new file mode 100644 index 0000000000..2bec17e8d1 --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-enable.txt @@ -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 authorized to updated the Backup Compliance Policy settings. + * - --authorizedUserLastName + - string + - true + - Last name of the user who authorized to updated 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. + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt new file mode 100644 index 0000000000..f50a1baedb --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt @@ -0,0 +1,70 @@ +.. _atlas-backups-compliancePolicy-encryptionAtRest-disable: + +======================================================= +atlas backups compliancePolicy encryptionAtRest disable +======================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Disable encryption at rest of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy encryptionAtRest 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. + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt new file mode 100644 index 0000000000..7d68c90abf --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt @@ -0,0 +1,70 @@ +.. _atlas-backups-compliancePolicy-encryptionAtRest-enable: + +====================================================== +atlas backups compliancePolicy encryptionAtRest enable +====================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable encryption at rest of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy encryptionAtRest 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. + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest.txt new file mode 100644 index 0000000000..6b37bbec92 --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest.txt @@ -0,0 +1,61 @@ +.. _atlas-backups-compliancePolicy-encryptionAtRest: + +=============================================== +atlas backups compliancePolicy encryptionAtRest +=============================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage Encryption at Rest of the backup compliance policy for your project. Encryption at rest enforces all clusters with a Backup Compliance Policy to use Customer Key Management. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for encryptionAtRest + +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-encryptionAtRest-disable` - Disable encryption at rest of the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-encryptionAtRest-enable` - Enable encryption at rest of the backup compliance policy for your project. + + +.. toctree:: + :titlesonly: + + disable + enable + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt new file mode 100644 index 0000000000..1d0d4ff55e --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-pointInTimeRestores-enable.txt @@ -0,0 +1,74 @@ +.. _atlas-backups-compliancePolicy-pointInTimeRestores-enable: + +========================================================= +atlas backups compliancePolicy pointInTimeRestores enable +========================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Enable Point-in-Time restores of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy pointInTimeRestores 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. + * - --restoreWindowDays + - int + - true + - Number of days back in time you can restore to with Continuous Cloud Backup accuracy. Must be a positive, non-zero integer. Applies to continuous cloud backups only. + * - -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. + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt new file mode 100644 index 0000000000..ef796859c2 --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-pointInTimeRestores.txt @@ -0,0 +1,59 @@ +.. _atlas-backups-compliancePolicy-pointInTimeRestores: + +================================================== +atlas backups compliancePolicy pointInTimeRestores +================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage whether the project uses Continuous Cloud Backups with a Backup Compliance Policy. Read more in the documentation: https://www.mongodb.com/docs/atlas/backup/cloud-backup/configure-backup-policy/#configure-the-restore-window. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for pointInTimeRestores + +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-pointInTimeRestores-enable` - Enable Point-in-Time restores of the backup compliance policy for your project. + + +.. toctree:: + :titlesonly: + + enable + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-describe.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-describe.txt new file mode 100644 index 0000000000..0641ff7370 --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-describe.txt @@ -0,0 +1,66 @@ +.. _atlas-backups-compliancePolicy-policies-describe: + +================================================ +atlas backups compliancePolicy policies describe +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the individual policy items of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy policies 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. + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt new file mode 100644 index 0000000000..48af493020 --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt @@ -0,0 +1,85 @@ +.. _atlas-backups-compliancePolicy-policies-ondemand-create: + +======================================================= +atlas backups compliancePolicy policies ondemand create +======================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create the on-demand policy item of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy policies ondemand create [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 create + * - -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. + * - --retentionUnit + - string + - true + - Unit of time in which MongoDB Cloud measures snapshot retention: 'days' 'weeks' 'months'. + * - --retentionValue + - int + - true + - Duration in days, weeks, or months that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. + * - -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. + +Examples +-------- + +.. code-block:: + + # Create a backup compliance on-demand policy with a retention of two weeks: + atlas backups compliancepolicy policies ondemand create --retentionUnit weeks --retentionValue 2 diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt new file mode 100644 index 0000000000..7ecb0534f3 --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-describe.txt @@ -0,0 +1,66 @@ +.. _atlas-backups-compliancePolicy-policies-ondemand-describe: + +========================================================= +atlas backups compliancePolicy policies ondemand describe +========================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the on-demand policy item of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy policies ondemand 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. + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt new file mode 100644 index 0000000000..59905c493f --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt @@ -0,0 +1,85 @@ +.. _atlas-backups-compliancePolicy-policies-ondemand-update: + +======================================================= +atlas backups compliancePolicy policies ondemand update +======================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Update the on-demand policy of the backup compliance for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy policies ondemand update [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 update + * - -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. + * - --retentionUnit + - string + - true + - Unit of time in which MongoDB Cloud measures snapshot retention: 'days' 'weeks' 'months'. + * - --retentionValue + - int + - true + - Duration in days, weeks, or months that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. + * - -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. + +Examples +-------- + +.. code-block:: + + # Update a backup compliance on-demand policy and set it's retention to one week: + atlas backups compliancepolicy policies ondemand update --retentionUnit weeks --retentionValue 1 diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand.txt new file mode 100644 index 0000000000..4aad7eae1c --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand.txt @@ -0,0 +1,63 @@ +.. _atlas-backups-compliancePolicy-policies-ondemand: + +================================================ +atlas backups compliancePolicy policies ondemand +================================================ + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage the on-demand policy item of the backup compliance policy for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for ondemand + +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-policies-ondemand-create` - Create the on-demand policy item of the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-policies-ondemand-describe` - Return the on-demand policy item of the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-policies-ondemand-update` - Update the on-demand policy of the backup compliance for your project. + + +.. toctree:: + :titlesonly: + + create + describe + update + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt new file mode 100644 index 0000000000..89c4e71d10 --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt @@ -0,0 +1,93 @@ +.. _atlas-backups-compliancePolicy-policies-scheduled-create: + +======================================================== +atlas backups compliancePolicy policies scheduled create +======================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Create a scheduled policy item for the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy policies scheduled create [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 + * - --frequencyInterval + - int + - true + - Number that indicates the frequency interval for a set of snapshots. A value of 1 specifies the first instance of the corresponding frequencyType. In a monthly policy item, 1 indicates that the monthly snapshot occurs on the first day of the month and 40 indicates the last day of the month. In a weekly policy item, 1 indicates that the weekly snapshot occurs on Monday and 7 indicates Sunday. In an hourly policy item, you can set the frequency interval to 1, 2, 4, 6, 8, or 12. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only 12 as the frequency interval value. + * - --frequencyType + - string + - true + - Frequency type associated with the backup policy: 'daily', 'hourly', 'monthly', 'weekly'. + * - -h, --help + - + - false + - help for create + * - -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. + * - --retentionUnit + - string + - true + - Unit of time in which MongoDB Cloud measures snapshot retention: 'days' 'weeks' 'months'. + * - --retentionValue + - int + - true + - Duration in days, weeks, or months that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. + * - -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. + +Examples +-------- + +.. code-block:: + + # Create a backup compliance schedule policy with a weekly frequency, where the snapshot occurs on Monday and has a retention of two months: + atlas backups compliancepolicy policies scheduled create --frequencyType weekly --frequencyInterval 1 --retentionUnit months --retentionValue 2 diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt new file mode 100644 index 0000000000..a6616cadb7 --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled-describe.txt @@ -0,0 +1,66 @@ +.. _atlas-backups-compliancePolicy-policies-scheduled-describe: + +========================================================== +atlas backups compliancePolicy policies scheduled describe +========================================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Return the scheduled policy items of the backup compliance policy for your project. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy policies scheduled 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. + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled.txt new file mode 100644 index 0000000000..9d2376fa43 --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled.txt @@ -0,0 +1,61 @@ +.. _atlas-backups-compliancePolicy-policies-scheduled: + +================================================= +atlas backups compliancePolicy policies scheduled +================================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage the scheduled policy items of the backup compliance policy for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for scheduled + +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-policies-scheduled-create` - Create a scheduled policy item for the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-policies-scheduled-describe` - Return the scheduled policy items of the backup compliance policy for your project. + + +.. toctree:: + :titlesonly: + + create + describe + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-policies.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-policies.txt new file mode 100644 index 0000000000..40b7bd48d9 --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-policies.txt @@ -0,0 +1,63 @@ +.. _atlas-backups-compliancePolicy-policies: + +======================================= +atlas backups compliancePolicy policies +======================================= + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage the individual policy items of the backup compliance policy for your project. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for policies + +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-policies-describe` - Return the individual policy items of the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-policies-ondemand` - Manage the on-demand policy item of the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-policies-scheduled` - Manage the scheduled policy items of the backup compliance policy for your project. + + +.. toctree:: + :titlesonly: + + describe + ondemand + scheduled + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-setup.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-setup.txt new file mode 100644 index 0000000000..c74594468c --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-setup.txt @@ -0,0 +1,78 @@ +.. _atlas-backups-compliancePolicy-setup: + +==================================== +atlas backups compliancePolicy setup +==================================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Setup the backup compliance policy for your project with a configuration file. + +Syntax +------ + +.. code-block:: + :caption: Command Syntax + + atlas backups compliancePolicy setup [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 + * - -f, --file + - string + - true + - Path to a JSON configuration file that defines 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 setup + * - -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. + diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy.txt b/docs/atlascli/command/atlas-backups-compliancePolicy.txt new file mode 100644 index 0000000000..5dbae9b49e --- /dev/null +++ b/docs/atlascli/command/atlas-backups-compliancePolicy.txt @@ -0,0 +1,72 @@ +.. _atlas-backups-compliancePolicy: + +============================== +atlas backups compliancePolicy +============================== + +.. default-domain:: mongodb + +.. contents:: On this page + :local: + :backlinks: none + :depth: 1 + :class: singlecol + +Manage cloud backup compliance policy for your project. Use "atlas backups compliancepolicy setup" to enable backup compliance policy +with a full configuration. Use "atlas backups compliancepolicy enable" to enable backup compliance policy without any configuration. + +Options +------- + +.. list-table:: + :header-rows: 1 + :widths: 20 10 10 60 + + * - Name + - Type + - Required + - Description + * - -h, --help + - + - false + - help for compliancePolicy + +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` - 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. +* :ref:`atlas-backups-compliancePolicy-describe` - Return the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-enable` - Enable Backup Compliance Policy without any configuration. +* :ref:`atlas-backups-compliancePolicy-encryptionAtRest` - Manage Encryption at Rest of the backup compliance policy for your project. Encryption at rest enforces all clusters with a Backup Compliance Policy to use Customer Key Management. +* :ref:`atlas-backups-compliancePolicy-pointInTimeRestores` - Manage whether the project uses Continuous Cloud Backups with a Backup Compliance Policy. Read more in the documentation: https://www.mongodb.com/docs/atlas/backup/cloud-backup/configure-backup-policy/#configure-the-restore-window. +* :ref:`atlas-backups-compliancePolicy-policies` - Manage the individual policy items of the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-setup` - Setup the backup compliance policy for your project with a configuration file. + + +.. toctree:: + :titlesonly: + + copyProtection + describe + enable + encryptionAtRest + pointInTimeRestores + policies + setup + diff --git a/docs/atlascli/command/atlas-backups.txt b/docs/atlascli/command/atlas-backups.txt index 76d00095ad..874c792e46 100644 --- a/docs/atlascli/command/atlas-backups.txt +++ b/docs/atlascli/command/atlas-backups.txt @@ -49,6 +49,8 @@ Inherited Options Related Commands ---------------- +* :ref:`atlas-backups-compliancePolicy` - Manage cloud backup compliance policy for your project. Use "atlas backups compliancepolicy setup" to enable backup compliance policy +with a full configuration. Use "atlas backups compliancepolicy enable" to enable backup compliance policy without any configuration. * :ref:`atlas-backups-exports` - Manage cloud backup export jobs for your project. * :ref:`atlas-backups-restores` - Manage cloud backup restore jobs for your project. * :ref:`atlas-backups-schedule` - Return a cloud backup schedule for the cluster you specify. @@ -58,6 +60,7 @@ Related Commands .. toctree:: :titlesonly: + compliancePolicy exports restores schedule diff --git a/internal/cli/atlas/backup/compliancepolicy/compliancepolicy.go b/internal/cli/atlas/backup/compliancepolicy/compliancepolicy.go index da9ef550ac..ab6a6becc4 100644 --- a/internal/cli/atlas/backup/compliancepolicy/compliancepolicy.go +++ b/internal/cli/atlas/backup/compliancepolicy/compliancepolicy.go @@ -31,7 +31,6 @@ func Builder() *cobra.Command { const use = "compliancePolicy" cmd := &cobra.Command{ Use: use, - Hidden: true, Aliases: cli.GenerateAliases(use), Short: `Manage cloud backup compliance policy for your project. Use "atlas backups compliancepolicy setup" to enable backup compliance policy with a full configuration. Use "atlas backups compliancepolicy enable" to enable backup compliance policy without any configuration.`, From a01de91570bc33b5e9642e7d7780eba6fc29c81c Mon Sep 17 00:00:00 2001 From: Bianca Date: Tue, 5 Dec 2023 16:02:54 +0000 Subject: [PATCH 2/2] Update docs --- .../command/atlas-backups-compliancePolicy-enable.txt | 4 ++-- ...ckups-compliancePolicy-encryptionAtRest-disable.txt | 2 +- ...ackups-compliancePolicy-encryptionAtRest-enable.txt | 2 +- ...atlas-backups-compliancePolicy-encryptionAtRest.txt | 6 +++--- ...ckups-compliancePolicy-policies-ondemand-create.txt | 4 ++-- ...ckups-compliancePolicy-policies-ondemand-update.txt | 4 ++-- ...kups-compliancePolicy-policies-scheduled-create.txt | 6 +++--- .../command/atlas-backups-compliancePolicy.txt | 2 +- .../compliancepolicy/encryptionatrest/disable.go | 2 +- .../backup/compliancepolicy/encryptionatrest/enable.go | 2 +- .../encryptionatrest/encryptionatrest.go | 2 +- internal/usage/usage.go | 10 +++++----- 12 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-enable.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-enable.txt index 2bec17e8d1..e5d771dcd7 100644 --- a/docs/atlascli/command/atlas-backups-compliancePolicy-enable.txt +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-enable.txt @@ -42,11 +42,11 @@ Options * - --authorizedUserFirstName - string - true - - First name of the user who authorized to updated the Backup Compliance Policy settings. + - First name of the user who is authorized to update the Backup Compliance Policy settings. * - --authorizedUserLastName - string - true - - Last name of the user who authorized to updated the Backup Compliance Policy settings. + - Last name of the user who is authorized to update the Backup Compliance Policy settings. * - --force - - false diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt index f50a1baedb..a3440f7495 100644 --- a/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-disable.txt @@ -12,7 +12,7 @@ atlas backups compliancePolicy encryptionAtRest disable :depth: 1 :class: singlecol -Disable encryption at rest of the backup compliance policy for your project. +Disable encryption-at-rest for the backup compliance policy for your project. Syntax ------ diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt index 7d68c90abf..542f4311e6 100644 --- a/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest-enable.txt @@ -12,7 +12,7 @@ atlas backups compliancePolicy encryptionAtRest enable :depth: 1 :class: singlecol -Enable encryption at rest of the backup compliance policy for your project. +Enable encryption-at-rest for the backup compliance policy for your project. Syntax ------ diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest.txt index 6b37bbec92..8c4593ff95 100644 --- a/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest.txt +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-encryptionAtRest.txt @@ -12,7 +12,7 @@ atlas backups compliancePolicy encryptionAtRest :depth: 1 :class: singlecol -Manage Encryption at Rest of the backup compliance policy for your project. Encryption at rest enforces all clusters with a Backup Compliance Policy to use Customer Key Management. +Manage encryption-at-rest for the backup compliance policy for your project. Encryption-at-rest enforces all clusters with a Backup Compliance Policy to use Customer Key Management. Options ------- @@ -49,8 +49,8 @@ Inherited Options Related Commands ---------------- -* :ref:`atlas-backups-compliancePolicy-encryptionAtRest-disable` - Disable encryption at rest of the backup compliance policy for your project. -* :ref:`atlas-backups-compliancePolicy-encryptionAtRest-enable` - Enable encryption at rest of the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-encryptionAtRest-disable` - Disable encryption-at-rest for the backup compliance policy for your project. +* :ref:`atlas-backups-compliancePolicy-encryptionAtRest-enable` - Enable encryption-at-rest for the backup compliance policy for your project. .. toctree:: diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt index 48af493020..16ce7e924c 100644 --- a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-create.txt @@ -50,11 +50,11 @@ Options * - --retentionUnit - string - true - - Unit of time in which MongoDB Cloud measures snapshot retention: 'days' 'weeks' 'months'. + - Unit of time in which Atlas measures snapshot retention: 'days' 'weeks' 'months'. * - --retentionValue - int - true - - Duration in days, weeks, or months that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. + - Duration in days, weeks, or months that Atlas retains the snapshot. For less frequent policy items, Atlas requires that you specify a value greater than or equal to the value specified for more frequent policy items. * - -w, --watch - - false diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt index 59905c493f..825cbb6009 100644 --- a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-ondemand-update.txt @@ -50,11 +50,11 @@ Options * - --retentionUnit - string - true - - Unit of time in which MongoDB Cloud measures snapshot retention: 'days' 'weeks' 'months'. + - Unit of time in which Atlas measures snapshot retention: 'days' 'weeks' 'months'. * - --retentionValue - int - true - - Duration in days, weeks, or months that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. + - Duration in days, weeks, or months that Atlas retains the snapshot. For less frequent policy items, Atlas requires that you specify a value greater than or equal to the value specified for more frequent policy items. * - -w, --watch - - false diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt index 89c4e71d10..1282a485a4 100644 --- a/docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt +++ b/docs/atlascli/command/atlas-backups-compliancePolicy-policies-scheduled-create.txt @@ -38,7 +38,7 @@ Options * - --frequencyInterval - int - true - - Number that indicates the frequency interval for a set of snapshots. A value of 1 specifies the first instance of the corresponding frequencyType. In a monthly policy item, 1 indicates that the monthly snapshot occurs on the first day of the month and 40 indicates the last day of the month. In a weekly policy item, 1 indicates that the weekly snapshot occurs on Monday and 7 indicates Sunday. In an hourly policy item, you can set the frequency interval to 1, 2, 4, 6, 8, or 12. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only 12 as the frequency interval value. + - Number that indicates the frequency interval for a set of snapshots. A value of 1 specifies the first instance of the corresponding frequencyType. In a monthly policy item, 1 indicates that the monthly snapshot occurs on the first day of the month and 40 indicates the last day of the month. In a weekly policy item, 1 indicates that the weekly snapshot occurs on Monday and 7 indicates Sunday. In an hourly policy item, you can set the frequency interval to 1, 2, 4, 6, 8, or 12. For hourly policy items for NVMe clusters, Atlas accepts only 12 as the frequency interval value. * - --frequencyType - string - true @@ -58,11 +58,11 @@ Options * - --retentionUnit - string - true - - Unit of time in which MongoDB Cloud measures snapshot retention: 'days' 'weeks' 'months'. + - Unit of time in which Atlas measures snapshot retention: 'days' 'weeks' 'months'. * - --retentionValue - int - true - - Duration in days, weeks, or months that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items. + - Duration in days, weeks, or months that Atlas retains the snapshot. For less frequent policy items, Atlas requires that you specify a value greater than or equal to the value specified for more frequent policy items. * - -w, --watch - - false diff --git a/docs/atlascli/command/atlas-backups-compliancePolicy.txt b/docs/atlascli/command/atlas-backups-compliancePolicy.txt index 5dbae9b49e..2a58b1925f 100644 --- a/docs/atlascli/command/atlas-backups-compliancePolicy.txt +++ b/docs/atlascli/command/atlas-backups-compliancePolicy.txt @@ -53,7 +53,7 @@ Related Commands * :ref:`atlas-backups-compliancePolicy-copyProtection` - 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. * :ref:`atlas-backups-compliancePolicy-describe` - Return the backup compliance policy for your project. * :ref:`atlas-backups-compliancePolicy-enable` - Enable Backup Compliance Policy without any configuration. -* :ref:`atlas-backups-compliancePolicy-encryptionAtRest` - Manage Encryption at Rest of the backup compliance policy for your project. Encryption at rest enforces all clusters with a Backup Compliance Policy to use Customer Key Management. +* :ref:`atlas-backups-compliancePolicy-encryptionAtRest` - Manage encryption-at-rest for the backup compliance policy for your project. Encryption-at-rest enforces all clusters with a Backup Compliance Policy to use Customer Key Management. * :ref:`atlas-backups-compliancePolicy-pointInTimeRestores` - Manage whether the project uses Continuous Cloud Backups with a Backup Compliance Policy. Read more in the documentation: https://www.mongodb.com/docs/atlas/backup/cloud-backup/configure-backup-policy/#configure-the-restore-window. * :ref:`atlas-backups-compliancePolicy-policies` - Manage the individual policy items of the backup compliance policy for your project. * :ref:`atlas-backups-compliancePolicy-setup` - Setup the backup compliance policy for your project with a configuration file. diff --git a/internal/cli/atlas/backup/compliancepolicy/encryptionatrest/disable.go b/internal/cli/atlas/backup/compliancepolicy/encryptionatrest/disable.go index e25bfc544e..1c091377fb 100644 --- a/internal/cli/atlas/backup/compliancepolicy/encryptionatrest/disable.go +++ b/internal/cli/atlas/backup/compliancepolicy/encryptionatrest/disable.go @@ -82,7 +82,7 @@ func DisableBuilder() *cobra.Command { use := "disable" cmd := &cobra.Command{ Use: use, - Short: "Disable encryption at rest of the backup compliance policy for your project.", + Short: "Disable encryption-at-rest for the backup compliance policy for your project.", Args: require.NoArgs, PreRunE: func(cmd *cobra.Command, args []string) error { return opts.PreRunE( diff --git a/internal/cli/atlas/backup/compliancepolicy/encryptionatrest/enable.go b/internal/cli/atlas/backup/compliancepolicy/encryptionatrest/enable.go index 968fd0072a..aa4a1fffb7 100644 --- a/internal/cli/atlas/backup/compliancepolicy/encryptionatrest/enable.go +++ b/internal/cli/atlas/backup/compliancepolicy/encryptionatrest/enable.go @@ -83,7 +83,7 @@ func EnableBuilder() *cobra.Command { cmd := &cobra.Command{ Use: use, Args: require.NoArgs, - Short: "Enable encryption at rest of the backup compliance policy for your project.", + Short: "Enable encryption-at-rest for the backup compliance policy for your project.", PreRunE: func(cmd *cobra.Command, args []string) error { return opts.PreRunE( opts.ValidateProjectID, diff --git a/internal/cli/atlas/backup/compliancepolicy/encryptionatrest/encryptionatrest.go b/internal/cli/atlas/backup/compliancepolicy/encryptionatrest/encryptionatrest.go index e1a2b13195..f77a9998ad 100644 --- a/internal/cli/atlas/backup/compliancepolicy/encryptionatrest/encryptionatrest.go +++ b/internal/cli/atlas/backup/compliancepolicy/encryptionatrest/encryptionatrest.go @@ -28,7 +28,7 @@ func Builder() *cobra.Command { cmd := &cobra.Command{ Use: use, Aliases: cli.GenerateAliases(use), - Short: "Manage Encryption at Rest of the backup compliance policy for your project. Encryption at rest enforces all clusters with a Backup Compliance Policy to use Customer Key Management.", + Short: "Manage encryption-at-rest for the backup compliance policy for your project. Encryption-at-rest enforces all clusters with a Backup Compliance Policy to use Customer Key Management.", } cmd.AddCommand( diff --git a/internal/usage/usage.go b/internal/usage/usage.go index 83a7f418f6..3ecccf56eb 100644 --- a/internal/usage/usage.go +++ b/internal/usage/usage.go @@ -460,8 +460,8 @@ dbName and collection are required only for built-in roles.` ExporterDataFederationName = "One or more comma separated data federation names to import" DataFederationQueryLimitValue = "Value given to the query limit." OverrunPolicy = "Action to take when the usage limit is exceeded." - AuthorizedUserFirstName = "First name of the user who authorized to updated the Backup Compliance Policy settings." - AuthorizedUserLastName = "Last name of the user who authorized to updated the Backup Compliance Policy settings." + AuthorizedUserFirstName = "First name of the user who is authorized to update the Backup Compliance Policy settings." + AuthorizedUserLastName = "Last name of the user who is authorized to update the Backup Compliance Policy settings." AuthorizedEmail = "Email address of a security or legal representative." DeploymentType = "Type of deployment that you want to create. Valid values are ATLAS or LOCAL." MongodPort = "Port that the MongoDB server listens to for client connections." @@ -479,8 +479,8 @@ dbName and collection are required only for built-in roles.` "A value of 1 specifies the first instance of the corresponding frequencyType. " + "In a monthly policy item, 1 indicates that the monthly snapshot occurs on the first day of the month and 40 indicates the last day of the month. " + "In a weekly policy item, 1 indicates that the weekly snapshot occurs on Monday and 7 indicates Sunday. " + - "In an hourly policy item, you can set the frequency interval to 1, 2, 4, 6, 8, or 12. For hourly policy items for NVMe clusters, MongoDB Cloud accepts only 12 as the frequency interval value." - RetentionUnit = "Unit of time in which MongoDB Cloud measures snapshot retention: 'days' 'weeks' 'months'. " - RetentionValue = "Duration in days, weeks, or months that MongoDB Cloud retains the snapshot. For less frequent policy items, MongoDB Cloud requires that you specify a value greater than or equal to the value specified for more frequent policy items." + "In an hourly policy item, you can set the frequency interval to 1, 2, 4, 6, 8, or 12. For hourly policy items for NVMe clusters, Atlas accepts only 12 as the frequency interval value." + RetentionUnit = "Unit of time in which Atlas measures snapshot retention: 'days' 'weeks' 'months'. " + RetentionValue = "Duration in days, weeks, or months that Atlas retains the snapshot. For less frequent policy items, Atlas requires that you specify a value greater than or equal to the value specified for more frequent policy items." ScheduledPolicyID = "Unique identifier that Atlas assigns to the scheduled policy item." )