@pulumi/mongodbatlas 3.37.0-alpha.1762410787 → 3.37.0-alpha.1763072353

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.
Files changed (80) hide show
  1. package/dataLakePipeline.d.ts +54 -0
  2. package/dataLakePipeline.js +54 -0
  3. package/dataLakePipeline.js.map +1 -1
  4. package/eventTrigger.d.ts +2 -2
  5. package/eventTrigger.js +2 -2
  6. package/flexCluster.d.ts +26 -0
  7. package/flexCluster.js +26 -0
  8. package/flexCluster.js.map +1 -1
  9. package/get509AuthenticationDatabaseUser.d.ts +58 -2
  10. package/get509AuthenticationDatabaseUser.js +58 -2
  11. package/get509AuthenticationDatabaseUser.js.map +1 -1
  12. package/getAccessListApiKey.d.ts +30 -0
  13. package/getAccessListApiKey.js +30 -0
  14. package/getAccessListApiKey.js.map +1 -1
  15. package/getAccessListApiKeys.d.ts +30 -0
  16. package/getAccessListApiKeys.js +30 -0
  17. package/getAccessListApiKeys.js.map +1 -1
  18. package/getCloudBackupSchedule.d.ts +108 -0
  19. package/getCloudBackupSchedule.js +108 -0
  20. package/getCloudBackupSchedule.js.map +1 -1
  21. package/getCloudBackupSnapshotRestoreJob.d.ts +54 -0
  22. package/getCloudBackupSnapshotRestoreJob.js +54 -0
  23. package/getCloudBackupSnapshotRestoreJob.js.map +1 -1
  24. package/getCustomDbRoles.d.ts +50 -0
  25. package/getCustomDbRoles.js +50 -0
  26. package/getCustomDbRoles.js.map +1 -1
  27. package/getDataLakePipeline.d.ts +116 -0
  28. package/getDataLakePipeline.js +116 -0
  29. package/getDataLakePipeline.js.map +1 -1
  30. package/getDataLakePipelineRuns.d.ts +74 -0
  31. package/getDataLakePipelineRuns.js +74 -0
  32. package/getDataLakePipelineRuns.js.map +1 -1
  33. package/getFederatedSettingsOrgRoleMappings.d.ts +68 -0
  34. package/getFederatedSettingsOrgRoleMappings.js +68 -0
  35. package/getFederatedSettingsOrgRoleMappings.js.map +1 -1
  36. package/getFlexCluster.d.ts +50 -0
  37. package/getFlexCluster.js +50 -0
  38. package/getFlexCluster.js.map +1 -1
  39. package/getFlexClusters.d.ts +50 -0
  40. package/getFlexClusters.js +50 -0
  41. package/getFlexClusters.js.map +1 -1
  42. package/getSearchDeployment.d.ts +78 -0
  43. package/getSearchDeployment.js +78 -0
  44. package/getSearchDeployment.js.map +1 -1
  45. package/getStreamPrivatelinkEndpoint.d.ts +140 -0
  46. package/getStreamPrivatelinkEndpoint.js +140 -0
  47. package/getStreamPrivatelinkEndpoint.js.map +1 -1
  48. package/getStreamPrivatelinkEndpoints.d.ts +140 -0
  49. package/getStreamPrivatelinkEndpoints.js +140 -0
  50. package/getStreamPrivatelinkEndpoints.js.map +1 -1
  51. package/getStreamProcessor.d.ts +264 -0
  52. package/getStreamProcessor.js +264 -0
  53. package/getStreamProcessor.js.map +1 -1
  54. package/getStreamProcessors.d.ts +264 -0
  55. package/getStreamProcessors.js +264 -0
  56. package/getStreamProcessors.js.map +1 -1
  57. package/getX509AuthenticationDatabaseUser.d.ts +58 -2
  58. package/getX509AuthenticationDatabaseUser.js +58 -2
  59. package/getX509AuthenticationDatabaseUser.js.map +1 -1
  60. package/package.json +2 -2
  61. package/searchDeployment.d.ts +40 -0
  62. package/searchDeployment.js +40 -0
  63. package/searchDeployment.js.map +1 -1
  64. package/searchIndex.d.ts +39 -39
  65. package/searchIndex.js +39 -39
  66. package/streamConnection.d.ts +40 -0
  67. package/streamConnection.js +40 -0
  68. package/streamConnection.js.map +1 -1
  69. package/streamInstance.d.ts +14 -0
  70. package/streamInstance.js +14 -0
  71. package/streamInstance.js.map +1 -1
  72. package/streamPrivatelinkEndpoint.d.ts +70 -0
  73. package/streamPrivatelinkEndpoint.js +70 -0
  74. package/streamPrivatelinkEndpoint.js.map +1 -1
  75. package/streamProcessor.d.ts +133 -0
  76. package/streamProcessor.js +133 -0
  77. package/streamProcessor.js.map +1 -1
  78. package/x509authenticationDatabaseUser.d.ts +63 -0
  79. package/x509authenticationDatabaseUser.js +63 -0
  80. package/x509authenticationDatabaseUser.js.map +1 -1
@@ -2,6 +2,60 @@ import * as pulumi from "@pulumi/pulumi";
2
2
  import * as outputs from "./types/output";
3
3
  /**
4
4
  * ## Example Usage
5
+ *
6
+ * ```typescript
7
+ * import * as pulumi from "@pulumi/pulumi";
8
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
9
+ *
10
+ * const myCluster = new mongodbatlas.AdvancedCluster("my_cluster", {
11
+ * projectId: "<PROJECT-ID>",
12
+ * name: "clusterTest",
13
+ * clusterType: "REPLICASET",
14
+ * backupEnabled: true,
15
+ * replicationSpecs: [{
16
+ * regionConfigs: [{
17
+ * priority: 7,
18
+ * providerName: "AWS",
19
+ * regionName: "EU_CENTRAL_1",
20
+ * electableSpecs: {
21
+ * instanceSize: "M10",
22
+ * nodeCount: 3,
23
+ * },
24
+ * }],
25
+ * }],
26
+ * });
27
+ * const testCloudBackupSchedule = new mongodbatlas.CloudBackupSchedule("test", {
28
+ * projectId: myCluster.projectId,
29
+ * clusterName: myCluster.name,
30
+ * referenceHourOfDay: 3,
31
+ * referenceMinuteOfHour: 45,
32
+ * restoreWindowDays: 4,
33
+ * policyItemDaily: {
34
+ * frequencyInterval: 1,
35
+ * retentionUnit: "days",
36
+ * retentionValue: 14,
37
+ * },
38
+ * copySettings: [{
39
+ * cloudProvider: "AWS",
40
+ * frequencies: [
41
+ * "HOURLY",
42
+ * "DAILY",
43
+ * "WEEKLY",
44
+ * "MONTHLY",
45
+ * "YEARLY",
46
+ * "ON_DEMAND",
47
+ * ],
48
+ * regionName: "US_EAST_1",
49
+ * zoneId: myCluster.replicationSpecs.apply(replicationSpecs => replicationSpecs.map(__item => __item.zoneId?.[0])),
50
+ * shouldCopyOplogs: false,
51
+ * }],
52
+ * });
53
+ * const test = mongodbatlas.getCloudBackupScheduleOutput({
54
+ * projectId: testCloudBackupSchedule.projectId,
55
+ * clusterName: testCloudBackupSchedule.clusterName,
56
+ * useZoneIdForCopySettings: true,
57
+ * });
58
+ * ```
5
59
  */
6
60
  export declare function getCloudBackupSchedule(args: GetCloudBackupScheduleArgs, opts?: pulumi.InvokeOptions): Promise<GetCloudBackupScheduleResult>;
7
61
  /**
@@ -97,6 +151,60 @@ export interface GetCloudBackupScheduleResult {
97
151
  }
98
152
  /**
99
153
  * ## Example Usage
154
+ *
155
+ * ```typescript
156
+ * import * as pulumi from "@pulumi/pulumi";
157
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
158
+ *
159
+ * const myCluster = new mongodbatlas.AdvancedCluster("my_cluster", {
160
+ * projectId: "<PROJECT-ID>",
161
+ * name: "clusterTest",
162
+ * clusterType: "REPLICASET",
163
+ * backupEnabled: true,
164
+ * replicationSpecs: [{
165
+ * regionConfigs: [{
166
+ * priority: 7,
167
+ * providerName: "AWS",
168
+ * regionName: "EU_CENTRAL_1",
169
+ * electableSpecs: {
170
+ * instanceSize: "M10",
171
+ * nodeCount: 3,
172
+ * },
173
+ * }],
174
+ * }],
175
+ * });
176
+ * const testCloudBackupSchedule = new mongodbatlas.CloudBackupSchedule("test", {
177
+ * projectId: myCluster.projectId,
178
+ * clusterName: myCluster.name,
179
+ * referenceHourOfDay: 3,
180
+ * referenceMinuteOfHour: 45,
181
+ * restoreWindowDays: 4,
182
+ * policyItemDaily: {
183
+ * frequencyInterval: 1,
184
+ * retentionUnit: "days",
185
+ * retentionValue: 14,
186
+ * },
187
+ * copySettings: [{
188
+ * cloudProvider: "AWS",
189
+ * frequencies: [
190
+ * "HOURLY",
191
+ * "DAILY",
192
+ * "WEEKLY",
193
+ * "MONTHLY",
194
+ * "YEARLY",
195
+ * "ON_DEMAND",
196
+ * ],
197
+ * regionName: "US_EAST_1",
198
+ * zoneId: myCluster.replicationSpecs.apply(replicationSpecs => replicationSpecs.map(__item => __item.zoneId?.[0])),
199
+ * shouldCopyOplogs: false,
200
+ * }],
201
+ * });
202
+ * const test = mongodbatlas.getCloudBackupScheduleOutput({
203
+ * projectId: testCloudBackupSchedule.projectId,
204
+ * clusterName: testCloudBackupSchedule.clusterName,
205
+ * useZoneIdForCopySettings: true,
206
+ * });
207
+ * ```
100
208
  */
101
209
  export declare function getCloudBackupScheduleOutput(args: GetCloudBackupScheduleOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetCloudBackupScheduleResult>;
102
210
  /**
@@ -7,6 +7,60 @@ const pulumi = require("@pulumi/pulumi");
7
7
  const utilities = require("./utilities");
8
8
  /**
9
9
  * ## Example Usage
10
+ *
11
+ * ```typescript
12
+ * import * as pulumi from "@pulumi/pulumi";
13
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
14
+ *
15
+ * const myCluster = new mongodbatlas.AdvancedCluster("my_cluster", {
16
+ * projectId: "<PROJECT-ID>",
17
+ * name: "clusterTest",
18
+ * clusterType: "REPLICASET",
19
+ * backupEnabled: true,
20
+ * replicationSpecs: [{
21
+ * regionConfigs: [{
22
+ * priority: 7,
23
+ * providerName: "AWS",
24
+ * regionName: "EU_CENTRAL_1",
25
+ * electableSpecs: {
26
+ * instanceSize: "M10",
27
+ * nodeCount: 3,
28
+ * },
29
+ * }],
30
+ * }],
31
+ * });
32
+ * const testCloudBackupSchedule = new mongodbatlas.CloudBackupSchedule("test", {
33
+ * projectId: myCluster.projectId,
34
+ * clusterName: myCluster.name,
35
+ * referenceHourOfDay: 3,
36
+ * referenceMinuteOfHour: 45,
37
+ * restoreWindowDays: 4,
38
+ * policyItemDaily: {
39
+ * frequencyInterval: 1,
40
+ * retentionUnit: "days",
41
+ * retentionValue: 14,
42
+ * },
43
+ * copySettings: [{
44
+ * cloudProvider: "AWS",
45
+ * frequencies: [
46
+ * "HOURLY",
47
+ * "DAILY",
48
+ * "WEEKLY",
49
+ * "MONTHLY",
50
+ * "YEARLY",
51
+ * "ON_DEMAND",
52
+ * ],
53
+ * regionName: "US_EAST_1",
54
+ * zoneId: myCluster.replicationSpecs.apply(replicationSpecs => replicationSpecs.map(__item => __item.zoneId?.[0])),
55
+ * shouldCopyOplogs: false,
56
+ * }],
57
+ * });
58
+ * const test = mongodbatlas.getCloudBackupScheduleOutput({
59
+ * projectId: testCloudBackupSchedule.projectId,
60
+ * clusterName: testCloudBackupSchedule.clusterName,
61
+ * useZoneIdForCopySettings: true,
62
+ * });
63
+ * ```
10
64
  */
11
65
  function getCloudBackupSchedule(args, opts) {
12
66
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -19,6 +73,60 @@ function getCloudBackupSchedule(args, opts) {
19
73
  exports.getCloudBackupSchedule = getCloudBackupSchedule;
20
74
  /**
21
75
  * ## Example Usage
76
+ *
77
+ * ```typescript
78
+ * import * as pulumi from "@pulumi/pulumi";
79
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
80
+ *
81
+ * const myCluster = new mongodbatlas.AdvancedCluster("my_cluster", {
82
+ * projectId: "<PROJECT-ID>",
83
+ * name: "clusterTest",
84
+ * clusterType: "REPLICASET",
85
+ * backupEnabled: true,
86
+ * replicationSpecs: [{
87
+ * regionConfigs: [{
88
+ * priority: 7,
89
+ * providerName: "AWS",
90
+ * regionName: "EU_CENTRAL_1",
91
+ * electableSpecs: {
92
+ * instanceSize: "M10",
93
+ * nodeCount: 3,
94
+ * },
95
+ * }],
96
+ * }],
97
+ * });
98
+ * const testCloudBackupSchedule = new mongodbatlas.CloudBackupSchedule("test", {
99
+ * projectId: myCluster.projectId,
100
+ * clusterName: myCluster.name,
101
+ * referenceHourOfDay: 3,
102
+ * referenceMinuteOfHour: 45,
103
+ * restoreWindowDays: 4,
104
+ * policyItemDaily: {
105
+ * frequencyInterval: 1,
106
+ * retentionUnit: "days",
107
+ * retentionValue: 14,
108
+ * },
109
+ * copySettings: [{
110
+ * cloudProvider: "AWS",
111
+ * frequencies: [
112
+ * "HOURLY",
113
+ * "DAILY",
114
+ * "WEEKLY",
115
+ * "MONTHLY",
116
+ * "YEARLY",
117
+ * "ON_DEMAND",
118
+ * ],
119
+ * regionName: "US_EAST_1",
120
+ * zoneId: myCluster.replicationSpecs.apply(replicationSpecs => replicationSpecs.map(__item => __item.zoneId?.[0])),
121
+ * shouldCopyOplogs: false,
122
+ * }],
123
+ * });
124
+ * const test = mongodbatlas.getCloudBackupScheduleOutput({
125
+ * projectId: testCloudBackupSchedule.projectId,
126
+ * clusterName: testCloudBackupSchedule.clusterName,
127
+ * useZoneIdForCopySettings: true,
128
+ * });
129
+ * ```
22
130
  */
23
131
  function getCloudBackupScheduleOutput(args, opts) {
24
132
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -1 +1 @@
1
- {"version":3,"file":"getCloudBackupSchedule.js","sourceRoot":"","sources":["../getCloudBackupSchedule.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;GAEG;AACH,SAAgB,sBAAsB,CAAC,IAAgC,EAAE,IAA2B;IAChG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kEAAkE,EAAE;QAC7F,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,0BAA0B,EAAE,IAAI,CAAC,wBAAwB;KAC5D,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,wDAOC;AA8FD;;GAEG;AACH,SAAgB,4BAA4B,CAAC,IAAsC,EAAE,IAAiC;IAClH,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kEAAkE,EAAE;QACnG,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,0BAA0B,EAAE,IAAI,CAAC,wBAAwB;KAC5D,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,oEAOC"}
1
+ {"version":3,"file":"getCloudBackupSchedule.js","sourceRoot":"","sources":["../getCloudBackupSchedule.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,SAAgB,sBAAsB,CAAC,IAAgC,EAAE,IAA2B;IAChG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kEAAkE,EAAE;QAC7F,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,0BAA0B,EAAE,IAAI,CAAC,wBAAwB;KAC5D,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,wDAOC;AA8FD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,SAAgB,4BAA4B,CAAC,IAAsC,EAAE,IAAiC;IAClH,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,kEAAkE,EAAE;QACnG,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,0BAA0B,EAAE,IAAI,CAAC,wBAAwB;KAC5D,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,oEAOC"}
@@ -9,6 +9,33 @@ import * as pulumi from "@pulumi/pulumi";
9
9
  * ## Example Usage
10
10
  *
11
11
  * First create a snapshot of the desired cluster. Then request that snapshot be restored in an automated fashion to the designated cluster and project.
12
+ *
13
+ * ```typescript
14
+ * import * as pulumi from "@pulumi/pulumi";
15
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
16
+ *
17
+ * const testCloudBackupSnapshot = new mongodbatlas.CloudBackupSnapshot("test", {
18
+ * projectId: "5cf5a45a9ccf6400e60981b6",
19
+ * clusterName: "MyCluster",
20
+ * description: "MyDescription",
21
+ * retentionInDays: 1,
22
+ * });
23
+ * const testCloudBackupSnapshotRestoreJob = new mongodbatlas.CloudBackupSnapshotRestoreJob("test", {
24
+ * projectId: "5cf5a45a9ccf6400e60981b6",
25
+ * clusterName: "MyCluster",
26
+ * snapshotId: testCloudBackupSnapshot.id,
27
+ * deliveryType: [{
28
+ * automated: true,
29
+ * targetClusterName: "MyCluster",
30
+ * targetProjectId: "5cf5a45a9ccf6400e60981b6",
31
+ * }],
32
+ * });
33
+ * const test = mongodbatlas.getCloudBackupSnapshotRestoreJobOutput({
34
+ * projectId: testCloudBackupSnapshotRestoreJob.projectId,
35
+ * clusterName: testCloudBackupSnapshotRestoreJob.clusterName,
36
+ * snapshotRestoreJobId: testCloudBackupSnapshotRestoreJob.snapshotRestoreJobId,
37
+ * });
38
+ * ```
12
39
  */
13
40
  export declare function getCloudBackupSnapshotRestoreJob(args: GetCloudBackupSnapshotRestoreJobArgs, opts?: pulumi.InvokeOptions): Promise<GetCloudBackupSnapshotRestoreJobResult>;
14
41
  /**
@@ -100,6 +127,33 @@ export interface GetCloudBackupSnapshotRestoreJobResult {
100
127
  * ## Example Usage
101
128
  *
102
129
  * First create a snapshot of the desired cluster. Then request that snapshot be restored in an automated fashion to the designated cluster and project.
130
+ *
131
+ * ```typescript
132
+ * import * as pulumi from "@pulumi/pulumi";
133
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
134
+ *
135
+ * const testCloudBackupSnapshot = new mongodbatlas.CloudBackupSnapshot("test", {
136
+ * projectId: "5cf5a45a9ccf6400e60981b6",
137
+ * clusterName: "MyCluster",
138
+ * description: "MyDescription",
139
+ * retentionInDays: 1,
140
+ * });
141
+ * const testCloudBackupSnapshotRestoreJob = new mongodbatlas.CloudBackupSnapshotRestoreJob("test", {
142
+ * projectId: "5cf5a45a9ccf6400e60981b6",
143
+ * clusterName: "MyCluster",
144
+ * snapshotId: testCloudBackupSnapshot.id,
145
+ * deliveryType: [{
146
+ * automated: true,
147
+ * targetClusterName: "MyCluster",
148
+ * targetProjectId: "5cf5a45a9ccf6400e60981b6",
149
+ * }],
150
+ * });
151
+ * const test = mongodbatlas.getCloudBackupSnapshotRestoreJobOutput({
152
+ * projectId: testCloudBackupSnapshotRestoreJob.projectId,
153
+ * clusterName: testCloudBackupSnapshotRestoreJob.clusterName,
154
+ * snapshotRestoreJobId: testCloudBackupSnapshotRestoreJob.snapshotRestoreJobId,
155
+ * });
156
+ * ```
103
157
  */
104
158
  export declare function getCloudBackupSnapshotRestoreJobOutput(args: GetCloudBackupSnapshotRestoreJobOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetCloudBackupSnapshotRestoreJobResult>;
105
159
  /**
@@ -15,6 +15,33 @@ const utilities = require("./utilities");
15
15
  * ## Example Usage
16
16
  *
17
17
  * First create a snapshot of the desired cluster. Then request that snapshot be restored in an automated fashion to the designated cluster and project.
18
+ *
19
+ * ```typescript
20
+ * import * as pulumi from "@pulumi/pulumi";
21
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
22
+ *
23
+ * const testCloudBackupSnapshot = new mongodbatlas.CloudBackupSnapshot("test", {
24
+ * projectId: "5cf5a45a9ccf6400e60981b6",
25
+ * clusterName: "MyCluster",
26
+ * description: "MyDescription",
27
+ * retentionInDays: 1,
28
+ * });
29
+ * const testCloudBackupSnapshotRestoreJob = new mongodbatlas.CloudBackupSnapshotRestoreJob("test", {
30
+ * projectId: "5cf5a45a9ccf6400e60981b6",
31
+ * clusterName: "MyCluster",
32
+ * snapshotId: testCloudBackupSnapshot.id,
33
+ * deliveryType: [{
34
+ * automated: true,
35
+ * targetClusterName: "MyCluster",
36
+ * targetProjectId: "5cf5a45a9ccf6400e60981b6",
37
+ * }],
38
+ * });
39
+ * const test = mongodbatlas.getCloudBackupSnapshotRestoreJobOutput({
40
+ * projectId: testCloudBackupSnapshotRestoreJob.projectId,
41
+ * clusterName: testCloudBackupSnapshotRestoreJob.clusterName,
42
+ * snapshotRestoreJobId: testCloudBackupSnapshotRestoreJob.snapshotRestoreJobId,
43
+ * });
44
+ * ```
18
45
  */
19
46
  function getCloudBackupSnapshotRestoreJob(args, opts) {
20
47
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -35,6 +62,33 @@ exports.getCloudBackupSnapshotRestoreJob = getCloudBackupSnapshotRestoreJob;
35
62
  * ## Example Usage
36
63
  *
37
64
  * First create a snapshot of the desired cluster. Then request that snapshot be restored in an automated fashion to the designated cluster and project.
65
+ *
66
+ * ```typescript
67
+ * import * as pulumi from "@pulumi/pulumi";
68
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
69
+ *
70
+ * const testCloudBackupSnapshot = new mongodbatlas.CloudBackupSnapshot("test", {
71
+ * projectId: "5cf5a45a9ccf6400e60981b6",
72
+ * clusterName: "MyCluster",
73
+ * description: "MyDescription",
74
+ * retentionInDays: 1,
75
+ * });
76
+ * const testCloudBackupSnapshotRestoreJob = new mongodbatlas.CloudBackupSnapshotRestoreJob("test", {
77
+ * projectId: "5cf5a45a9ccf6400e60981b6",
78
+ * clusterName: "MyCluster",
79
+ * snapshotId: testCloudBackupSnapshot.id,
80
+ * deliveryType: [{
81
+ * automated: true,
82
+ * targetClusterName: "MyCluster",
83
+ * targetProjectId: "5cf5a45a9ccf6400e60981b6",
84
+ * }],
85
+ * });
86
+ * const test = mongodbatlas.getCloudBackupSnapshotRestoreJobOutput({
87
+ * projectId: testCloudBackupSnapshotRestoreJob.projectId,
88
+ * clusterName: testCloudBackupSnapshotRestoreJob.clusterName,
89
+ * snapshotRestoreJobId: testCloudBackupSnapshotRestoreJob.snapshotRestoreJobId,
90
+ * });
91
+ * ```
38
92
  */
39
93
  function getCloudBackupSnapshotRestoreJobOutput(args, opts) {
40
94
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -1 +1 @@
1
- {"version":3,"file":"getCloudBackupSnapshotRestoreJob.js","sourceRoot":"","sources":["../getCloudBackupSnapshotRestoreJob.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;GAUG;AACH,SAAgB,gCAAgC,CAAC,IAA0C,EAAE,IAA2B;IACpH,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,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,sBAAsB,EAAE,IAAI,CAAC,oBAAoB;KACpD,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,4EAOC;AAkFD;;;;;;;;;;GAUG;AACH,SAAgB,sCAAsC,CAAC,IAAgD,EAAE,IAAiC;IACtI,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,sFAAsF,EAAE;QACvH,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,sBAAsB,EAAE,IAAI,CAAC,oBAAoB;KACpD,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,wFAOC"}
1
+ {"version":3,"file":"getCloudBackupSnapshotRestoreJob.js","sourceRoot":"","sources":["../getCloudBackupSnapshotRestoreJob.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AACzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,SAAgB,gCAAgC,CAAC,IAA0C,EAAE,IAA2B;IACpH,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,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,sBAAsB,EAAE,IAAI,CAAC,oBAAoB;KACpD,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,4EAOC;AAkFD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,SAAgB,sCAAsC,CAAC,IAAgD,EAAE,IAAiC;IACtI,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,sFAAsF,EAAE;QACvH,aAAa,EAAE,IAAI,CAAC,WAAW;QAC/B,WAAW,EAAE,IAAI,CAAC,SAAS;QAC3B,sBAAsB,EAAE,IAAI,CAAC,oBAAoB;KACpD,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,wFAOC"}
@@ -8,6 +8,31 @@ import * as outputs from "./types/output";
8
8
  * > **NOTE:** Groups and projects are synonymous terms. You may find `groupId` in the official documentation.
9
9
  *
10
10
  * ## Example Usage
11
+ *
12
+ * ```typescript
13
+ * import * as pulumi from "@pulumi/pulumi";
14
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
15
+ *
16
+ * const testDatabaseUser = new mongodbatlas.DatabaseUser("test", {
17
+ * username: "test-acc-username",
18
+ * password: "test-acc-password",
19
+ * projectId: "<PROJECT-ID>",
20
+ * databaseName: "admin",
21
+ * roles: [
22
+ * {
23
+ * roleName: "readWrite",
24
+ * databaseName: "admin",
25
+ * },
26
+ * {
27
+ * roleName: "atlasAdmin",
28
+ * databaseName: "admin",
29
+ * },
30
+ * ],
31
+ * });
32
+ * const test = mongodbatlas.getCustomDbRoles({
33
+ * projectId: testMongodbatlasCustomDbRole.projectId,
34
+ * });
35
+ * ```
11
36
  */
12
37
  export declare function getCustomDbRoles(args: GetCustomDbRolesArgs, opts?: pulumi.InvokeOptions): Promise<GetCustomDbRolesResult>;
13
38
  /**
@@ -41,6 +66,31 @@ export interface GetCustomDbRolesResult {
41
66
  * > **NOTE:** Groups and projects are synonymous terms. You may find `groupId` in the official documentation.
42
67
  *
43
68
  * ## Example Usage
69
+ *
70
+ * ```typescript
71
+ * import * as pulumi from "@pulumi/pulumi";
72
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
73
+ *
74
+ * const testDatabaseUser = new mongodbatlas.DatabaseUser("test", {
75
+ * username: "test-acc-username",
76
+ * password: "test-acc-password",
77
+ * projectId: "<PROJECT-ID>",
78
+ * databaseName: "admin",
79
+ * roles: [
80
+ * {
81
+ * roleName: "readWrite",
82
+ * databaseName: "admin",
83
+ * },
84
+ * {
85
+ * roleName: "atlasAdmin",
86
+ * databaseName: "admin",
87
+ * },
88
+ * ],
89
+ * });
90
+ * const test = mongodbatlas.getCustomDbRoles({
91
+ * projectId: testMongodbatlasCustomDbRole.projectId,
92
+ * });
93
+ * ```
44
94
  */
45
95
  export declare function getCustomDbRolesOutput(args: GetCustomDbRolesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetCustomDbRolesResult>;
46
96
  /**
@@ -13,6 +13,31 @@ const utilities = require("./utilities");
13
13
  * > **NOTE:** Groups and projects are synonymous terms. You may find `groupId` in the official documentation.
14
14
  *
15
15
  * ## Example Usage
16
+ *
17
+ * ```typescript
18
+ * import * as pulumi from "@pulumi/pulumi";
19
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
20
+ *
21
+ * const testDatabaseUser = new mongodbatlas.DatabaseUser("test", {
22
+ * username: "test-acc-username",
23
+ * password: "test-acc-password",
24
+ * projectId: "<PROJECT-ID>",
25
+ * databaseName: "admin",
26
+ * roles: [
27
+ * {
28
+ * roleName: "readWrite",
29
+ * databaseName: "admin",
30
+ * },
31
+ * {
32
+ * roleName: "atlasAdmin",
33
+ * databaseName: "admin",
34
+ * },
35
+ * ],
36
+ * });
37
+ * const test = mongodbatlas.getCustomDbRoles({
38
+ * projectId: testMongodbatlasCustomDbRole.projectId,
39
+ * });
40
+ * ```
16
41
  */
17
42
  function getCustomDbRoles(args, opts) {
18
43
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -29,6 +54,31 @@ exports.getCustomDbRoles = getCustomDbRoles;
29
54
  * > **NOTE:** Groups and projects are synonymous terms. You may find `groupId` in the official documentation.
30
55
  *
31
56
  * ## Example Usage
57
+ *
58
+ * ```typescript
59
+ * import * as pulumi from "@pulumi/pulumi";
60
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
61
+ *
62
+ * const testDatabaseUser = new mongodbatlas.DatabaseUser("test", {
63
+ * username: "test-acc-username",
64
+ * password: "test-acc-password",
65
+ * projectId: "<PROJECT-ID>",
66
+ * databaseName: "admin",
67
+ * roles: [
68
+ * {
69
+ * roleName: "readWrite",
70
+ * databaseName: "admin",
71
+ * },
72
+ * {
73
+ * roleName: "atlasAdmin",
74
+ * databaseName: "admin",
75
+ * },
76
+ * ],
77
+ * });
78
+ * const test = mongodbatlas.getCustomDbRoles({
79
+ * projectId: testMongodbatlasCustomDbRole.projectId,
80
+ * });
81
+ * ```
32
82
  */
33
83
  function getCustomDbRolesOutput(args, opts) {
34
84
  opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -1 +1 @@
1
- {"version":3,"file":"getCustomDbRoles.js","sourceRoot":"","sources":["../getCustomDbRoles.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;GAQG;AACH,SAAgB,gBAAgB,CAAC,IAA0B,EAAE,IAA2B;IACpF,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;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,4CAKC;AA0BD;;;;;;;;GAQG;AACH,SAAgB,sBAAsB,CAAC,IAAgC,EAAE,IAAiC;IACtG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,sDAAsD,EAAE;QACvF,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,wDAKC"}
1
+ {"version":3,"file":"getCustomDbRoles.js","sourceRoot":"","sources":["../getCustomDbRoles.ts"],"names":[],"mappings":";AAAA,sEAAsE;AACtE,iFAAiF;;;AAEjF,yCAAyC;AAGzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,SAAgB,gBAAgB,CAAC,IAA0B,EAAE,IAA2B;IACpF,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;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,4CAKC;AA0BD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,SAAgB,sBAAsB,CAAC,IAAgC,EAAE,IAAiC;IACtG,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,sDAAsD,EAAE;QACvF,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AALD,wDAKC"}
@@ -10,6 +10,64 @@ import * as outputs from "./types/output";
10
10
  * ## Example Usage
11
11
  *
12
12
  * ### S
13
+ *
14
+ * ```typescript
15
+ * import * as pulumi from "@pulumi/pulumi";
16
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
17
+ *
18
+ * const projectTest = new mongodbatlas.Project("projectTest", {
19
+ * name: "NAME OF THE PROJECT",
20
+ * orgId: "ORGANIZATION ID",
21
+ * });
22
+ * const automatedBackupTest = new mongodbatlas.AdvancedCluster("automated_backup_test", {
23
+ * projectId: projectId,
24
+ * name: "automated-backup-test",
25
+ * clusterType: "REPLICASET",
26
+ * backupEnabled: true,
27
+ * replicationSpecs: [{
28
+ * regionConfigs: [{
29
+ * priority: 7,
30
+ * providerName: "GCP",
31
+ * regionName: "US_EAST_4",
32
+ * electableSpecs: {
33
+ * instanceSize: "M10",
34
+ * nodeCount: 3,
35
+ * },
36
+ * }],
37
+ * }],
38
+ * });
39
+ * const pipeline = new mongodbatlas.DataLakePipeline("pipeline", {
40
+ * projectId: projectTest.projectId,
41
+ * name: "DataLakePipelineName",
42
+ * sink: {
43
+ * type: "DLS",
44
+ * partitionFields: [{
45
+ * name: "access",
46
+ * order: 0,
47
+ * }],
48
+ * },
49
+ * source: {
50
+ * type: "ON_DEMAND_CPS",
51
+ * clusterName: automatedBackupTest.name,
52
+ * databaseName: "sample_airbnb",
53
+ * collectionName: "listingsAndReviews",
54
+ * },
55
+ * transformations: [
56
+ * {
57
+ * field: "test",
58
+ * type: "EXCLUDE",
59
+ * },
60
+ * {
61
+ * field: "test22",
62
+ * type: "EXCLUDE",
63
+ * },
64
+ * ],
65
+ * });
66
+ * const pipelineDataSource = mongodbatlas.getDataLakePipelineOutput({
67
+ * projectId: pipeline.projectId,
68
+ * name: pipeline.name,
69
+ * });
70
+ * ```
13
71
  */
14
72
  export declare function getDataLakePipeline(args: GetDataLakePipelineArgs, opts?: pulumi.InvokeOptions): Promise<GetDataLakePipelineResult>;
15
73
  /**
@@ -97,6 +155,64 @@ export interface GetDataLakePipelineResult {
97
155
  * ## Example Usage
98
156
  *
99
157
  * ### S
158
+ *
159
+ * ```typescript
160
+ * import * as pulumi from "@pulumi/pulumi";
161
+ * import * as mongodbatlas from "@pulumi/mongodbatlas";
162
+ *
163
+ * const projectTest = new mongodbatlas.Project("projectTest", {
164
+ * name: "NAME OF THE PROJECT",
165
+ * orgId: "ORGANIZATION ID",
166
+ * });
167
+ * const automatedBackupTest = new mongodbatlas.AdvancedCluster("automated_backup_test", {
168
+ * projectId: projectId,
169
+ * name: "automated-backup-test",
170
+ * clusterType: "REPLICASET",
171
+ * backupEnabled: true,
172
+ * replicationSpecs: [{
173
+ * regionConfigs: [{
174
+ * priority: 7,
175
+ * providerName: "GCP",
176
+ * regionName: "US_EAST_4",
177
+ * electableSpecs: {
178
+ * instanceSize: "M10",
179
+ * nodeCount: 3,
180
+ * },
181
+ * }],
182
+ * }],
183
+ * });
184
+ * const pipeline = new mongodbatlas.DataLakePipeline("pipeline", {
185
+ * projectId: projectTest.projectId,
186
+ * name: "DataLakePipelineName",
187
+ * sink: {
188
+ * type: "DLS",
189
+ * partitionFields: [{
190
+ * name: "access",
191
+ * order: 0,
192
+ * }],
193
+ * },
194
+ * source: {
195
+ * type: "ON_DEMAND_CPS",
196
+ * clusterName: automatedBackupTest.name,
197
+ * databaseName: "sample_airbnb",
198
+ * collectionName: "listingsAndReviews",
199
+ * },
200
+ * transformations: [
201
+ * {
202
+ * field: "test",
203
+ * type: "EXCLUDE",
204
+ * },
205
+ * {
206
+ * field: "test22",
207
+ * type: "EXCLUDE",
208
+ * },
209
+ * ],
210
+ * });
211
+ * const pipelineDataSource = mongodbatlas.getDataLakePipelineOutput({
212
+ * projectId: pipeline.projectId,
213
+ * name: pipeline.name,
214
+ * });
215
+ * ```
100
216
  */
101
217
  export declare function getDataLakePipelineOutput(args: GetDataLakePipelineOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDataLakePipelineResult>;
102
218
  /**