|
| 1 | +.. _mcli-atlas-datalake-update-command: |
| 2 | + |
| 3 | +============================== |
| 4 | +mongocli atlas datalake update |
| 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 | +The ``datalake update`` command updates a :datalake:`MongoDB Data Lake </>`. |
| 16 | +You can also update a {+data-lake-short+} through the :datalake:`Data Lake API |
| 17 | +</reference/api/dataLakes-update-one-tenant>` or with the |service| UI by |
| 18 | +selecting :guilabel:`Data Lake` from the left-side navigation. |
| 19 | + |
| 20 | +.. _mcli-atlas-datalake-update-syntax: |
| 21 | + |
| 22 | +Syntax |
| 23 | +------ |
| 24 | + |
| 25 | +.. code-block:: text |
| 26 | + |
| 27 | + mongocli atlas datalake update <datalake-name> |
| 28 | + [ --region <region> ] |
| 29 | + [ --role <role> ] |
| 30 | + [ --testBucket <bucket-name> ] |
| 31 | + [ --profile|-P <profile-name> ] |
| 32 | + [ --projectId <project-ID> ] |
| 33 | + |
| 34 | +.. _mcli-atlas-datalake-update-options: |
| 35 | + |
| 36 | +Options |
| 37 | +------- |
| 38 | + |
| 39 | +.. list-table:: |
| 40 | + :header-rows: 1 |
| 41 | + :widths: 20 10 60 10 |
| 42 | + |
| 43 | + * - Option |
| 44 | + - Type |
| 45 | + - Description |
| 46 | + - Required? |
| 47 | + |
| 48 | + * - ``<datalake-name>`` |
| 49 | + - string |
| 50 | + - Name of the {+data-lake-short+}. |
| 51 | + - yes |
| 52 | + |
| 53 | + * - ``--region`` |
| 54 | + - string |
| 55 | + - Name of the region to which Data Lake routes client connections for |
| 56 | + data processing. |
| 57 | + - no |
| 58 | + |
| 59 | + * - ``--role`` |
| 60 | + - string |
| 61 | + - :abbr:`ARN (Amazon Resource Name)` of the role which {+data-lake+} |
| 62 | + uses for accessing the data stores. |
| 63 | + - no |
| 64 | + |
| 65 | + * - ``--testBucket`` |
| 66 | + - string |
| 67 | + - Name of an |s3| data bucket which {+data-lake-short+} uses to validate |
| 68 | + the provided credentials. |
| 69 | + - no |
| 70 | + |
| 71 | + * - ``--profile``, ``-P`` |
| 72 | + - string |
| 73 | + - Name of the profile where the public and private |
| 74 | + keys for the project are set. If omitted, uses the |
| 75 | + {+default-profile+}. To learn more about creating a |
| 76 | + profile, see :ref:`mcli-configure`. |
| 77 | + - no |
| 78 | + |
| 79 | + * - ``--projectId`` |
| 80 | + - string |
| 81 | + - Unique identifier of the project where you want to |
| 82 | + create the cluster. If omitted, uses the project ID in |
| 83 | + the profile or :ref:`environment variable <mcli-env-var>`. |
| 84 | + - no |
| 85 | + |
| 86 | +.. _mcli-atlas-datalake-update-output: |
| 87 | + |
| 88 | +Output |
| 89 | +------ |
| 90 | + |
| 91 | +.. include:: /includes/command-output-intro.rst |
| 92 | + |
| 93 | +.. include:: /includes/atlas-datalake-output-fields.rst |
| 94 | + |
| 95 | +Example |
| 96 | +------- |
| 97 | + |
| 98 | +The following example uses the ``mongocli atlas datalake update`` command to |
| 99 | +update a {+data-lake-short+} named ``myDL`` in the specified project. It uses |
| 100 | +the {+default-profile+} to access the project. |
| 101 | + |
| 102 | +.. code-block:: sh |
| 103 | + |
| 104 | + mongocli atlas datalake update myDL --region OREGON_USA --projectId 5e2211c17a3e5a48f5497de3 |
| 105 | + |
| 106 | +The previous command prints the following fields in |json| format to the |
| 107 | +terminal. To learn more about these fields, see |
| 108 | +:ref:`mcli-atlas-datalake-update-output`. |
| 109 | + |
| 110 | +.. code-block:: json |
| 111 | + :copyable: false |
| 112 | + |
| 113 | + { |
| 114 | + "cloudProviderConfig": { |
| 115 | + "aws": { |
| 116 | + "iamAssumedRoleARN": "arn:aws:iam::772401394250:role/my-dl-role" |
| 117 | + } |
| 118 | + }, |
| 119 | + "dataProcessRegion": {}, |
| 120 | + "groupId": "5e2211c17a3e5a48f5497de3", |
| 121 | + "hostnames": [ |
| 122 | + "my-data-lake-r4xmn.c.query.mongodb.net" |
| 123 | + ], |
| 124 | + "name": "myDL", |
| 125 | + "state": "ACTIVE", |
| 126 | + "storage": { |
| 127 | + "databases": [ |
| 128 | + { |
| 129 | + "name": "data-lake-test", |
| 130 | + "collections": [ |
| 131 | + { |
| 132 | + "name": "data", |
| 133 | + "dataSources": [ |
| 134 | + { |
| 135 | + "storeName": "data-lake-test", |
| 136 | + "path": "data.json" |
| 137 | + } |
| 138 | + ] |
| 139 | + }, |
| 140 | + { |
| 141 | + "name": "*", |
| 142 | + "dataSources": [ |
| 143 | + { |
| 144 | + "storeName": "data-lake-test", |
| 145 | + "path": "{collectionName()}" |
| 146 | + } |
| 147 | + ] |
| 148 | + } |
| 149 | + ] |
| 150 | + } |
| 151 | + ], |
| 152 | + "stores": [ |
| 153 | + { |
| 154 | + "name": "data-lake-test", |
| 155 | + "provider": "s3", |
| 156 | + "region": "US_WEST_2", |
| 157 | + "bucket": "data-lake-test", |
| 158 | + "delimiter": "/", |
| 159 | + "includeTags": false |
| 160 | + } |
| 161 | + ] |
| 162 | + } |
| 163 | + } |
0 commit comments