@pulumi/ec 0.5.2-alpha.1691409334 → 0.6.0

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 (45) hide show
  1. package/deployment.d.ts +75 -293
  2. package/deployment.js +10 -167
  3. package/deployment.js.map +1 -1
  4. package/deploymentElasticsearchKeystore.d.ts +27 -24
  5. package/deploymentElasticsearchKeystore.js +17 -14
  6. package/deploymentElasticsearchKeystore.js.map +1 -1
  7. package/deploymentExtension.d.ts +31 -88
  8. package/deploymentExtension.js +5 -62
  9. package/deploymentExtension.js.map +1 -1
  10. package/deploymentTrafficFilter.d.ts +41 -30
  11. package/deploymentTrafficFilter.js +20 -12
  12. package/deploymentTrafficFilter.js.map +1 -1
  13. package/deploymentTrafficFilterAssociation.d.ts +7 -7
  14. package/deploymentTrafficFilterAssociation.js +1 -1
  15. package/getAwsPrivatelinkEndpoint.d.ts +7 -8
  16. package/getAwsPrivatelinkEndpoint.js +4 -8
  17. package/getAwsPrivatelinkEndpoint.js.map +1 -1
  18. package/getAzurePrivatelinkEndpoint.d.ts +3 -4
  19. package/getAzurePrivatelinkEndpoint.js +0 -4
  20. package/getAzurePrivatelinkEndpoint.js.map +1 -1
  21. package/getDeployment.d.ts +5 -83
  22. package/getDeployment.js.map +1 -1
  23. package/getDeployments.d.ts +75 -85
  24. package/getDeployments.js +21 -21
  25. package/getDeployments.js.map +1 -1
  26. package/getGcpPrivateServiceConnectEndpoint.d.ts +5 -6
  27. package/getGcpPrivateServiceConnectEndpoint.js +0 -4
  28. package/getGcpPrivateServiceConnectEndpoint.js.map +1 -1
  29. package/getStack.d.ts +23 -32
  30. package/getStack.js +4 -0
  31. package/getStack.js.map +1 -1
  32. package/getTrafficFilter.d.ts +99 -0
  33. package/getTrafficFilter.js +62 -0
  34. package/getTrafficFilter.js.map +1 -0
  35. package/index.d.ts +6 -0
  36. package/index.js +9 -1
  37. package/index.js.map +1 -1
  38. package/package.json +2 -2
  39. package/provider.js +1 -1
  40. package/provider.js.map +1 -1
  41. package/snapshotRepository.d.ts +87 -0
  42. package/snapshotRepository.js +66 -0
  43. package/snapshotRepository.js.map +1 -0
  44. package/types/input.d.ts +317 -353
  45. package/types/output.d.ts +586 -384
package/types/output.d.ts CHANGED
@@ -1,552 +1,440 @@
1
1
  import * as outputs from "../types/output";
2
2
  export interface DeploymentApm {
3
3
  /**
4
- * APM settings applied to all topologies unless overridden in the `topology` element.
4
+ * Optionally define the Apm configuration options for the APM Server
5
5
  */
6
6
  config?: outputs.DeploymentApmConfig;
7
- /**
8
- * This field references the `refId` of the deployment Elasticsearch cluster. The default value `main-elasticsearch` is recommended.
9
- */
10
- elasticsearchClusterRefId?: string;
7
+ elasticsearchClusterRefId: string;
11
8
  httpEndpoint: string;
12
9
  httpsEndpoint: string;
10
+ instanceConfigurationId: string;
11
+ refId: string;
13
12
  /**
14
- * Can be set on the APM resource. The default value `main-apm` is recommended.
15
- */
16
- refId?: string;
17
- /**
18
- * Elasticsearch Service (ESS) region where to create the deployment. For Elastic Cloud Enterprise (ECE) installations, set `"ece-region"`.
13
+ * Elasticsearch Service (ESS) region where the deployment should be hosted. For Elastic Cloud Enterprise (ECE) installations, set to `"ece-region".
19
14
  */
20
15
  region: string;
21
16
  resourceId: string;
17
+ size: string;
22
18
  /**
23
- * Can be set multiple times to compose complex topologies.
19
+ * Optional size type, defaults to "memory".
24
20
  */
25
- topology: outputs.DeploymentApmTopology;
21
+ sizeResource: string;
22
+ zoneCount: number;
26
23
  }
27
24
  export interface DeploymentApmConfig {
28
- /**
29
- * Enable debug mode for APM servers. Defaults to `false`.
30
- */
31
- debugEnabled?: boolean;
25
+ debugEnabled: boolean;
32
26
  dockerImage?: string;
33
- /**
34
- * JSON-formatted user level `enterprise_search.yml` setting overrides.
35
- */
36
27
  userSettingsJson?: string;
37
- /**
38
- * JSON-formatted admin (ECE) level `enterprise_search.yml` setting overrides.
39
- */
40
28
  userSettingsOverrideJson?: string;
41
- /**
42
- * YAML-formatted admin (ECE) level `enterprise_search.yml` setting overrides.
43
- */
44
29
  userSettingsOverrideYaml?: string;
45
- /**
46
- * YAML-formatted user level `enterprise_search.yml` setting overrides.
47
- */
48
30
  userSettingsYaml?: string;
49
31
  }
50
- export interface DeploymentApmTopology {
32
+ export interface DeploymentElasticsearch {
51
33
  /**
52
- * Default instance configuration of the deployment template. To change it, use the [full list](https://www.elastic.co/guide/en/cloud/current/ec-regions-templates-instances.html) of regions and deployment templates available in ESS.
34
+ * Enable or disable autoscaling. Defaults to the setting coming from the deployment template.
53
35
  */
54
- instanceConfigurationId: string;
36
+ autoscale: boolean;
37
+ cloudId: string;
55
38
  /**
56
- * Amount of memory (RAM) per `topology` element in the "<size in GB>g" notation. When omitted, it defaults to the deployment template value.
39
+ * 'cold' topology element
57
40
  */
58
- size: string;
41
+ cold?: outputs.DeploymentElasticsearchCold;
59
42
  /**
60
- * Type of resource to which the size is assigned. Defaults to `"memory"`.
43
+ * Elasticsearch settings which will be applied to all topologies
61
44
  */
62
- sizeResource?: string;
45
+ config?: outputs.DeploymentElasticsearchConfig;
63
46
  /**
64
- * Number of zones that the Enterprise Search deployment will span. This is used to set HA. When omitted, it defaults to the deployment template value.
47
+ * 'coordinating' topology element
65
48
  */
66
- zoneCount: number;
67
- }
68
- export interface DeploymentElasticsearch {
49
+ coordinating?: outputs.DeploymentElasticsearchCoordinating;
69
50
  /**
70
- * Enable or disable autoscaling. Defaults to the setting coming from the deployment template. Accepted values are `"true"` or `"false"`.
51
+ * Optional Elasticsearch extensions such as custom bundles or plugins.
71
52
  */
72
- autoscale: string;
73
- cloudId: string;
53
+ extensions?: outputs.DeploymentElasticsearchExtension[];
74
54
  /**
75
- * Elasticsearch settings applied to all topologies unless overridden in the `topology` element.
55
+ * 'frozen' topology element
76
56
  */
77
- config?: outputs.DeploymentElasticsearchConfig;
57
+ frozen?: outputs.DeploymentElasticsearchFrozen;
78
58
  /**
79
- * Custom Elasticsearch bundles or plugins. Can be set multiple times.
59
+ * 'hot' topology element
80
60
  */
81
- extensions?: outputs.DeploymentElasticsearchExtension[];
61
+ hot: outputs.DeploymentElasticsearchHot;
82
62
  httpEndpoint: string;
83
63
  httpsEndpoint: string;
84
64
  /**
85
- * Can be set on the Elasticsearch resource. The default value `main-elasticsearch` is recommended.
65
+ * 'master' topology element
86
66
  */
87
- refId?: string;
67
+ master?: outputs.DeploymentElasticsearchMaster;
88
68
  /**
89
- * Elasticsearch Service (ESS) region where to create the deployment. For Elastic Cloud Enterprise (ECE) installations, set `"ece-region"`.
69
+ * 'ml' topology element
90
70
  */
91
- region: string;
92
- /**
93
- * Elasticsearch remote clusters to configure for the Elasticsearch resource. Can be set multiple times.
94
- */
95
- remoteClusters?: outputs.DeploymentElasticsearchRemoteCluster[];
96
- resourceId: string;
71
+ ml?: outputs.DeploymentElasticsearchMl;
97
72
  /**
98
- * Restores data from a snapshot of another deployment.
73
+ * A human readable reference for the Elasticsearch resource. The default value `main-elasticsearch` is recommended.
99
74
  */
100
- snapshotSource?: outputs.DeploymentElasticsearchSnapshotSource;
75
+ refId: string;
101
76
  /**
102
- * Choose the configuration strategy used to apply the changes.
77
+ * Elasticsearch Service (ESS) region where the deployment should be hosted. For Elastic Cloud Enterprise (ECE) installations, set to `"ece-region".
103
78
  */
104
- strategy?: outputs.DeploymentElasticsearchStrategy;
79
+ region: string;
105
80
  /**
106
- * Can be set multiple times to compose complex topologies.
81
+ * Optional Elasticsearch remote clusters to configure for the Elasticsearch resource, can be set multiple times
107
82
  */
108
- topologies: outputs.DeploymentElasticsearchTopology[];
83
+ remoteClusters?: outputs.DeploymentElasticsearchRemoteCluster[];
84
+ resourceId: string;
109
85
  /**
110
- * The trust relationships with other ESS accounts.
86
+ * (ECE only) Snapshot configuration settings for an Elasticsearch cluster.
111
87
  */
88
+ snapshot: outputs.DeploymentElasticsearchSnapshot;
89
+ snapshotSource?: outputs.DeploymentElasticsearchSnapshotSource;
90
+ strategy?: string;
112
91
  trustAccounts: outputs.DeploymentElasticsearchTrustAccount[];
113
- /**
114
- * The trust relationship with external entities (remote environments, remote accounts...).
115
- */
116
92
  trustExternals: outputs.DeploymentElasticsearchTrustExternal[];
93
+ warm?: outputs.DeploymentElasticsearchWarm;
94
+ }
95
+ export interface DeploymentElasticsearchCold {
96
+ autoscaling: outputs.DeploymentElasticsearchColdAutoscaling;
97
+ instanceConfigurationId: string;
98
+ nodeRoles: string[];
99
+ nodeTypeData: string;
100
+ nodeTypeIngest: string;
101
+ nodeTypeMaster: string;
102
+ nodeTypeMl: string;
103
+ size: string;
104
+ sizeResource: string;
105
+ zoneCount: number;
106
+ }
107
+ export interface DeploymentElasticsearchColdAutoscaling {
108
+ maxSize: string;
109
+ maxSizeResource: string;
110
+ minSize: string;
111
+ minSizeResource: string;
112
+ policyOverrideJson: string;
117
113
  }
118
114
  export interface DeploymentElasticsearchConfig {
119
115
  dockerImage?: string;
120
- /**
121
- * List of Elasticsearch supported plugins. Check the Stack Pack version to see which plugins are supported for each version. This is currently only available from the UI and [ecctl](https://www.elastic.co/guide/en/ecctl/master/ecctl_stack_list.html).
122
- */
123
- plugins?: string[];
124
- /**
125
- * JSON-formatted user level `enterprise_search.yml` setting overrides.
126
- */
116
+ plugins: string[];
127
117
  userSettingsJson?: string;
128
- /**
129
- * JSON-formatted admin (ECE) level `enterprise_search.yml` setting overrides.
130
- */
131
118
  userSettingsOverrideJson?: string;
132
- /**
133
- * YAML-formatted admin (ECE) level `enterprise_search.yml` setting overrides.
134
- */
135
119
  userSettingsOverrideYaml?: string;
136
- /**
137
- * YAML-formatted user level `enterprise_search.yml` setting overrides.
138
- */
139
120
  userSettingsYaml?: string;
140
121
  }
122
+ export interface DeploymentElasticsearchCoordinating {
123
+ autoscaling: outputs.DeploymentElasticsearchCoordinatingAutoscaling;
124
+ instanceConfigurationId: string;
125
+ nodeRoles: string[];
126
+ nodeTypeData: string;
127
+ nodeTypeIngest: string;
128
+ nodeTypeMaster: string;
129
+ nodeTypeMl: string;
130
+ size: string;
131
+ sizeResource: string;
132
+ zoneCount: number;
133
+ }
134
+ export interface DeploymentElasticsearchCoordinatingAutoscaling {
135
+ maxSize: string;
136
+ maxSizeResource: string;
137
+ minSize: string;
138
+ minSizeResource: string;
139
+ policyOverrideJson: string;
140
+ }
141
141
  export interface DeploymentElasticsearchExtension {
142
- /**
143
- * Extension name.
144
- */
145
142
  name: string;
146
- /**
147
- * Extension type, only `bundle` or `plugin` are supported.
148
- */
149
143
  type: string;
150
- /**
151
- * Bundle or plugin URL, the extension URL can be obtained from the `ec_deployment_extension.<name>.url` attribute or the API and cannot be a random HTTP address that is hosted elsewhere.
152
- */
153
144
  url: string;
154
145
  /**
155
- * Elasticsearch compatibility version. Bundles should specify major or minor versions with wildcards, such as `7.*` or `*` but **plugins must use full version notation down to the patch level**, such as `7.10.1` and wildcards are not allowed.
146
+ * Elastic Stack version to use for all of the deployment resources.
156
147
  */
157
148
  version: string;
158
149
  }
159
- export interface DeploymentElasticsearchRemoteCluster {
160
- /**
161
- * Alias for the Cross Cluster Search binding.
162
- */
163
- alias: string;
164
- /**
165
- * Remote deployment ID.
166
- */
167
- deploymentId: string;
168
- /**
169
- * Remote Elasticsearch `refId`. The default value `main-elasticsearch` is recommended.
170
- */
171
- refId?: string;
172
- /**
173
- * If true, skip the cluster during search when disconnected. Defaults to `false`.
174
- */
175
- skipUnavailable?: boolean;
150
+ export interface DeploymentElasticsearchFrozen {
151
+ autoscaling: outputs.DeploymentElasticsearchFrozenAutoscaling;
152
+ instanceConfigurationId: string;
153
+ nodeRoles: string[];
154
+ nodeTypeData: string;
155
+ nodeTypeIngest: string;
156
+ nodeTypeMaster: string;
157
+ nodeTypeMl: string;
158
+ size: string;
159
+ sizeResource: string;
160
+ zoneCount: number;
176
161
  }
177
- export interface DeploymentElasticsearchSnapshotSource {
178
- /**
179
- * Name of the snapshot to restore. Use `__latest_success__` to get the most recent successful snapshot (Defaults to `__latest_success__`).
180
- */
181
- snapshotName?: string;
182
- /**
183
- * ID of the Elasticsearch cluster, not to be confused with the deployment ID, that will be used as the source of the snapshot. The Elasticsearch cluster must be in the same region and must have a compatible version of the Elastic Stack.
184
- */
185
- sourceElasticsearchClusterId: string;
162
+ export interface DeploymentElasticsearchFrozenAutoscaling {
163
+ maxSize: string;
164
+ maxSizeResource: string;
165
+ minSize: string;
166
+ minSizeResource: string;
167
+ policyOverrideJson: string;
186
168
  }
187
- export interface DeploymentElasticsearchStrategy {
188
- /**
189
- * Set the type of configuration strategy [autodetect, grow_and_shrink, rolling_grow_and_shrink, rollingAll].
190
- */
191
- type: string;
169
+ export interface DeploymentElasticsearchHot {
170
+ autoscaling: outputs.DeploymentElasticsearchHotAutoscaling;
171
+ instanceConfigurationId: string;
172
+ nodeRoles: string[];
173
+ nodeTypeData: string;
174
+ nodeTypeIngest: string;
175
+ nodeTypeMaster: string;
176
+ nodeTypeMl: string;
177
+ size: string;
178
+ sizeResource: string;
179
+ zoneCount: number;
192
180
  }
193
- export interface DeploymentElasticsearchTopology {
194
- /**
195
- * Autoscaling policy defining the maximum and / or minimum total size for this topology element. For more information refer to the `autoscaling` block.
196
- */
197
- autoscaling: outputs.DeploymentElasticsearchTopologyAutoscaling;
198
- /**
199
- * Elasticsearch settings applied to all topologies unless overridden in the `topology` element.
200
- */
201
- configs: outputs.DeploymentElasticsearchTopologyConfig[];
202
- /**
203
- * Unique topology identifier. It generally refers to an Elasticsearch data tier, such as `hotContent`, `warm`, `cold`, `coordinating`, `frozen`, `ml` or `master`.
204
- */
205
- id: string;
206
- /**
207
- * Default instance configuration of the deployment template. To change it, use the [full list](https://www.elastic.co/guide/en/cloud/current/ec-regions-templates-instances.html) of regions and deployment templates available in ESS.
208
- */
181
+ export interface DeploymentElasticsearchHotAutoscaling {
182
+ maxSize: string;
183
+ maxSizeResource: string;
184
+ minSize: string;
185
+ minSizeResource: string;
186
+ policyOverrideJson: string;
187
+ }
188
+ export interface DeploymentElasticsearchMaster {
189
+ autoscaling: outputs.DeploymentElasticsearchMasterAutoscaling;
209
190
  instanceConfigurationId: string;
210
191
  nodeRoles: string[];
211
- /**
212
- * The node type for the Elasticsearch cluster (data node).
213
- */
214
192
  nodeTypeData: string;
215
- /**
216
- * The node type for the Elasticsearch cluster (ingest node).
217
- */
218
193
  nodeTypeIngest: string;
219
- /**
220
- * The node type for the Elasticsearch cluster (master node).
221
- */
222
194
  nodeTypeMaster: string;
223
- /**
224
- * The node type for the Elasticsearch cluster (machine learning node).
225
- */
226
195
  nodeTypeMl: string;
227
- /**
228
- * Amount of memory (RAM) per `topology` element in the "<size in GB>g" notation. When omitted, it defaults to the deployment template value.
229
- */
230
196
  size: string;
231
- /**
232
- * Type of resource to which the size is assigned. Defaults to `"memory"`.
233
- */
234
- sizeResource?: string;
235
- /**
236
- * Number of zones that the Enterprise Search deployment will span. This is used to set HA. When omitted, it defaults to the deployment template value.
237
- */
197
+ sizeResource: string;
238
198
  zoneCount: number;
239
199
  }
240
- export interface DeploymentElasticsearchTopologyAutoscaling {
241
- /**
242
- * Defines the maximum size the deployment will scale up to. When set, scaling up will be enabled. All tiers should support this option.
243
- */
200
+ export interface DeploymentElasticsearchMasterAutoscaling {
244
201
  maxSize: string;
245
- /**
246
- * Defines the resource type the scale up will use (Defaults to `"memory"`).
247
- */
248
202
  maxSizeResource: string;
249
- /**
250
- * Defines the minimum size the deployment will scale down to. When set, scale down will be enabled, please note that not all the tiers support this option.
251
- */
252
203
  minSize: string;
253
- /**
254
- * Defines the resource type the scale down will use (Defaults to `"memory"`).
255
- */
256
204
  minSizeResource: string;
257
205
  policyOverrideJson: string;
258
206
  }
259
- export interface DeploymentElasticsearchTopologyConfig {
260
- /**
261
- * List of Elasticsearch supported plugins. Check the Stack Pack version to see which plugins are supported for each version. This is currently only available from the UI and [ecctl](https://www.elastic.co/guide/en/ecctl/master/ecctl_stack_list.html).
262
- */
263
- plugins: string[];
264
- /**
265
- * JSON-formatted user level `enterprise_search.yml` setting overrides.
266
- */
267
- userSettingsJson: string;
268
- /**
269
- * JSON-formatted admin (ECE) level `enterprise_search.yml` setting overrides.
270
- */
271
- userSettingsOverrideJson: string;
272
- /**
273
- * YAML-formatted admin (ECE) level `enterprise_search.yml` setting overrides.
274
- */
275
- userSettingsOverrideYaml: string;
276
- /**
277
- * YAML-formatted user level `enterprise_search.yml` setting overrides.
278
- */
279
- userSettingsYaml: string;
207
+ export interface DeploymentElasticsearchMl {
208
+ autoscaling: outputs.DeploymentElasticsearchMlAutoscaling;
209
+ instanceConfigurationId: string;
210
+ nodeRoles: string[];
211
+ nodeTypeData: string;
212
+ nodeTypeIngest: string;
213
+ nodeTypeMaster: string;
214
+ nodeTypeMl: string;
215
+ size: string;
216
+ sizeResource: string;
217
+ zoneCount: number;
218
+ }
219
+ export interface DeploymentElasticsearchMlAutoscaling {
220
+ maxSize: string;
221
+ maxSizeResource: string;
222
+ minSize: string;
223
+ minSizeResource: string;
224
+ policyOverrideJson: string;
225
+ }
226
+ export interface DeploymentElasticsearchRemoteCluster {
227
+ alias: string;
228
+ deploymentId: string;
229
+ refId: string;
230
+ skipUnavailable: boolean;
231
+ }
232
+ export interface DeploymentElasticsearchSnapshot {
233
+ enabled: boolean;
234
+ repository: outputs.DeploymentElasticsearchSnapshotRepository;
235
+ }
236
+ export interface DeploymentElasticsearchSnapshotRepository {
237
+ reference: outputs.DeploymentElasticsearchSnapshotRepositoryReference;
238
+ }
239
+ export interface DeploymentElasticsearchSnapshotRepositoryReference {
240
+ repositoryName: string;
241
+ }
242
+ export interface DeploymentElasticsearchSnapshotSource {
243
+ snapshotName: string;
244
+ sourceElasticsearchClusterId: string;
280
245
  }
281
246
  export interface DeploymentElasticsearchTrustAccount {
282
- /**
283
- * The account identifier to establish the new trust with.
284
- */
285
247
  accountId: string;
286
- /**
287
- * If true, all clusters in this account will by default be trusted and the `trustAllowlist` is ignored.
288
- */
289
248
  trustAll: boolean;
290
- /**
291
- * The list of clusters to trust. Only used when `trustAll` is `false`.
292
- */
293
249
  trustAllowlists?: string[];
294
250
  }
295
251
  export interface DeploymentElasticsearchTrustExternal {
296
- /**
297
- * Identifier of the the trust relationship with external entities (remote environments, remote accounts...).
298
- */
299
252
  relationshipId: string;
300
- /**
301
- * If true, all clusters in this external entity will be trusted and the `trustAllowlist` is ignored.
302
- */
303
253
  trustAll: boolean;
304
- /**
305
- * The list of clusters to trust. Only used when `trustAll` is `false`.
306
- */
307
254
  trustAllowlists?: string[];
308
255
  }
256
+ export interface DeploymentElasticsearchWarm {
257
+ autoscaling: outputs.DeploymentElasticsearchWarmAutoscaling;
258
+ instanceConfigurationId: string;
259
+ nodeRoles: string[];
260
+ nodeTypeData: string;
261
+ nodeTypeIngest: string;
262
+ nodeTypeMaster: string;
263
+ nodeTypeMl: string;
264
+ size: string;
265
+ sizeResource: string;
266
+ zoneCount: number;
267
+ }
268
+ export interface DeploymentElasticsearchWarmAutoscaling {
269
+ maxSize: string;
270
+ maxSizeResource: string;
271
+ minSize: string;
272
+ minSizeResource: string;
273
+ policyOverrideJson: string;
274
+ }
309
275
  export interface DeploymentEnterpriseSearch {
310
276
  /**
311
- * Enterprise Search settings applied to all topologies unless overridden in the `topology` element.
277
+ * Optionally define the Enterprise Search configuration options for the Enterprise Search Server
312
278
  */
313
279
  config?: outputs.DeploymentEnterpriseSearchConfig;
314
- /**
315
- * This field references the `refId` of the deployment Elasticsearch cluster. The default value `main-elasticsearch` is recommended.
316
- */
317
- elasticsearchClusterRefId?: string;
280
+ elasticsearchClusterRefId: string;
318
281
  httpEndpoint: string;
319
282
  httpsEndpoint: string;
283
+ instanceConfigurationId: string;
284
+ nodeTypeAppserver: boolean;
285
+ nodeTypeConnector: boolean;
286
+ nodeTypeWorker: boolean;
287
+ refId: string;
320
288
  /**
321
- * Can be set on the Enterprise Search resource. The default value `main-enterprise_search` is recommended.
322
- */
323
- refId?: string;
324
- /**
325
- * Elasticsearch Service (ESS) region where to create the deployment. For Elastic Cloud Enterprise (ECE) installations, set `"ece-region"`.
289
+ * Elasticsearch Service (ESS) region where the deployment should be hosted. For Elastic Cloud Enterprise (ECE) installations, set to `"ece-region".
326
290
  */
327
291
  region: string;
328
292
  resourceId: string;
293
+ size: string;
329
294
  /**
330
- * Can be set multiple times to compose complex topologies.
295
+ * Optional size type, defaults to "memory".
331
296
  */
332
- topology: outputs.DeploymentEnterpriseSearchTopology;
297
+ sizeResource: string;
298
+ zoneCount: number;
333
299
  }
334
300
  export interface DeploymentEnterpriseSearchConfig {
335
301
  dockerImage?: string;
336
- /**
337
- * JSON-formatted user level `enterprise_search.yml` setting overrides.
338
- */
339
302
  userSettingsJson?: string;
340
- /**
341
- * JSON-formatted admin (ECE) level `enterprise_search.yml` setting overrides.
342
- */
343
303
  userSettingsOverrideJson?: string;
344
- /**
345
- * YAML-formatted admin (ECE) level `enterprise_search.yml` setting overrides.
346
- */
347
304
  userSettingsOverrideYaml?: string;
348
- /**
349
- * YAML-formatted user level `enterprise_search.yml` setting overrides.
350
- */
351
305
  userSettingsYaml?: string;
352
306
  }
353
- export interface DeploymentEnterpriseSearchTopology {
354
- /**
355
- * Default instance configuration of the deployment template. To change it, use the [full list](https://www.elastic.co/guide/en/cloud/current/ec-regions-templates-instances.html) of regions and deployment templates available in ESS.
356
- */
357
- instanceConfigurationId: string;
358
- nodeTypeAppserver: boolean;
359
- nodeTypeConnector: boolean;
360
- nodeTypeWorker: boolean;
361
- /**
362
- * Amount of memory (RAM) per `topology` element in the "<size in GB>g" notation. When omitted, it defaults to the deployment template value.
363
- */
364
- size: string;
365
- /**
366
- * Type of resource to which the size is assigned. Defaults to `"memory"`.
367
- */
368
- sizeResource?: string;
369
- /**
370
- * Number of zones that the Enterprise Search deployment will span. This is used to set HA. When omitted, it defaults to the deployment template value.
371
- */
372
- zoneCount: number;
373
- }
374
307
  export interface DeploymentIntegrationsServer {
375
- apmHttpsEndpoint: string;
376
308
  /**
377
- * Integrations Server settings applied to all topologies unless overridden in the `topology` element.
309
+ * Optionally define the Integrations Server configuration options for the IntegrationsServer Server
378
310
  */
379
311
  config?: outputs.DeploymentIntegrationsServerConfig;
312
+ elasticsearchClusterRefId: string;
380
313
  /**
381
- * This field references the `refId` of the deployment Elasticsearch cluster. The default value `main-elasticsearch` is recommended.
314
+ * URLs for the accessing the Fleet and APM API's within this Integrations Server resource.
382
315
  */
383
- elasticsearchClusterRefId?: string;
384
- fleetHttpsEndpoint: string;
316
+ endpoints: outputs.DeploymentIntegrationsServerEndpoints;
385
317
  httpEndpoint: string;
386
318
  httpsEndpoint: string;
319
+ instanceConfigurationId: string;
320
+ refId: string;
387
321
  /**
388
- * Can be set on the Integrations Server resource. The default value `main-integrations_server` is recommended.
389
- */
390
- refId?: string;
391
- /**
392
- * Elasticsearch Service (ESS) region where to create the deployment. For Elastic Cloud Enterprise (ECE) installations, set `"ece-region"`.
322
+ * Elasticsearch Service (ESS) region where the deployment should be hosted. For Elastic Cloud Enterprise (ECE) installations, set to `"ece-region".
393
323
  */
394
324
  region: string;
395
325
  resourceId: string;
396
- /**
397
- * Can be set multiple times to compose complex topologies.
398
- */
399
- topology: outputs.DeploymentIntegrationsServerTopology;
400
- }
401
- export interface DeploymentIntegrationsServerConfig {
402
- /**
403
- * Enable debug mode for APM servers. Defaults to `false`.
404
- */
405
- debugEnabled?: boolean;
406
- dockerImage?: string;
407
- /**
408
- * JSON-formatted user level `enterprise_search.yml` setting overrides.
409
- */
410
- userSettingsJson?: string;
411
- /**
412
- * JSON-formatted admin (ECE) level `enterprise_search.yml` setting overrides.
413
- */
414
- userSettingsOverrideJson?: string;
415
- /**
416
- * YAML-formatted admin (ECE) level `enterprise_search.yml` setting overrides.
417
- */
418
- userSettingsOverrideYaml?: string;
419
- /**
420
- * YAML-formatted user level `enterprise_search.yml` setting overrides.
421
- */
422
- userSettingsYaml?: string;
423
- }
424
- export interface DeploymentIntegrationsServerTopology {
425
- /**
426
- * Default instance configuration of the deployment template. To change it, use the [full list](https://www.elastic.co/guide/en/cloud/current/ec-regions-templates-instances.html) of regions and deployment templates available in ESS.
427
- */
428
- instanceConfigurationId: string;
429
- /**
430
- * Amount of memory (RAM) per `topology` element in the "<size in GB>g" notation. When omitted, it defaults to the deployment template value.
431
- */
432
326
  size: string;
433
327
  /**
434
- * Type of resource to which the size is assigned. Defaults to `"memory"`.
435
- */
436
- sizeResource?: string;
437
- /**
438
- * Number of zones that the Enterprise Search deployment will span. This is used to set HA. When omitted, it defaults to the deployment template value.
328
+ * Optional size type, defaults to "memory".
439
329
  */
330
+ sizeResource: string;
440
331
  zoneCount: number;
441
332
  }
442
- export interface DeploymentKibana {
443
- /**
444
- * Kibana settings applied to all topologies unless overridden in the `topology` element.
445
- */
446
- config?: outputs.DeploymentKibanaConfig;
447
- /**
448
- * This field references the `refId` of the deployment Elasticsearch cluster. The default value `main-elasticsearch` is recommended.
449
- */
450
- elasticsearchClusterRefId?: string;
451
- httpEndpoint: string;
452
- httpsEndpoint: string;
453
- /**
454
- * Can be set on the Kibana resource. The default value `main-kibana` is recommended.
455
- */
456
- refId?: string;
457
- /**
458
- * Elasticsearch Service (ESS) region where to create the deployment. For Elastic Cloud Enterprise (ECE) installations, set `"ece-region"`.
459
- */
460
- region: string;
461
- resourceId: string;
462
- /**
463
- * Can be set multiple times to compose complex topologies.
464
- */
465
- topology: outputs.DeploymentKibanaTopology;
466
- }
467
- export interface DeploymentKibanaConfig {
333
+ export interface DeploymentIntegrationsServerConfig {
334
+ debugEnabled: boolean;
468
335
  dockerImage?: string;
469
- /**
470
- * JSON-formatted user level `enterprise_search.yml` setting overrides.
471
- */
472
336
  userSettingsJson?: string;
473
- /**
474
- * JSON-formatted admin (ECE) level `enterprise_search.yml` setting overrides.
475
- */
476
337
  userSettingsOverrideJson?: string;
477
- /**
478
- * YAML-formatted admin (ECE) level `enterprise_search.yml` setting overrides.
479
- */
480
338
  userSettingsOverrideYaml?: string;
481
- /**
482
- * YAML-formatted user level `enterprise_search.yml` setting overrides.
483
- */
484
339
  userSettingsYaml?: string;
485
340
  }
486
- export interface DeploymentKibanaTopology {
341
+ export interface DeploymentIntegrationsServerEndpoints {
342
+ apm: string;
343
+ fleet: string;
344
+ }
345
+ export interface DeploymentKibana {
487
346
  /**
488
- * Default instance configuration of the deployment template. To change it, use the [full list](https://www.elastic.co/guide/en/cloud/current/ec-regions-templates-instances.html) of regions and deployment templates available in ESS.
347
+ * Optionally define the Kibana configuration options for the Kibana Server
489
348
  */
349
+ config?: outputs.DeploymentKibanaConfig;
350
+ elasticsearchClusterRefId: string;
351
+ httpEndpoint: string;
352
+ httpsEndpoint: string;
490
353
  instanceConfigurationId: string;
354
+ refId: string;
491
355
  /**
492
- * Amount of memory (RAM) per `topology` element in the "<size in GB>g" notation. When omitted, it defaults to the deployment template value.
356
+ * Elasticsearch Service (ESS) region where the deployment should be hosted. For Elastic Cloud Enterprise (ECE) installations, set to `"ece-region".
493
357
  */
358
+ region: string;
359
+ resourceId: string;
494
360
  size: string;
495
361
  /**
496
- * Type of resource to which the size is assigned. Defaults to `"memory"`.
497
- */
498
- sizeResource?: string;
499
- /**
500
- * Number of zones that the Enterprise Search deployment will span. This is used to set HA. When omitted, it defaults to the deployment template value.
362
+ * Optional size type, defaults to "memory".
501
363
  */
364
+ sizeResource: string;
502
365
  zoneCount: number;
503
366
  }
367
+ export interface DeploymentKibanaConfig {
368
+ dockerImage?: string;
369
+ userSettingsJson?: string;
370
+ userSettingsOverrideJson?: string;
371
+ userSettingsOverrideYaml?: string;
372
+ userSettingsYaml?: string;
373
+ }
504
374
  export interface DeploymentObservability {
505
- /**
506
- * Remote deployment ID.
507
- */
508
375
  deploymentId: string;
509
- logs?: boolean;
510
- metrics?: boolean;
511
- /**
512
- * Can be set on the Elasticsearch resource. The default value `main-elasticsearch` is recommended.
513
- */
376
+ logs: boolean;
377
+ metrics: boolean;
514
378
  refId: string;
515
379
  }
516
380
  export interface DeploymentTrafficFilterRule {
517
381
  /**
518
- * Azure endpoint GUID. Only applicable when the ruleset type is set to `"azurePrivateEndpoint"`.
382
+ * Azure endpoint GUID. Only applicable when the ruleset type is set to `azurePrivateEndpoint`
519
383
  */
520
384
  azureEndpointGuid?: string;
521
385
  /**
522
- * Azure endpoint name. Only applicable when the ruleset type is set to `"azurePrivateEndpoint"`.
386
+ * Azure endpoint name. Only applicable when the ruleset type is set to `azurePrivateEndpoint`
523
387
  */
524
388
  azureEndpointName?: string;
525
389
  /**
526
- * Description of this individual rule.
390
+ * Description of this individual rule
527
391
  */
528
392
  description?: string;
529
393
  /**
530
- * The ruleset ID.
394
+ * Computed rule ID
531
395
  */
532
396
  id: string;
533
397
  /**
534
- * traffic filter source: IP address, CIDR mask, or VPC endpoint ID, **only required** when the type is not `"azurePrivateEndpoint"`.
398
+ * Traffic filter source: IP address, CIDR mask, or VPC endpoint ID, **only required** when the type is not `azurePrivateEndpoint`
535
399
  */
536
400
  source?: string;
537
401
  }
538
402
  export interface GetDeploymentApm {
403
+ /**
404
+ * The locally-unique user-specified id of an APM Resource.
405
+ */
539
406
  elasticsearchClusterRefId: string;
540
407
  /**
541
- * Overall health status of the deployment.
408
+ * APM resource health status.
542
409
  */
543
410
  healthy: boolean;
411
+ /**
412
+ * HTTP endpoint for the APM resource.
413
+ */
544
414
  httpEndpoint: string;
415
+ /**
416
+ * HTTPS endpoint for the APM resource.
417
+ */
545
418
  httpsEndpoint: string;
419
+ /**
420
+ * A locally-unique friendly alias for this APM resource.
421
+ */
546
422
  refId: string;
423
+ /**
424
+ * The resource unique identifier.
425
+ */
547
426
  resourceId: string;
427
+ /**
428
+ * APM resource status (for example, "started", "stopped", etc).
429
+ */
548
430
  status: string;
431
+ /**
432
+ * Node topology element definition.
433
+ */
549
434
  topologies: outputs.GetDeploymentApmTopology[];
435
+ /**
436
+ * Elastic stack version.
437
+ */
550
438
  version: string;
551
439
  }
552
440
  export interface GetDeploymentApmTopology {
@@ -556,18 +444,45 @@ export interface GetDeploymentApmTopology {
556
444
  zoneCount: number;
557
445
  }
558
446
  export interface GetDeploymentElasticsearch {
447
+ /**
448
+ * Whether or not Elasticsearch autoscaling is enabled.
449
+ */
559
450
  autoscale: string;
451
+ /**
452
+ * The cloud ID, an encoded string that provides other Elastic services with the necessary information to connect to this Elasticsearch and Kibana. See [Configure Beats and Logstash with Cloud ID](https://www.elastic.co/guide/en/cloud/current/ec-cloud-id.html) for more information.
453
+ */
560
454
  cloudId: string;
561
455
  /**
562
- * Overall health status of the deployment.
456
+ * Elasticsearch resource health status.
563
457
  */
564
458
  healthy: boolean;
459
+ /**
460
+ * HTTP endpoint for the Elasticsearch resource.
461
+ */
565
462
  httpEndpoint: string;
463
+ /**
464
+ * HTTPS endpoint for the Elasticsearch resource.
465
+ */
566
466
  httpsEndpoint: string;
467
+ /**
468
+ * A locally-unique friendly alias for this Elasticsearch cluster.
469
+ */
567
470
  refId: string;
471
+ /**
472
+ * The resource unique identifier.
473
+ */
568
474
  resourceId: string;
475
+ /**
476
+ * Elasticsearch resource status (for example, "started", "stopped", etc).
477
+ */
569
478
  status: string;
479
+ /**
480
+ * Node topology element definition.
481
+ */
570
482
  topologies: outputs.GetDeploymentElasticsearchTopology[];
483
+ /**
484
+ * Elastic stack version.
485
+ */
571
486
  version: string;
572
487
  }
573
488
  export interface GetDeploymentElasticsearchTopology {
@@ -577,7 +492,7 @@ export interface GetDeploymentElasticsearchTopology {
577
492
  nodeTypeData: boolean;
578
493
  nodeTypeIngest: boolean;
579
494
  nodeTypeMaster: boolean;
580
- nodeTypeMl?: boolean;
495
+ nodeTypeMl: boolean;
581
496
  size: string;
582
497
  sizeResource: string;
583
498
  zoneCount: number;
@@ -590,17 +505,41 @@ export interface GetDeploymentElasticsearchTopologyAutoscaling {
590
505
  policyOverrideJson: string;
591
506
  }
592
507
  export interface GetDeploymentEnterpriseSearch {
508
+ /**
509
+ * A locally-unique friendly alias for an Elasticsearch resource in this deployment.
510
+ */
593
511
  elasticsearchClusterRefId: string;
594
512
  /**
595
- * Overall health status of the deployment.
513
+ * Enterprise Search resource health status.
596
514
  */
597
515
  healthy: boolean;
516
+ /**
517
+ * HTTP endpoint for the Enterprise Search resource.
518
+ */
598
519
  httpEndpoint: string;
520
+ /**
521
+ * HTTPS endpoint for the Enterprise Search resource.
522
+ */
599
523
  httpsEndpoint: string;
524
+ /**
525
+ * A locally-unique friendly alias for this Enterprise Search resource.
526
+ */
600
527
  refId: string;
528
+ /**
529
+ * The resource unique identifier.
530
+ */
601
531
  resourceId: string;
532
+ /**
533
+ * Enterprise Search resource status (for example, "started", "stopped", etc).
534
+ */
602
535
  status: string;
536
+ /**
537
+ * Node topology element definition.
538
+ */
603
539
  topologies: outputs.GetDeploymentEnterpriseSearchTopology[];
540
+ /**
541
+ * Elastic stack version.
542
+ */
604
543
  version: string;
605
544
  }
606
545
  export interface GetDeploymentEnterpriseSearchTopology {
@@ -613,17 +552,41 @@ export interface GetDeploymentEnterpriseSearchTopology {
613
552
  zoneCount: number;
614
553
  }
615
554
  export interface GetDeploymentIntegrationsServer {
555
+ /**
556
+ * A locally-unique friendly alias for an Elasticsearch resource in this deployment.
557
+ */
616
558
  elasticsearchClusterRefId: string;
617
559
  /**
618
- * Overall health status of the deployment.
560
+ * Resource kind health status.
619
561
  */
620
562
  healthy: boolean;
563
+ /**
564
+ * HTTP endpoint for the resource kind.
565
+ */
621
566
  httpEndpoint: string;
567
+ /**
568
+ * HTTPS endpoint for the resource kind.
569
+ */
622
570
  httpsEndpoint: string;
571
+ /**
572
+ * A locally-unique friendly alias for this Integrations Server resource.
573
+ */
623
574
  refId: string;
575
+ /**
576
+ * The resource unique identifier.
577
+ */
624
578
  resourceId: string;
579
+ /**
580
+ * Resource kind status (for example, "started", "stopped", etc).
581
+ */
625
582
  status: string;
583
+ /**
584
+ * Node topology element definition.
585
+ */
626
586
  topologies: outputs.GetDeploymentIntegrationsServerTopology[];
587
+ /**
588
+ * Elastic stack version.
589
+ */
627
590
  version: string;
628
591
  }
629
592
  export interface GetDeploymentIntegrationsServerTopology {
@@ -633,17 +596,41 @@ export interface GetDeploymentIntegrationsServerTopology {
633
596
  zoneCount: number;
634
597
  }
635
598
  export interface GetDeploymentKibana {
599
+ /**
600
+ * A locally-unique friendly alias for an Elasticsearch resource in this deployment.
601
+ */
636
602
  elasticsearchClusterRefId: string;
637
603
  /**
638
- * Overall health status of the deployment.
604
+ * Kibana resource health status.
639
605
  */
640
606
  healthy: boolean;
607
+ /**
608
+ * HTTP endpoint for the Kibana resource.
609
+ */
641
610
  httpEndpoint: string;
611
+ /**
612
+ * HTTPS endpoint for the Kibana resource.
613
+ */
642
614
  httpsEndpoint: string;
615
+ /**
616
+ * A locally-unique friendly alias for this Kibana resource.
617
+ */
643
618
  refId: string;
619
+ /**
620
+ * The resource unique identifier.
621
+ */
644
622
  resourceId: string;
623
+ /**
624
+ * Kibana resource status (for example, "started", "stopped", etc).
625
+ */
645
626
  status: string;
627
+ /**
628
+ * Node topology element definition.
629
+ */
646
630
  topologies: outputs.GetDeploymentKibanaTopology[];
631
+ /**
632
+ * Elastic stack version.
633
+ */
647
634
  version: string;
648
635
  }
649
636
  export interface GetDeploymentKibanaTopology {
@@ -653,99 +640,314 @@ export interface GetDeploymentKibanaTopology {
653
640
  zoneCount: number;
654
641
  }
655
642
  export interface GetDeploymentObservability {
643
+ /**
644
+ * Destination deployment ID for the shipped logs and monitoring metrics.
645
+ */
656
646
  deploymentId: string;
647
+ /**
648
+ * Defines whether logs are shipped to the destination deployment.
649
+ */
657
650
  logs: boolean;
651
+ /**
652
+ * Defines whether metrics are shipped to the destination deployment.
653
+ */
658
654
  metrics: boolean;
655
+ /**
656
+ * Elasticsearch resource kind refId of the destination deployment.
657
+ */
659
658
  refId: string;
660
659
  }
661
660
  export interface GetDeploymentsApm {
662
661
  /**
663
- * Overall health status of the deployment.
662
+ * Overall health status of the resource instances.
664
663
  */
665
664
  healthy?: string;
665
+ /**
666
+ * Resource kind status. Can be one of `initializing`, `stopping`, `stopped`, `rebooting`, `restarting`.
667
+ */
666
668
  status?: string;
669
+ /**
670
+ * Elastic stack version.
671
+ */
667
672
  version?: string;
668
673
  }
669
674
  export interface GetDeploymentsDeployment {
675
+ /**
676
+ * Deployment alias.
677
+ */
670
678
  alias: string;
679
+ /**
680
+ * The APM resource reference.
681
+ */
671
682
  apmRefId: string;
683
+ /**
684
+ * The APM resource unique ID.
685
+ */
672
686
  apmResourceId: string;
687
+ /**
688
+ * The deployment unique ID.
689
+ */
673
690
  deploymentId: string;
691
+ /**
692
+ * The Elasticsearch resource reference.
693
+ */
674
694
  elasticsearchRefId: string;
695
+ /**
696
+ * The Elasticsearch resource unique ID.
697
+ */
675
698
  elasticsearchResourceId: string;
699
+ /**
700
+ * The Enterprise Search resource reference.
701
+ */
676
702
  enterpriseSearchRefId: string;
703
+ /**
704
+ * The Enterprise Search resource unique ID.
705
+ */
677
706
  enterpriseSearchResourceId: string;
707
+ /**
708
+ * The Integrations Server resource reference.
709
+ */
678
710
  integrationsServerRefId: string;
711
+ /**
712
+ * The Integrations Server resource unique ID.
713
+ */
679
714
  integrationsServerResourceId: string;
715
+ /**
716
+ * The Kibana resource reference.
717
+ */
680
718
  kibanaRefId: string;
719
+ /**
720
+ * The Kibana resource unique ID.
721
+ */
681
722
  kibanaResourceId: string;
723
+ /**
724
+ * The name of the deployment.
725
+ */
682
726
  name: string;
683
727
  }
684
728
  export interface GetDeploymentsElasticsearch {
685
729
  /**
686
- * Overall health status of the deployment.
730
+ * Overall health status of the resource instances.
687
731
  */
688
732
  healthy?: string;
733
+ /**
734
+ * Resource kind status. Can be one of `initializing`, `stopping`, `stopped`, `rebooting`, `restarting`.
735
+ */
689
736
  status?: string;
737
+ /**
738
+ * Elastic stack version.
739
+ */
690
740
  version?: string;
691
741
  }
692
742
  export interface GetDeploymentsEnterpriseSearch {
693
743
  /**
694
- * Overall health status of the deployment.
744
+ * Overall health status of the resource instances.
695
745
  */
696
746
  healthy?: string;
747
+ /**
748
+ * Resource kind status. Can be one of `initializing`, `stopping`, `stopped`, `rebooting`, `restarting`.
749
+ */
697
750
  status?: string;
751
+ /**
752
+ * Elastic stack version.
753
+ */
698
754
  version?: string;
699
755
  }
700
756
  export interface GetDeploymentsIntegrationsServer {
701
757
  /**
702
- * Overall health status of the deployment.
758
+ * Overall health status of the resource instances.
703
759
  */
704
760
  healthy?: string;
761
+ /**
762
+ * Resource kind status. Can be one of `initializing`, `stopping`, `stopped`, `rebooting`, `restarting`.
763
+ */
705
764
  status?: string;
765
+ /**
766
+ * Elastic stack version.
767
+ */
706
768
  version?: string;
707
769
  }
708
770
  export interface GetDeploymentsKibana {
709
771
  /**
710
- * Overall health status of the deployment.
772
+ * Overall health status of the resource instances.
711
773
  */
712
774
  healthy?: string;
775
+ /**
776
+ * Resource kind status. Can be one of `initializing`, `stopping`, `stopped`, `rebooting`, `restarting`.
777
+ */
713
778
  status?: string;
779
+ /**
780
+ * Elastic stack version.
781
+ */
714
782
  version?: string;
715
783
  }
716
784
  export interface GetStackApm {
785
+ /**
786
+ * Maximum size of the instances.
787
+ */
717
788
  capacityConstraintsMax: number;
789
+ /**
790
+ * Minimum size of the instances.
791
+ */
718
792
  capacityConstraintsMin: number;
793
+ /**
794
+ * List of node types compatible with this one.
795
+ */
719
796
  compatibleNodeTypes: string[];
720
- defaultPlugins: string[];
797
+ /**
798
+ * List of configuration options that cannot be overridden by user settings.
799
+ */
721
800
  denylists: string[];
801
+ /**
802
+ * Docker image to use for the APM instance.
803
+ */
722
804
  dockerImage: string;
723
- plugins: string[];
724
805
  }
725
806
  export interface GetStackElasticsearch {
807
+ /**
808
+ * Maximum size of the instances.
809
+ */
726
810
  capacityConstraintsMax: number;
811
+ /**
812
+ * Minimum size of the instances.
813
+ */
727
814
  capacityConstraintsMin: number;
815
+ /**
816
+ * List of node types compatible with this one.
817
+ */
728
818
  compatibleNodeTypes: string[];
819
+ /**
820
+ * List of default plugins.
821
+ */
729
822
  defaultPlugins: string[];
823
+ /**
824
+ * List of configuration options that cannot be overridden by user settings.
825
+ */
730
826
  denylists: string[];
827
+ /**
828
+ * Docker image to use for the Elasticsearch cluster instances.
829
+ */
731
830
  dockerImage: string;
831
+ /**
832
+ * List of available plugins to be specified by users in Elasticsearch cluster instances.
833
+ */
732
834
  plugins: string[];
733
835
  }
734
836
  export interface GetStackEnterpriseSearch {
837
+ /**
838
+ * Maximum size of the instances.
839
+ */
735
840
  capacityConstraintsMax: number;
841
+ /**
842
+ * Minimum size of the instances.
843
+ */
736
844
  capacityConstraintsMin: number;
845
+ /**
846
+ * List of node types compatible with this one.
847
+ */
737
848
  compatibleNodeTypes: string[];
738
- defaultPlugins: string[];
849
+ /**
850
+ * List of configuration options that cannot be overridden by user settings.
851
+ */
739
852
  denylists: string[];
853
+ /**
854
+ * Docker image to use for the Enterprise Search instance.
855
+ */
740
856
  dockerImage: string;
741
- plugins: string[];
742
857
  }
743
858
  export interface GetStackKibana {
859
+ /**
860
+ * Maximum size of the instances.
861
+ */
744
862
  capacityConstraintsMax: number;
863
+ /**
864
+ * Minimum size of the instances.
865
+ */
745
866
  capacityConstraintsMin: number;
867
+ /**
868
+ * List of node types compatible with this one.
869
+ */
746
870
  compatibleNodeTypes: string[];
747
- defaultPlugins: string[];
871
+ /**
872
+ * List of configuration options that cannot be overridden by user settings.
873
+ */
748
874
  denylists: string[];
875
+ /**
876
+ * Docker image to use for the Kibana instance.
877
+ */
749
878
  dockerImage: string;
750
- plugins: string[];
879
+ }
880
+ export interface GetTrafficFilterRuleset {
881
+ /**
882
+ * The description of the ruleset.
883
+ */
884
+ description: string;
885
+ /**
886
+ * The ID of the ruleset
887
+ */
888
+ id: string;
889
+ /**
890
+ * Should the ruleset be automatically included in the new deployments.
891
+ */
892
+ includeByDefault: boolean;
893
+ /**
894
+ * The name of the ruleset.
895
+ */
896
+ name: string;
897
+ /**
898
+ * The ruleset can be attached only to deployments in the specific region.
899
+ */
900
+ region: string;
901
+ /**
902
+ * An individual rule
903
+ */
904
+ rules: outputs.GetTrafficFilterRulesetRule[];
905
+ }
906
+ export interface GetTrafficFilterRulesetRule {
907
+ description: string;
908
+ /**
909
+ * The id of the traffic filter to select.
910
+ */
911
+ id: string;
912
+ source: string;
913
+ }
914
+ export interface SnapshotRepositoryGeneric {
915
+ /**
916
+ * An arbitrary JSON object containing the repository settings.
917
+ */
918
+ settings: string;
919
+ /**
920
+ * Repository type
921
+ */
922
+ type: string;
923
+ }
924
+ export interface SnapshotRepositoryS3 {
925
+ /**
926
+ * An S3 access key. If set, the secretKey setting must also be specified. If unset, the client will use the instance or container role instead.
927
+ */
928
+ accessKey?: string;
929
+ /**
930
+ * Name of the S3 bucket to use for snapshots.
931
+ */
932
+ bucket: string;
933
+ /**
934
+ * The S3 service endpoint to connect to. This defaults to s3.amazonaws.com but the AWS documentation lists alternative S3 endpoints. If you are using an S3-compatible service then you should set this to the service’s endpoint.
935
+ */
936
+ endpoint?: string;
937
+ /**
938
+ * Whether to force the use of the path style access pattern. If true, the path style access pattern will be used. If false, the access pattern will be automatically determined by the AWS Java SDK (See AWS documentation for details). Defaults to false.
939
+ */
940
+ pathStyleAccess: boolean;
941
+ /**
942
+ * Allows specifying the signing region to use. Specifying this setting manually should not be necessary for most use cases. Generally, the SDK will correctly guess the signing region to use. It should be considered an expert level setting to support S3-compatible APIs that require v4 signatures and use a region other than the default us-east-1. Defaults to empty string which means that the SDK will try to automatically determine the correct signing region.
943
+ */
944
+ region?: string;
945
+ /**
946
+ * An S3 secret key. If set, the accessKey setting must also be specified.
947
+ */
948
+ secretKey?: string;
949
+ /**
950
+ * When set to true files are encrypted on server side using AES256 algorithm. Defaults to false.
951
+ */
952
+ serverSideEncryption: boolean;
751
953
  }