@pulumi/mongodbatlas 3.11.0 → 3.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/alertConfiguration.d.ts +9 -4
- package/alertConfiguration.js +3 -1
- package/alertConfiguration.js.map +1 -1
- package/cloudProviderAccess.d.ts +1 -1
- package/cloudProviderAccess.js +1 -1
- package/get509AuthenticationDatabaseUser.d.ts +2 -58
- package/get509AuthenticationDatabaseUser.js +3 -58
- package/get509AuthenticationDatabaseUser.js.map +1 -1
- package/getAlertConfiguration.d.ts +9 -0
- package/getAlertConfiguration.js.map +1 -1
- package/getOnlineArchive.d.ts +19 -2
- package/getOnlineArchive.js +18 -2
- package/getOnlineArchive.js.map +1 -1
- package/getOnlineArchives.d.ts +44 -28
- package/getOnlineArchives.js +44 -28
- package/getOnlineArchives.js.map +1 -1
- package/getX509AuthenticationDatabaseUser.d.ts +64 -0
- package/getX509AuthenticationDatabaseUser.js +38 -0
- package/getX509AuthenticationDatabaseUser.js.map +1 -0
- package/index.d.ts +3 -18
- package/index.js +8 -27
- package/index.js.map +1 -1
- package/onlineArchive.d.ts +33 -12
- package/onlineArchive.js +2 -0
- package/onlineArchive.js.map +1 -1
- package/package.json +1 -1
- package/types/input.d.ts +10 -53
- package/types/output.d.ts +151 -227
- package/dataLake.d.ts +0 -204
- package/dataLake.js +0 -107
- package/dataLake.js.map +0 -1
- package/getDataLake.d.ts +0 -100
- package/getDataLake.js +0 -30
- package/getDataLake.js.map +0 -1
- package/getDataLakes.d.ts +0 -68
- package/getDataLakes.js +0 -51
- package/getDataLakes.js.map +0 -1
- package/getPrivatelinkEndpointServiceAdl.d.ts +0 -66
- package/getPrivatelinkEndpointServiceAdl.js +0 -34
- package/getPrivatelinkEndpointServiceAdl.js.map +0 -1
- package/getPrivatelinkEndpointsServiceAdl.d.ts +0 -89
- package/getPrivatelinkEndpointsServiceAdl.js +0 -65
- package/getPrivatelinkEndpointsServiceAdl.js.map +0 -1
- package/privatelinkEndpointServiceAdl.d.ts +0 -125
- package/privatelinkEndpointServiceAdl.js +0 -98
- package/privatelinkEndpointServiceAdl.js.map +0 -1
package/alertConfiguration.d.ts
CHANGED
|
@@ -128,7 +128,9 @@ import * as outputs from "./types/output";
|
|
|
128
128
|
* ```sh
|
|
129
129
|
* $ pulumi import mongodbatlas:index/alertConfiguration:AlertConfiguration test 5d0f1f74cf09a29120e123cd-5d0f1f74cf09a29120e1fscg
|
|
130
130
|
* ```
|
|
131
|
-
*
|
|
131
|
+
* __NOTE__Third-party notifications will not contain their respective credentials as these are sensitive attributes. If you wish to perform updates on these notifications without providing the original credentials, the corresponding `notifier_id` attribute must be provided instead.
|
|
132
|
+
*
|
|
133
|
+
* For more information see[MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/alert-configurations/)
|
|
132
134
|
*/
|
|
133
135
|
export declare class AlertConfiguration extends pulumi.CustomResource {
|
|
134
136
|
/**
|
|
@@ -161,7 +163,8 @@ export declare class AlertConfiguration extends pulumi.CustomResource {
|
|
|
161
163
|
/**
|
|
162
164
|
* The type of event that will trigger an alert.
|
|
163
165
|
*
|
|
164
|
-
* > ***IMPORTANT:*** Event Type has many possible values.
|
|
166
|
+
* > ***IMPORTANT:*** Event Type has many possible values. Details for both conditional and metric based alerts can be found by selecting the tabs on the [alert config page](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration) and checking the latest eventTypeName options.
|
|
167
|
+
*
|
|
165
168
|
*
|
|
166
169
|
* > **NOTE:** If `eventType` is set to `OUTSIDE_METRIC_THRESHOLD` or `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`, the `metricThresholdConfig` field must also be configured.
|
|
167
170
|
*/
|
|
@@ -206,7 +209,8 @@ export interface AlertConfigurationState {
|
|
|
206
209
|
/**
|
|
207
210
|
* The type of event that will trigger an alert.
|
|
208
211
|
*
|
|
209
|
-
* > ***IMPORTANT:*** Event Type has many possible values.
|
|
212
|
+
* > ***IMPORTANT:*** Event Type has many possible values. Details for both conditional and metric based alerts can be found by selecting the tabs on the [alert config page](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration) and checking the latest eventTypeName options.
|
|
213
|
+
*
|
|
210
214
|
*
|
|
211
215
|
* > **NOTE:** If `eventType` is set to `OUTSIDE_METRIC_THRESHOLD` or `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`, the `metricThresholdConfig` field must also be configured.
|
|
212
216
|
*/
|
|
@@ -235,7 +239,8 @@ export interface AlertConfigurationArgs {
|
|
|
235
239
|
/**
|
|
236
240
|
* The type of event that will trigger an alert.
|
|
237
241
|
*
|
|
238
|
-
* > ***IMPORTANT:*** Event Type has many possible values.
|
|
242
|
+
* > ***IMPORTANT:*** Event Type has many possible values. Details for both conditional and metric based alerts can be found by selecting the tabs on the [alert config page](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Alert-Configurations/operation/createAlertConfiguration) and checking the latest eventTypeName options.
|
|
243
|
+
*
|
|
239
244
|
*
|
|
240
245
|
* > **NOTE:** If `eventType` is set to `OUTSIDE_METRIC_THRESHOLD` or `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`, the `metricThresholdConfig` field must also be configured.
|
|
241
246
|
*/
|
package/alertConfiguration.js
CHANGED
|
@@ -132,7 +132,9 @@ const utilities = require("./utilities");
|
|
|
132
132
|
* ```sh
|
|
133
133
|
* $ pulumi import mongodbatlas:index/alertConfiguration:AlertConfiguration test 5d0f1f74cf09a29120e123cd-5d0f1f74cf09a29120e1fscg
|
|
134
134
|
* ```
|
|
135
|
-
*
|
|
135
|
+
* __NOTE__Third-party notifications will not contain their respective credentials as these are sensitive attributes. If you wish to perform updates on these notifications without providing the original credentials, the corresponding `notifier_id` attribute must be provided instead.
|
|
136
|
+
*
|
|
137
|
+
* For more information see[MongoDB Atlas API Reference.](https://docs.atlas.mongodb.com/reference/api/alert-configurations/)
|
|
136
138
|
*/
|
|
137
139
|
class AlertConfiguration extends pulumi.CustomResource {
|
|
138
140
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alertConfiguration.js","sourceRoot":"","sources":["../alertConfiguration.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC
|
|
1
|
+
{"version":3,"file":"alertConfiguration.js","sourceRoot":"","sources":["../alertConfiguration.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkIG;AACH,MAAa,kBAAmB,SAAQ,MAAM,CAAC,cAAc;IACzD;;;;;;;;OAQG;IACI,MAAM,CAAC,GAAG,CAAC,IAAY,EAAE,EAA2B,EAAE,KAA+B,EAAE,IAAmC;QAC7H,OAAO,IAAI,kBAAkB,CAAC,IAAI,EAAO,KAAK,kCAAO,IAAI,KAAE,EAAE,EAAE,EAAE,IAAG,CAAC;IACzE,CAAC;IAKD;;;OAGG;IACI,MAAM,CAAC,UAAU,CAAC,GAAQ;QAC7B,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,IAAI,EAAE;YACnC,OAAO,KAAK,CAAC;SAChB;QACD,OAAO,GAAG,CAAC,cAAc,CAAC,KAAK,kBAAkB,CAAC,YAAY,CAAC;IACnE,CAAC;IA4CD,YAAY,IAAY,EAAE,WAA8D,EAAE,IAAmC;QACzH,IAAI,cAAc,GAAkB,EAAE,CAAC;QACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAClB,IAAI,IAAI,CAAC,EAAE,EAAE;YACT,MAAM,KAAK,GAAG,WAAkD,CAAC;YACjE,cAAc,CAAC,sBAAsB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,uBAAuB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1F,cAAc,CAAC,eAAe,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YAC1E,cAAc,CAAC,WAAW,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAClE,cAAc,CAAC,iBAAiB,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9E,cAAc,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;SACjE;aAAM;YACH,MAAM,IAAI,GAAG,WAAiD,CAAC;YAC/D,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;YACD,IAAI,CAAC,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;aAC5D;YACD,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5D,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,CAAC;YAC9D,cAAc,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,SAAS,CAAC;YACxF,cAAc,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC;YACxE,cAAc,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;YAChE,cAAc,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;YAC5E,cAAc,CAAC,sBAAsB,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC3D,cAAc,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;YAC9C,cAAc,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,OAAO,CAAC;SACjD;QACD,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,CAAC,CAAC;QACnE,KAAK,CAAC,kBAAkB,CAAC,YAAY,EAAE,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,CAAC;IACvE,CAAC;;AA1GL,gDA2GC;AA7FG,gBAAgB;AACO,+BAAY,GAAG,0DAA0D,CAAC"}
|
package/cloudProviderAccess.d.ts
CHANGED
|
@@ -42,7 +42,7 @@ import * as outputs from "./types/output";
|
|
|
42
42
|
* ```
|
|
43
43
|
* ## Authorize role
|
|
44
44
|
*
|
|
45
|
-
* Once the resource is created add the field `
|
|
45
|
+
* Once the resource is created add the field `iamAssumedRoleArn` see [Set Up Unified AWS Access](https://docs.atlas.mongodb.com/security/set-up-unified-aws-access/#set-up-unified-aws-access) , and execute a new `pulumi up` this will create a PATCH request.
|
|
46
46
|
*
|
|
47
47
|
* ```typescript
|
|
48
48
|
* import * as pulumi from "@pulumi/pulumi";
|
package/cloudProviderAccess.js
CHANGED
|
@@ -46,7 +46,7 @@ const utilities = require("./utilities");
|
|
|
46
46
|
* ```
|
|
47
47
|
* ## Authorize role
|
|
48
48
|
*
|
|
49
|
-
* Once the resource is created add the field `
|
|
49
|
+
* Once the resource is created add the field `iamAssumedRoleArn` see [Set Up Unified AWS Access](https://docs.atlas.mongodb.com/security/set-up-unified-aws-access/#set-up-unified-aws-access) , and execute a new `pulumi up` this will create a PATCH request.
|
|
50
50
|
*
|
|
51
51
|
* ```typescript
|
|
52
52
|
* import * as pulumi from "@pulumi/pulumi";
|
|
@@ -8,36 +8,8 @@ import * as outputs from "./types/output";
|
|
|
8
8
|
* ## Example Usage
|
|
9
9
|
*
|
|
10
10
|
* ### S
|
|
11
|
-
* ### Example Usage: Save a customer-managed X.509 configuration for an Atlas project
|
|
12
|
-
* ```typescript
|
|
13
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
14
|
-
* import * as mongodbatlas from "@pulumi/mongodbatlas";
|
|
15
|
-
*
|
|
16
|
-
* const testX509AuthenticationDatabaseUser = new mongodbatlas.X509AuthenticationDatabaseUser("testX509AuthenticationDatabaseUser", {
|
|
17
|
-
* projectId: "<PROJECT-ID>",
|
|
18
|
-
* customerX509Cas: `-----BEGIN CERTIFICATE-----
|
|
19
|
-
* MIICmTCCAgICCQDZnHzklxsT9TANBgkqhkiG9w0BAQsFADCBkDELMAkGA1UEBhMC
|
|
20
|
-
* VVMxDjAMBgNVBAgMBVRleGFzMQ8wDQYDVQQHDAZBdXN0aW4xETAPBgNVBAoMCHRl
|
|
21
|
-
* c3QuY29tMQ0wCwYDVQQLDARUZXN0MREwDwYDVQQDDAh0ZXN0LmNvbTErMCkGCSqG
|
|
22
|
-
* SIb3DQEJARYcbWVsaXNzYS5wbHVua2V0dEBtb25nb2RiLmNvbTAeFw0yMDAyMDQy
|
|
23
|
-
* MDQ2MDFaFw0yMTAyMDMyMDQ2MDFaMIGQMQswCQYDVQQGEwJVUzEOMAwGA1UECAwF
|
|
24
|
-
* VGV4YXMxDzANBgNVBAcMBkF1c3RpbjERMA8GA1UECgwIdGVzdC5jb20xDTALBgNV
|
|
25
|
-
* BAsMBFRlc3QxETAPBgNVBAMMCHRlc3QuY29tMSswKQYJKoZIhvcNAQkBFhxtZWxp
|
|
26
|
-
* c3NhLnBsdW5rZXR0QG1vbmdvZGIuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCB
|
|
27
|
-
* iQKBgQCf1LRqr1zftzdYx2Aj9G76tb0noMPtj6faGLlPji1+m6Rn7RWD9L0ntWAr
|
|
28
|
-
* cURxvypa9jZ9MXFzDtLevvd3tHEmfrUT3ukNDX6+Jtc4kWm+Dh2A70Pd+deKZ2/O
|
|
29
|
-
* Fh8audEKAESGXnTbeJCeQa1XKlIkjqQHBNwES5h1b9vJtFoLJwIDAQABMA0GCSqG
|
|
30
|
-
* SIb3DQEBCwUAA4GBADMUncjEPV/MiZUcVNGmktP6BPmEqMXQWUDpdGW2+Tg2JtUA
|
|
31
|
-
* 7MMILtepBkFzLO+GlpZxeAlXO0wxiNgEmCRONgh4+t2w3e7a8GFijYQ99FHrAC5A
|
|
32
|
-
* iul59bdl18gVqXia1Yeq/iK7Ohfy/Jwd7Hsm530elwkM/ZEkYDjBlZSXYdyz
|
|
33
|
-
* -----END CERTIFICATE-----"
|
|
34
|
-
* `,
|
|
35
|
-
* });
|
|
36
|
-
* const test509AuthenticationDatabaseUser = mongodbatlas.get509AuthenticationDatabaseUserOutput({
|
|
37
|
-
* projectId: testX509AuthenticationDatabaseUser.projectId,
|
|
38
|
-
* });
|
|
39
|
-
* ```
|
|
40
11
|
*/
|
|
12
|
+
/** @deprecated mongodbatlas.index/get509authenticationdatabaseuser.get509AuthenticationDatabaseUser has been deprecated in favor of mongodbatlas.index/getx509authenticationdatabaseuser.getX509AuthenticationDatabaseUser */
|
|
41
13
|
export declare function get509AuthenticationDatabaseUser(args: Get509AuthenticationDatabaseUserArgs, opts?: pulumi.InvokeOptions): Promise<Get509AuthenticationDatabaseUserResult>;
|
|
42
14
|
/**
|
|
43
15
|
* A collection of arguments for invoking get509AuthenticationDatabaseUser.
|
|
@@ -76,36 +48,8 @@ export interface Get509AuthenticationDatabaseUserResult {
|
|
|
76
48
|
* ## Example Usage
|
|
77
49
|
*
|
|
78
50
|
* ### S
|
|
79
|
-
* ### Example Usage: Save a customer-managed X.509 configuration for an Atlas project
|
|
80
|
-
* ```typescript
|
|
81
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
82
|
-
* import * as mongodbatlas from "@pulumi/mongodbatlas";
|
|
83
|
-
*
|
|
84
|
-
* const testX509AuthenticationDatabaseUser = new mongodbatlas.X509AuthenticationDatabaseUser("testX509AuthenticationDatabaseUser", {
|
|
85
|
-
* projectId: "<PROJECT-ID>",
|
|
86
|
-
* customerX509Cas: `-----BEGIN CERTIFICATE-----
|
|
87
|
-
* MIICmTCCAgICCQDZnHzklxsT9TANBgkqhkiG9w0BAQsFADCBkDELMAkGA1UEBhMC
|
|
88
|
-
* VVMxDjAMBgNVBAgMBVRleGFzMQ8wDQYDVQQHDAZBdXN0aW4xETAPBgNVBAoMCHRl
|
|
89
|
-
* c3QuY29tMQ0wCwYDVQQLDARUZXN0MREwDwYDVQQDDAh0ZXN0LmNvbTErMCkGCSqG
|
|
90
|
-
* SIb3DQEJARYcbWVsaXNzYS5wbHVua2V0dEBtb25nb2RiLmNvbTAeFw0yMDAyMDQy
|
|
91
|
-
* MDQ2MDFaFw0yMTAyMDMyMDQ2MDFaMIGQMQswCQYDVQQGEwJVUzEOMAwGA1UECAwF
|
|
92
|
-
* VGV4YXMxDzANBgNVBAcMBkF1c3RpbjERMA8GA1UECgwIdGVzdC5jb20xDTALBgNV
|
|
93
|
-
* BAsMBFRlc3QxETAPBgNVBAMMCHRlc3QuY29tMSswKQYJKoZIhvcNAQkBFhxtZWxp
|
|
94
|
-
* c3NhLnBsdW5rZXR0QG1vbmdvZGIuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCB
|
|
95
|
-
* iQKBgQCf1LRqr1zftzdYx2Aj9G76tb0noMPtj6faGLlPji1+m6Rn7RWD9L0ntWAr
|
|
96
|
-
* cURxvypa9jZ9MXFzDtLevvd3tHEmfrUT3ukNDX6+Jtc4kWm+Dh2A70Pd+deKZ2/O
|
|
97
|
-
* Fh8audEKAESGXnTbeJCeQa1XKlIkjqQHBNwES5h1b9vJtFoLJwIDAQABMA0GCSqG
|
|
98
|
-
* SIb3DQEBCwUAA4GBADMUncjEPV/MiZUcVNGmktP6BPmEqMXQWUDpdGW2+Tg2JtUA
|
|
99
|
-
* 7MMILtepBkFzLO+GlpZxeAlXO0wxiNgEmCRONgh4+t2w3e7a8GFijYQ99FHrAC5A
|
|
100
|
-
* iul59bdl18gVqXia1Yeq/iK7Ohfy/Jwd7Hsm530elwkM/ZEkYDjBlZSXYdyz
|
|
101
|
-
* -----END CERTIFICATE-----"
|
|
102
|
-
* `,
|
|
103
|
-
* });
|
|
104
|
-
* const test509AuthenticationDatabaseUser = mongodbatlas.get509AuthenticationDatabaseUserOutput({
|
|
105
|
-
* projectId: testX509AuthenticationDatabaseUser.projectId,
|
|
106
|
-
* });
|
|
107
|
-
* ```
|
|
108
51
|
*/
|
|
52
|
+
/** @deprecated mongodbatlas.index/get509authenticationdatabaseuser.get509AuthenticationDatabaseUser has been deprecated in favor of mongodbatlas.index/getx509authenticationdatabaseuser.getX509AuthenticationDatabaseUser */
|
|
109
53
|
export declare function get509AuthenticationDatabaseUserOutput(args: Get509AuthenticationDatabaseUserOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<Get509AuthenticationDatabaseUserResult>;
|
|
110
54
|
/**
|
|
111
55
|
* A collection of arguments for invoking get509AuthenticationDatabaseUser.
|
|
@@ -13,37 +13,10 @@ const utilities = require("./utilities");
|
|
|
13
13
|
* ## Example Usage
|
|
14
14
|
*
|
|
15
15
|
* ### S
|
|
16
|
-
* ### Example Usage: Save a customer-managed X.509 configuration for an Atlas project
|
|
17
|
-
* ```typescript
|
|
18
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
19
|
-
* import * as mongodbatlas from "@pulumi/mongodbatlas";
|
|
20
|
-
*
|
|
21
|
-
* const testX509AuthenticationDatabaseUser = new mongodbatlas.X509AuthenticationDatabaseUser("testX509AuthenticationDatabaseUser", {
|
|
22
|
-
* projectId: "<PROJECT-ID>",
|
|
23
|
-
* customerX509Cas: `-----BEGIN CERTIFICATE-----
|
|
24
|
-
* MIICmTCCAgICCQDZnHzklxsT9TANBgkqhkiG9w0BAQsFADCBkDELMAkGA1UEBhMC
|
|
25
|
-
* VVMxDjAMBgNVBAgMBVRleGFzMQ8wDQYDVQQHDAZBdXN0aW4xETAPBgNVBAoMCHRl
|
|
26
|
-
* c3QuY29tMQ0wCwYDVQQLDARUZXN0MREwDwYDVQQDDAh0ZXN0LmNvbTErMCkGCSqG
|
|
27
|
-
* SIb3DQEJARYcbWVsaXNzYS5wbHVua2V0dEBtb25nb2RiLmNvbTAeFw0yMDAyMDQy
|
|
28
|
-
* MDQ2MDFaFw0yMTAyMDMyMDQ2MDFaMIGQMQswCQYDVQQGEwJVUzEOMAwGA1UECAwF
|
|
29
|
-
* VGV4YXMxDzANBgNVBAcMBkF1c3RpbjERMA8GA1UECgwIdGVzdC5jb20xDTALBgNV
|
|
30
|
-
* BAsMBFRlc3QxETAPBgNVBAMMCHRlc3QuY29tMSswKQYJKoZIhvcNAQkBFhxtZWxp
|
|
31
|
-
* c3NhLnBsdW5rZXR0QG1vbmdvZGIuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCB
|
|
32
|
-
* iQKBgQCf1LRqr1zftzdYx2Aj9G76tb0noMPtj6faGLlPji1+m6Rn7RWD9L0ntWAr
|
|
33
|
-
* cURxvypa9jZ9MXFzDtLevvd3tHEmfrUT3ukNDX6+Jtc4kWm+Dh2A70Pd+deKZ2/O
|
|
34
|
-
* Fh8audEKAESGXnTbeJCeQa1XKlIkjqQHBNwES5h1b9vJtFoLJwIDAQABMA0GCSqG
|
|
35
|
-
* SIb3DQEBCwUAA4GBADMUncjEPV/MiZUcVNGmktP6BPmEqMXQWUDpdGW2+Tg2JtUA
|
|
36
|
-
* 7MMILtepBkFzLO+GlpZxeAlXO0wxiNgEmCRONgh4+t2w3e7a8GFijYQ99FHrAC5A
|
|
37
|
-
* iul59bdl18gVqXia1Yeq/iK7Ohfy/Jwd7Hsm530elwkM/ZEkYDjBlZSXYdyz
|
|
38
|
-
* -----END CERTIFICATE-----"
|
|
39
|
-
* `,
|
|
40
|
-
* });
|
|
41
|
-
* const test509AuthenticationDatabaseUser = mongodbatlas.get509AuthenticationDatabaseUserOutput({
|
|
42
|
-
* projectId: testX509AuthenticationDatabaseUser.projectId,
|
|
43
|
-
* });
|
|
44
|
-
* ```
|
|
45
16
|
*/
|
|
17
|
+
/** @deprecated mongodbatlas.index/get509authenticationdatabaseuser.get509AuthenticationDatabaseUser has been deprecated in favor of mongodbatlas.index/getx509authenticationdatabaseuser.getX509AuthenticationDatabaseUser */
|
|
46
18
|
function get509AuthenticationDatabaseUser(args, opts) {
|
|
19
|
+
pulumi.log.warn("get509AuthenticationDatabaseUser is deprecated: mongodbatlas.index/get509authenticationdatabaseuser.get509AuthenticationDatabaseUser has been deprecated in favor of mongodbatlas.index/getx509authenticationdatabaseuser.getX509AuthenticationDatabaseUser");
|
|
47
20
|
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
|
|
48
21
|
return pulumi.runtime.invoke("mongodbatlas:index/get509AuthenticationDatabaseUser:get509AuthenticationDatabaseUser", {
|
|
49
22
|
"projectId": args.projectId,
|
|
@@ -59,36 +32,8 @@ exports.get509AuthenticationDatabaseUser = get509AuthenticationDatabaseUser;
|
|
|
59
32
|
* ## Example Usage
|
|
60
33
|
*
|
|
61
34
|
* ### S
|
|
62
|
-
* ### Example Usage: Save a customer-managed X.509 configuration for an Atlas project
|
|
63
|
-
* ```typescript
|
|
64
|
-
* import * as pulumi from "@pulumi/pulumi";
|
|
65
|
-
* import * as mongodbatlas from "@pulumi/mongodbatlas";
|
|
66
|
-
*
|
|
67
|
-
* const testX509AuthenticationDatabaseUser = new mongodbatlas.X509AuthenticationDatabaseUser("testX509AuthenticationDatabaseUser", {
|
|
68
|
-
* projectId: "<PROJECT-ID>",
|
|
69
|
-
* customerX509Cas: `-----BEGIN CERTIFICATE-----
|
|
70
|
-
* MIICmTCCAgICCQDZnHzklxsT9TANBgkqhkiG9w0BAQsFADCBkDELMAkGA1UEBhMC
|
|
71
|
-
* VVMxDjAMBgNVBAgMBVRleGFzMQ8wDQYDVQQHDAZBdXN0aW4xETAPBgNVBAoMCHRl
|
|
72
|
-
* c3QuY29tMQ0wCwYDVQQLDARUZXN0MREwDwYDVQQDDAh0ZXN0LmNvbTErMCkGCSqG
|
|
73
|
-
* SIb3DQEJARYcbWVsaXNzYS5wbHVua2V0dEBtb25nb2RiLmNvbTAeFw0yMDAyMDQy
|
|
74
|
-
* MDQ2MDFaFw0yMTAyMDMyMDQ2MDFaMIGQMQswCQYDVQQGEwJVUzEOMAwGA1UECAwF
|
|
75
|
-
* VGV4YXMxDzANBgNVBAcMBkF1c3RpbjERMA8GA1UECgwIdGVzdC5jb20xDTALBgNV
|
|
76
|
-
* BAsMBFRlc3QxETAPBgNVBAMMCHRlc3QuY29tMSswKQYJKoZIhvcNAQkBFhxtZWxp
|
|
77
|
-
* c3NhLnBsdW5rZXR0QG1vbmdvZGIuY29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCB
|
|
78
|
-
* iQKBgQCf1LRqr1zftzdYx2Aj9G76tb0noMPtj6faGLlPji1+m6Rn7RWD9L0ntWAr
|
|
79
|
-
* cURxvypa9jZ9MXFzDtLevvd3tHEmfrUT3ukNDX6+Jtc4kWm+Dh2A70Pd+deKZ2/O
|
|
80
|
-
* Fh8audEKAESGXnTbeJCeQa1XKlIkjqQHBNwES5h1b9vJtFoLJwIDAQABMA0GCSqG
|
|
81
|
-
* SIb3DQEBCwUAA4GBADMUncjEPV/MiZUcVNGmktP6BPmEqMXQWUDpdGW2+Tg2JtUA
|
|
82
|
-
* 7MMILtepBkFzLO+GlpZxeAlXO0wxiNgEmCRONgh4+t2w3e7a8GFijYQ99FHrAC5A
|
|
83
|
-
* iul59bdl18gVqXia1Yeq/iK7Ohfy/Jwd7Hsm530elwkM/ZEkYDjBlZSXYdyz
|
|
84
|
-
* -----END CERTIFICATE-----"
|
|
85
|
-
* `,
|
|
86
|
-
* });
|
|
87
|
-
* const test509AuthenticationDatabaseUser = mongodbatlas.get509AuthenticationDatabaseUserOutput({
|
|
88
|
-
* projectId: testX509AuthenticationDatabaseUser.projectId,
|
|
89
|
-
* });
|
|
90
|
-
* ```
|
|
91
35
|
*/
|
|
36
|
+
/** @deprecated mongodbatlas.index/get509authenticationdatabaseuser.get509AuthenticationDatabaseUser has been deprecated in favor of mongodbatlas.index/getx509authenticationdatabaseuser.getX509AuthenticationDatabaseUser */
|
|
92
37
|
function get509AuthenticationDatabaseUserOutput(args, opts) {
|
|
93
38
|
return pulumi.output(args).apply((a) => get509AuthenticationDatabaseUser(a, opts));
|
|
94
39
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"get509AuthenticationDatabaseUser.js","sourceRoot":"","sources":["../get509AuthenticationDatabaseUser.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC
|
|
1
|
+
{"version":3,"file":"get509AuthenticationDatabaseUser.js","sourceRoot":"","sources":["../get509AuthenticationDatabaseUser.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;GAQG;AACH,8NAA8N;AAC9N,SAAgB,gCAAgC,CAAC,IAA0C,EAAE,IAA2B;IACpH,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,6PAA6P,CAAC,CAAA;IAE9Q,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,sFAAsF,EAAE;QACjH,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,UAAU,EAAE,IAAI,CAAC,QAAQ;KAC5B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AARD,4EAQC;AAgCD;;;;;;;;GAQG;AACH,8NAA8N;AAC9N,SAAgB,sCAAsC,CAAC,IAAgD,EAAE,IAA2B;IAChI,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,gCAAgC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC3F,CAAC;AAFD,wFAEC"}
|
|
@@ -43,11 +43,20 @@ export interface GetAlertConfigurationResult {
|
|
|
43
43
|
*/
|
|
44
44
|
readonly eventType: string;
|
|
45
45
|
readonly id: string;
|
|
46
|
+
/**
|
|
47
|
+
* Rules to apply when matching an object against this alert configuration. See matchers.
|
|
48
|
+
*/
|
|
46
49
|
readonly matchers: outputs.GetAlertConfigurationMatcher[];
|
|
50
|
+
/**
|
|
51
|
+
* The threshold that causes an alert to be triggered. Required if `eventTypeName` : `OUTSIDE_METRIC_THRESHOLD` or `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`. See metric threshold config.
|
|
52
|
+
*/
|
|
47
53
|
readonly metricThresholdConfigs: outputs.GetAlertConfigurationMetricThresholdConfig[];
|
|
48
54
|
readonly notifications: outputs.GetAlertConfigurationNotification[];
|
|
49
55
|
readonly outputs?: outputs.GetAlertConfigurationOutput[];
|
|
50
56
|
readonly projectId: string;
|
|
57
|
+
/**
|
|
58
|
+
* Threshold that triggers an alert. Required if `eventTypeName` is any value other than `OUTSIDE_METRIC_THRESHOLD` or `OUTSIDE_SERVERLESS_METRIC_THRESHOLD`. See threshold config.
|
|
59
|
+
*/
|
|
51
60
|
readonly thresholdConfigs: outputs.GetAlertConfigurationThresholdConfig[];
|
|
52
61
|
/**
|
|
53
62
|
* Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getAlertConfiguration.js","sourceRoot":"","sources":["../getAlertConfiguration.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,IAA+B,EAAE,IAA2B;IAE9F,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gEAAgE,EAAE;QAC3F,sBAAsB,EAAE,IAAI,CAAC,oBAAoB;QACjD,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AARD,sDAQC;
|
|
1
|
+
{"version":3,"file":"getAlertConfiguration.js","sourceRoot":"","sources":["../getAlertConfiguration.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;GAIG;AACH,SAAgB,qBAAqB,CAAC,IAA+B,EAAE,IAA2B;IAE9F,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gEAAgE,EAAE;QAC3F,sBAAsB,EAAE,IAAI,CAAC,oBAAoB;QACjD,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AARD,sDAQC;AA2DD;;;;GAIG;AACH,SAAgB,2BAA2B,CAAC,IAAqC,EAAE,IAA2B;IAC1G,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,qBAAqB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAChF,CAAC;AAFD,kEAEC"}
|
package/getOnlineArchive.d.ts
CHANGED
|
@@ -21,7 +21,12 @@ import * as outputs from "./types/output";
|
|
|
21
21
|
*
|
|
22
22
|
* * `dbName` - Name of the database that contains the collection.
|
|
23
23
|
* * `collName` - Name of the collection.
|
|
24
|
-
* * `collectionType` -
|
|
24
|
+
* * `collectionType` - Type of MongoDB collection that you want to return. This value can be "TIMESERIES" or "STANDARD". Default is "STANDARD".
|
|
25
|
+
* * `criteria` - Criteria to use for archiving data. See criteria.
|
|
26
|
+
* * `dataExpirationRule` - Rule for specifying when data should be deleted from the archive. See data expiration rule.
|
|
27
|
+
* * `schedule` - Regular frequency and duration when archiving process occurs. See schedule.
|
|
28
|
+
* * `partitionFields` - Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Queries that don’t contain the specified fields require a full collection scan of all archived documents, which takes longer and increases your costs. To learn more about how partition improves query performance, see [Data Structure in S3](https://docs.mongodb.com/datalake/admin/optimize-query-performance/#data-structure-in-s3). The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived. See partition fields.
|
|
29
|
+
* * `paused` - State of the online archive. This is required for pausing an active online archive or resuming a paused online archive. If the collection has another active online archive, the resume request fails.
|
|
25
30
|
* * `state` - Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted
|
|
26
31
|
*
|
|
27
32
|
* ### Criteria
|
|
@@ -31,6 +36,9 @@ import * as outputs from "./types/output";
|
|
|
31
36
|
* * `expireAfterDays` - Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when `type` is `DATE`.
|
|
32
37
|
* * `query` - JSON query to use to select documents for archiving. Atlas uses the specified query with the db.collection.find(query) command. The empty document {} to return all documents is not supported. Set this parameter when `type` is `CUSTOM`.
|
|
33
38
|
*
|
|
39
|
+
* ### Data Expiration Rule
|
|
40
|
+
* * `expireAfterDays` - Number of days used in the date criteria for nominating documents for deletion. Value must be between 7 and 9215.
|
|
41
|
+
*
|
|
34
42
|
* ### Schedule
|
|
35
43
|
*
|
|
36
44
|
* * `type` - Type of schedule. Valid values: `DEFAULT`, `DAILY`, `MONTHLY`, `WEEKLY`.
|
|
@@ -75,6 +83,7 @@ export interface GetOnlineArchiveResult {
|
|
|
75
83
|
readonly collName: string;
|
|
76
84
|
readonly collectionType: string;
|
|
77
85
|
readonly criterias: outputs.GetOnlineArchiveCriteria[];
|
|
86
|
+
readonly dataExpirationRules: outputs.GetOnlineArchiveDataExpirationRule[];
|
|
78
87
|
readonly dbName: string;
|
|
79
88
|
/**
|
|
80
89
|
* The provider-assigned unique ID for this managed resource.
|
|
@@ -107,7 +116,12 @@ export interface GetOnlineArchiveResult {
|
|
|
107
116
|
*
|
|
108
117
|
* * `dbName` - Name of the database that contains the collection.
|
|
109
118
|
* * `collName` - Name of the collection.
|
|
110
|
-
* * `collectionType` -
|
|
119
|
+
* * `collectionType` - Type of MongoDB collection that you want to return. This value can be "TIMESERIES" or "STANDARD". Default is "STANDARD".
|
|
120
|
+
* * `criteria` - Criteria to use for archiving data. See criteria.
|
|
121
|
+
* * `dataExpirationRule` - Rule for specifying when data should be deleted from the archive. See data expiration rule.
|
|
122
|
+
* * `schedule` - Regular frequency and duration when archiving process occurs. See schedule.
|
|
123
|
+
* * `partitionFields` - Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Queries that don’t contain the specified fields require a full collection scan of all archived documents, which takes longer and increases your costs. To learn more about how partition improves query performance, see [Data Structure in S3](https://docs.mongodb.com/datalake/admin/optimize-query-performance/#data-structure-in-s3). The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived. See partition fields.
|
|
124
|
+
* * `paused` - State of the online archive. This is required for pausing an active online archive or resuming a paused online archive. If the collection has another active online archive, the resume request fails.
|
|
111
125
|
* * `state` - Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted
|
|
112
126
|
*
|
|
113
127
|
* ### Criteria
|
|
@@ -117,6 +131,9 @@ export interface GetOnlineArchiveResult {
|
|
|
117
131
|
* * `expireAfterDays` - Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when `type` is `DATE`.
|
|
118
132
|
* * `query` - JSON query to use to select documents for archiving. Atlas uses the specified query with the db.collection.find(query) command. The empty document {} to return all documents is not supported. Set this parameter when `type` is `CUSTOM`.
|
|
119
133
|
*
|
|
134
|
+
* ### Data Expiration Rule
|
|
135
|
+
* * `expireAfterDays` - Number of days used in the date criteria for nominating documents for deletion. Value must be between 7 and 9215.
|
|
136
|
+
*
|
|
120
137
|
* ### Schedule
|
|
121
138
|
*
|
|
122
139
|
* * `type` - Type of schedule. Valid values: `DEFAULT`, `DAILY`, `MONTHLY`, `WEEKLY`.
|
package/getOnlineArchive.js
CHANGED
|
@@ -26,7 +26,12 @@ const utilities = require("./utilities");
|
|
|
26
26
|
*
|
|
27
27
|
* * `dbName` - Name of the database that contains the collection.
|
|
28
28
|
* * `collName` - Name of the collection.
|
|
29
|
-
* * `collectionType` -
|
|
29
|
+
* * `collectionType` - Type of MongoDB collection that you want to return. This value can be "TIMESERIES" or "STANDARD". Default is "STANDARD".
|
|
30
|
+
* * `criteria` - Criteria to use for archiving data. See criteria.
|
|
31
|
+
* * `dataExpirationRule` - Rule for specifying when data should be deleted from the archive. See data expiration rule.
|
|
32
|
+
* * `schedule` - Regular frequency and duration when archiving process occurs. See schedule.
|
|
33
|
+
* * `partitionFields` - Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Queries that don’t contain the specified fields require a full collection scan of all archived documents, which takes longer and increases your costs. To learn more about how partition improves query performance, see [Data Structure in S3](https://docs.mongodb.com/datalake/admin/optimize-query-performance/#data-structure-in-s3). The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived. See partition fields.
|
|
34
|
+
* * `paused` - State of the online archive. This is required for pausing an active online archive or resuming a paused online archive. If the collection has another active online archive, the resume request fails.
|
|
30
35
|
* * `state` - Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted
|
|
31
36
|
*
|
|
32
37
|
* ### Criteria
|
|
@@ -36,6 +41,9 @@ const utilities = require("./utilities");
|
|
|
36
41
|
* * `expireAfterDays` - Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when `type` is `DATE`.
|
|
37
42
|
* * `query` - JSON query to use to select documents for archiving. Atlas uses the specified query with the db.collection.find(query) command. The empty document {} to return all documents is not supported. Set this parameter when `type` is `CUSTOM`.
|
|
38
43
|
*
|
|
44
|
+
* ### Data Expiration Rule
|
|
45
|
+
* * `expireAfterDays` - Number of days used in the date criteria for nominating documents for deletion. Value must be between 7 and 9215.
|
|
46
|
+
*
|
|
39
47
|
* ### Schedule
|
|
40
48
|
*
|
|
41
49
|
* * `type` - Type of schedule. Valid values: `DEFAULT`, `DAILY`, `MONTHLY`, `WEEKLY`.
|
|
@@ -83,7 +91,12 @@ exports.getOnlineArchive = getOnlineArchive;
|
|
|
83
91
|
*
|
|
84
92
|
* * `dbName` - Name of the database that contains the collection.
|
|
85
93
|
* * `collName` - Name of the collection.
|
|
86
|
-
* * `collectionType` -
|
|
94
|
+
* * `collectionType` - Type of MongoDB collection that you want to return. This value can be "TIMESERIES" or "STANDARD". Default is "STANDARD".
|
|
95
|
+
* * `criteria` - Criteria to use for archiving data. See criteria.
|
|
96
|
+
* * `dataExpirationRule` - Rule for specifying when data should be deleted from the archive. See data expiration rule.
|
|
97
|
+
* * `schedule` - Regular frequency and duration when archiving process occurs. See schedule.
|
|
98
|
+
* * `partitionFields` - Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Queries that don’t contain the specified fields require a full collection scan of all archived documents, which takes longer and increases your costs. To learn more about how partition improves query performance, see [Data Structure in S3](https://docs.mongodb.com/datalake/admin/optimize-query-performance/#data-structure-in-s3). The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived. See partition fields.
|
|
99
|
+
* * `paused` - State of the online archive. This is required for pausing an active online archive or resuming a paused online archive. If the collection has another active online archive, the resume request fails.
|
|
87
100
|
* * `state` - Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted
|
|
88
101
|
*
|
|
89
102
|
* ### Criteria
|
|
@@ -93,6 +106,9 @@ exports.getOnlineArchive = getOnlineArchive;
|
|
|
93
106
|
* * `expireAfterDays` - Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when `type` is `DATE`.
|
|
94
107
|
* * `query` - JSON query to use to select documents for archiving. Atlas uses the specified query with the db.collection.find(query) command. The empty document {} to return all documents is not supported. Set this parameter when `type` is `CUSTOM`.
|
|
95
108
|
*
|
|
109
|
+
* ### Data Expiration Rule
|
|
110
|
+
* * `expireAfterDays` - Number of days used in the date criteria for nominating documents for deletion. Value must be between 7 and 9215.
|
|
111
|
+
*
|
|
96
112
|
* ### Schedule
|
|
97
113
|
*
|
|
98
114
|
* * `type` - Type of schedule. Valid values: `DEFAULT`, `DAILY`, `MONTHLY`, `WEEKLY`.
|
package/getOnlineArchive.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getOnlineArchive.js","sourceRoot":"","sources":["../getOnlineArchive.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC
|
|
1
|
+
{"version":3,"file":"getOnlineArchive.js","sourceRoot":"","sources":["../getOnlineArchive.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,SAAgB,gBAAgB,CAAC,IAA0B,EAAE,IAA2B;IAEpF,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,sDAAsD,EAAE;QACjF,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AARD,4CAQC;AAyCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuDG;AACH,SAAgB,sBAAsB,CAAC,IAAgC,EAAE,IAA2B;IAChG,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AAC3E,CAAC;AAFD,wDAEC"}
|
package/getOnlineArchives.d.ts
CHANGED
|
@@ -18,27 +18,35 @@ import * as outputs from "./types/output";
|
|
|
18
18
|
* ```
|
|
19
19
|
* ## Attributes reference
|
|
20
20
|
*
|
|
21
|
-
* * `dbName`
|
|
22
|
-
* * `collName`
|
|
23
|
-
* * `collectionType`
|
|
24
|
-
* * `
|
|
21
|
+
* * `dbName` - Name of the database that contains the collection.
|
|
22
|
+
* * `collName` - Name of the collection.
|
|
23
|
+
* * `collectionType` - Type of MongoDB collection that you want to return. This value can be "TIMESERIES" or "STANDARD". Default is "STANDARD".
|
|
24
|
+
* * `criteria` - Criteria to use for archiving data. See criteria.
|
|
25
|
+
* * `dataExpirationRule` - Rule for specifying when data should be deleted from the archive. See data expiration rule.
|
|
26
|
+
* * `schedule` - Regular frequency and duration when archiving process occurs. See schedule.
|
|
27
|
+
* * `partitionFields` - Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Queries that don’t contain the specified fields require a full collection scan of all archived documents, which takes longer and increases your costs. To learn more about how partition improves query performance, see [Data Structure in S3](https://docs.mongodb.com/datalake/admin/optimize-query-performance/#data-structure-in-s3). The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived. See partition fields.
|
|
28
|
+
* * `paused` - State of the online archive. This is required for pausing an active online archive or resuming a paused online archive. If the collection has another active online archive, the resume request fails.
|
|
29
|
+
* * `state` - Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted
|
|
25
30
|
*
|
|
26
31
|
* ### Criteria
|
|
27
|
-
* * `type`
|
|
28
|
-
* * `dateField`
|
|
29
|
-
* * `dateFormat`
|
|
32
|
+
* * `type` - Type of criteria (DATE, CUSTOM)
|
|
33
|
+
* * `dateField` - Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the expireAfterDays parameter. Set this parameter when `type` is `DATE`.
|
|
34
|
+
* * `dateFormat` - Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when `type` is `DATE`. You must set `type` to `DATE` if `collectionType` is `TIMESERIES`. Valid values: ISODATE (default), EPOCH_SECONDS, EPOCH_MILLIS, EPOCH_NANOSECONDS.
|
|
30
35
|
* * `expireAfterDays` - Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when `type` is `DATE`.
|
|
31
36
|
* * `query` - JSON query to use to select documents for archiving. Atlas uses the specified query with the db.collection.find(query) command. The empty document {} to return all documents is not supported. Set this parameter when `type` is `CUSTOM`.
|
|
32
37
|
*
|
|
38
|
+
* ### Data Expiration Rule
|
|
39
|
+
* * `expireAfterDays` - Number of days used in the date criteria for nominating documents for deletion. Value must be between 7 and 9215.
|
|
40
|
+
*
|
|
33
41
|
* ### Schedule
|
|
34
42
|
*
|
|
35
|
-
* * `type`
|
|
36
|
-
* * `startHour`
|
|
37
|
-
* * `endHour`
|
|
38
|
-
* * `startMinute`
|
|
39
|
-
* * `endMinute`
|
|
40
|
-
* * `dayOfMonth`
|
|
41
|
-
* * `dayOfWeek`
|
|
43
|
+
* * `type` - Type of schedule (`DAILY`, `MONTHLY`, `WEEKLY`).
|
|
44
|
+
* * `startHour` - Hour of the day when the when the scheduled window to run one online archive starts.
|
|
45
|
+
* * `endHour` - Hour of the day when the scheduled window to run one online archive ends.
|
|
46
|
+
* * `startMinute` - Minute of the hour when the scheduled window to run one online archive starts.
|
|
47
|
+
* * `endMinute` - Minute of the hour when the scheduled window to run one online archive ends.
|
|
48
|
+
* * `dayOfMonth` - Day of the month when the scheduled archive starts.
|
|
49
|
+
* * `dayOfWeek` - Day of the week when the scheduled archive starts. The week starts with Monday (1) and ends with Sunday (7).
|
|
42
50
|
*
|
|
43
51
|
* ### Partition
|
|
44
52
|
* * `fieldName` - Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.
|
|
@@ -94,27 +102,35 @@ export interface GetOnlineArchivesResult {
|
|
|
94
102
|
* ```
|
|
95
103
|
* ## Attributes reference
|
|
96
104
|
*
|
|
97
|
-
* * `dbName`
|
|
98
|
-
* * `collName`
|
|
99
|
-
* * `collectionType`
|
|
100
|
-
* * `
|
|
105
|
+
* * `dbName` - Name of the database that contains the collection.
|
|
106
|
+
* * `collName` - Name of the collection.
|
|
107
|
+
* * `collectionType` - Type of MongoDB collection that you want to return. This value can be "TIMESERIES" or "STANDARD". Default is "STANDARD".
|
|
108
|
+
* * `criteria` - Criteria to use for archiving data. See criteria.
|
|
109
|
+
* * `dataExpirationRule` - Rule for specifying when data should be deleted from the archive. See data expiration rule.
|
|
110
|
+
* * `schedule` - Regular frequency and duration when archiving process occurs. See schedule.
|
|
111
|
+
* * `partitionFields` - Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Queries that don’t contain the specified fields require a full collection scan of all archived documents, which takes longer and increases your costs. To learn more about how partition improves query performance, see [Data Structure in S3](https://docs.mongodb.com/datalake/admin/optimize-query-performance/#data-structure-in-s3). The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived. See partition fields.
|
|
112
|
+
* * `paused` - State of the online archive. This is required for pausing an active online archive or resuming a paused online archive. If the collection has another active online archive, the resume request fails.
|
|
113
|
+
* * `state` - Status of the online archive. Valid values are: Pending, Archiving, Idle, Pausing, Paused, Orphaned and Deleted
|
|
101
114
|
*
|
|
102
115
|
* ### Criteria
|
|
103
|
-
* * `type`
|
|
104
|
-
* * `dateField`
|
|
105
|
-
* * `dateFormat`
|
|
116
|
+
* * `type` - Type of criteria (DATE, CUSTOM)
|
|
117
|
+
* * `dateField` - Indexed database parameter that stores the date that determines when data moves to the online archive. MongoDB Cloud archives the data when the current date exceeds the date in this database parameter plus the number of days specified through the expireAfterDays parameter. Set this parameter when `type` is `DATE`.
|
|
118
|
+
* * `dateFormat` - Syntax used to write the date after which data moves to the online archive. Date can be expressed as ISO 8601 or Epoch timestamps. The Epoch timestamp can be expressed as nanoseconds, milliseconds, or seconds. Set this parameter when `type` is `DATE`. You must set `type` to `DATE` if `collectionType` is `TIMESERIES`. Valid values: ISODATE (default), EPOCH_SECONDS, EPOCH_MILLIS, EPOCH_NANOSECONDS.
|
|
106
119
|
* * `expireAfterDays` - Number of days after the value in the criteria.dateField when MongoDB Cloud archives data in the specified cluster. Set this parameter when `type` is `DATE`.
|
|
107
120
|
* * `query` - JSON query to use to select documents for archiving. Atlas uses the specified query with the db.collection.find(query) command. The empty document {} to return all documents is not supported. Set this parameter when `type` is `CUSTOM`.
|
|
108
121
|
*
|
|
122
|
+
* ### Data Expiration Rule
|
|
123
|
+
* * `expireAfterDays` - Number of days used in the date criteria for nominating documents for deletion. Value must be between 7 and 9215.
|
|
124
|
+
*
|
|
109
125
|
* ### Schedule
|
|
110
126
|
*
|
|
111
|
-
* * `type`
|
|
112
|
-
* * `startHour`
|
|
113
|
-
* * `endHour`
|
|
114
|
-
* * `startMinute`
|
|
115
|
-
* * `endMinute`
|
|
116
|
-
* * `dayOfMonth`
|
|
117
|
-
* * `dayOfWeek`
|
|
127
|
+
* * `type` - Type of schedule (`DAILY`, `MONTHLY`, `WEEKLY`).
|
|
128
|
+
* * `startHour` - Hour of the day when the when the scheduled window to run one online archive starts.
|
|
129
|
+
* * `endHour` - Hour of the day when the scheduled window to run one online archive ends.
|
|
130
|
+
* * `startMinute` - Minute of the hour when the scheduled window to run one online archive starts.
|
|
131
|
+
* * `endMinute` - Minute of the hour when the scheduled window to run one online archive ends.
|
|
132
|
+
* * `dayOfMonth` - Day of the month when the scheduled archive starts.
|
|
133
|
+
* * `dayOfWeek` - Day of the week when the scheduled archive starts. The week starts with Monday (1) and ends with Sunday (7).
|
|
118
134
|
*
|
|
119
135
|
* ### Partition
|
|
120
136
|
* * `fieldName` - Human-readable label that identifies the parameter that MongoDB Cloud uses to partition data. To specify a nested parameter, use the dot notation.
|