-
Notifications
You must be signed in to change notification settings - Fork 84
/
Copy pathatlas-api-cloudBackups-createExportBucket.txt
178 lines (126 loc) · 5.53 KB
/
atlas-api-cloudBackups-createExportBucket.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
.. _atlas-api-cloudBackups-createExportBucket:
=========================================
atlas api cloudBackups createExportBucket
=========================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
.. blockquote::
Public Preview: please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli
Creates a Snapshot Export Bucket for an AWS S3 Bucket or Azure Blob Storage Container.
Once created, an snapshots can be exported to the Export Bucket and its referenced AWS S3 Bucket or Azure Blob Storage Container. To use this resource, the requesting Service Account or API Key must have the Project Owner role.
This command is autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Cloud-Backups/operation/createExportBucket.
For more information and examples, see the referenced API documentation linked above.
Syntax
------
.. code-block::
:caption: Command Syntax
atlas api cloudBackups createExportBucket [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
* - --envelope
- envelope
- false
- Flag that indicates whether Application wraps the response in an envelope JSON object. Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. Endpoints that return a list of results use the results object as an envelope. Application adds the status parameter to the response body.
* - --file
- string
- false
- path to your API request file. Leave empty to use standard input instead - you must provide one or the other, but not both.
* - --groupId
- string
- true
- Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access.
**NOTE**: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups.
* - -h, --help
-
- false
- help for createExportBucket
* - --output
- string
- false
- preferred api format, can be ["json", go-template] This value defaults to "json".
* - --output-file
- string
- false
- file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip)
* - --pretty
-
- false
- Flag that indicates whether the response body should be in the prettyprint format.
* - --version
- string
- false
- api version to use when calling the api call [options: "2023-01-01", "2024-05-30"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2024-05-30".
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
-----------------
.. tabs::
.. tab:: Example
:tabid: 2023-01-01_aws
AWS
Create the file below and save it as ``payload.json``
.. code-block::
{
"bucketName": "export-bucket",
"cloudProvider": "AWS",
"iamRoleId": "668c5f0ed436263134491592"
}
.. Code end marker, please don't delete this comment
After creating `payload.json`, run the command below in the same directory.
.. code-block::
atlas api cloudBackups createExportBucket --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8
.. Code end marker, please don't delete this comment
.. tab:: Example 1
:tabid: 2024-05-30_aws
AWS
Create the file below and save it as ``payload.json``
.. code-block::
{
"bucketName": "export-bucket",
"cloudProvider": "AWS",
"iamRoleId": "668c5f0ed436263134491592"
}
.. Code end marker, please don't delete this comment
After creating `payload.json`, run the command below in the same directory.
.. code-block::
atlas api cloudBackups createExportBucket --version 2024-05-30 --file payload.json --groupId 32b6e34b3d91647abb20e7b8
.. Code end marker, please don't delete this comment
.. tab:: Example 2
:tabid: 2024-05-30_azure
Azure
Create the file below and save it as ``payload.json``
.. code-block::
{
"bucketName": "examplecontainer",
"cloudProvider": "AZURE",
"roleId": "668c5f0ed436263134491592",
"serviceUrl": "https://examplestorageaccount.blob.core.windows.net/examplecontainer"
}
.. Code end marker, please don't delete this comment
After creating `payload.json`, run the command below in the same directory.
.. code-block::
atlas api cloudBackups createExportBucket --version 2024-05-30 --file payload.json --groupId 32b6e34b3d91647abb20e7b8
.. Code end marker, please don't delete this comment