@robhan-cdk-lib/aws_aps 0.0.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.
package/API.md ADDED
@@ -0,0 +1,3389 @@
1
+ # API Reference <a name="API Reference" id="api-reference"></a>
2
+
3
+ ## Constructs <a name="Constructs" id="Constructs"></a>
4
+
5
+ ### RuleGroupsNamespace <a name="RuleGroupsNamespace" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace"></a>
6
+
7
+ The definition of a rule groups namespace in an Amazon Managed Service for Prometheus workspace.
8
+
9
+ A rule groups namespace is associated with exactly one rules file. A workspace can have multiple
10
+ rule groups namespaces.
11
+
12
+ #### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.Initializer"></a>
13
+
14
+ ```typescript
15
+ import { RuleGroupsNamespace } from '@robhan-cdk-lib/aws_aps'
16
+
17
+ new RuleGroupsNamespace(scope: Construct, id: string, props: RuleGroupsNamespaceProps)
18
+ ```
19
+
20
+ | **Name** | **Type** | **Description** |
21
+ | --- | --- | --- |
22
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
23
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
24
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.Initializer.parameter.props">props</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceProps">RuleGroupsNamespaceProps</a></code> | *No description.* |
25
+
26
+ ---
27
+
28
+ ##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.Initializer.parameter.scope"></a>
29
+
30
+ - *Type:* constructs.Construct
31
+
32
+ ---
33
+
34
+ ##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.Initializer.parameter.id"></a>
35
+
36
+ - *Type:* string
37
+
38
+ ---
39
+
40
+ ##### `props`<sup>Required</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.Initializer.parameter.props"></a>
41
+
42
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceProps">RuleGroupsNamespaceProps</a>
43
+
44
+ ---
45
+
46
+ #### Methods <a name="Methods" id="Methods"></a>
47
+
48
+ | **Name** | **Description** |
49
+ | --- | --- |
50
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.toString">toString</a></code> | Returns a string representation of this construct. |
51
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
52
+
53
+ ---
54
+
55
+ ##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.toString"></a>
56
+
57
+ ```typescript
58
+ public toString(): string
59
+ ```
60
+
61
+ Returns a string representation of this construct.
62
+
63
+ ##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.applyRemovalPolicy"></a>
64
+
65
+ ```typescript
66
+ public applyRemovalPolicy(policy: RemovalPolicy): void
67
+ ```
68
+
69
+ Apply the given removal policy to this resource.
70
+
71
+ The Removal Policy controls what happens to this resource when it stops
72
+ being managed by CloudFormation, either because you've removed it from the
73
+ CDK application or because you've made a change that requires the resource
74
+ to be replaced.
75
+
76
+ The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
77
+ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
78
+
79
+ ###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.applyRemovalPolicy.parameter.policy"></a>
80
+
81
+ - *Type:* aws-cdk-lib.RemovalPolicy
82
+
83
+ ---
84
+
85
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
86
+
87
+ | **Name** | **Description** |
88
+ | --- | --- |
89
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
90
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
91
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
92
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes">fromRuleGroupsNamespaceAttributes</a></code> | *No description.* |
93
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isRuleGroupsNamespace">isRuleGroupsNamespace</a></code> | *No description.* |
94
+
95
+ ---
96
+
97
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isConstruct"></a>
98
+
99
+ ```typescript
100
+ import { RuleGroupsNamespace } from '@robhan-cdk-lib/aws_aps'
101
+
102
+ RuleGroupsNamespace.isConstruct(x: any)
103
+ ```
104
+
105
+ Checks if `x` is a construct.
106
+
107
+ ###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isConstruct.parameter.x"></a>
108
+
109
+ - *Type:* any
110
+
111
+ Any object.
112
+
113
+ ---
114
+
115
+ ##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isOwnedResource"></a>
116
+
117
+ ```typescript
118
+ import { RuleGroupsNamespace } from '@robhan-cdk-lib/aws_aps'
119
+
120
+ RuleGroupsNamespace.isOwnedResource(construct: IConstruct)
121
+ ```
122
+
123
+ Returns true if the construct was created by CDK, and false otherwise.
124
+
125
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isOwnedResource.parameter.construct"></a>
126
+
127
+ - *Type:* constructs.IConstruct
128
+
129
+ ---
130
+
131
+ ##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isResource"></a>
132
+
133
+ ```typescript
134
+ import { RuleGroupsNamespace } from '@robhan-cdk-lib/aws_aps'
135
+
136
+ RuleGroupsNamespace.isResource(construct: IConstruct)
137
+ ```
138
+
139
+ Check whether the given construct is a Resource.
140
+
141
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isResource.parameter.construct"></a>
142
+
143
+ - *Type:* constructs.IConstruct
144
+
145
+ ---
146
+
147
+ ##### `fromRuleGroupsNamespaceAttributes` <a name="fromRuleGroupsNamespaceAttributes" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes"></a>
148
+
149
+ ```typescript
150
+ import { RuleGroupsNamespace } from '@robhan-cdk-lib/aws_aps'
151
+
152
+ RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes(scope: Construct, id: string, attrs: RuleGroupsNamespaceAttributes)
153
+ ```
154
+
155
+ ###### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes.parameter.scope"></a>
156
+
157
+ - *Type:* constructs.Construct
158
+
159
+ ---
160
+
161
+ ###### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes.parameter.id"></a>
162
+
163
+ - *Type:* string
164
+
165
+ ---
166
+
167
+ ###### `attrs`<sup>Required</sup> <a name="attrs" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes.parameter.attrs"></a>
168
+
169
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceAttributes">RuleGroupsNamespaceAttributes</a>
170
+
171
+ ---
172
+
173
+ ##### `isRuleGroupsNamespace` <a name="isRuleGroupsNamespace" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isRuleGroupsNamespace"></a>
174
+
175
+ ```typescript
176
+ import { RuleGroupsNamespace } from '@robhan-cdk-lib/aws_aps'
177
+
178
+ RuleGroupsNamespace.isRuleGroupsNamespace(x: any)
179
+ ```
180
+
181
+ ###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isRuleGroupsNamespace.parameter.x"></a>
182
+
183
+ - *Type:* any
184
+
185
+ ---
186
+
187
+ #### Properties <a name="Properties" id="Properties"></a>
188
+
189
+ | **Name** | **Type** | **Description** |
190
+ | --- | --- | --- |
191
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
192
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
193
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
194
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.data">data</a></code> | <code>string</code> | The rules file used in the namespace. |
195
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.name">name</a></code> | <code>string</code> | The name of the rule groups namespace. |
196
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.ruleGroupsNamespaceArn">ruleGroupsNamespaceArn</a></code> | <code>string</code> | The workspace to add the rule groups namespace. |
197
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | The workspace to add the rule groups namespace. |
198
+
199
+ ---
200
+
201
+ ##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.node"></a>
202
+
203
+ ```typescript
204
+ public readonly node: Node;
205
+ ```
206
+
207
+ - *Type:* constructs.Node
208
+
209
+ The tree node.
210
+
211
+ ---
212
+
213
+ ##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.env"></a>
214
+
215
+ ```typescript
216
+ public readonly env: ResourceEnvironment;
217
+ ```
218
+
219
+ - *Type:* aws-cdk-lib.ResourceEnvironment
220
+
221
+ The environment this resource belongs to.
222
+
223
+ For resources that are created and managed by the CDK
224
+ (generally, those created by creating new class instances like Role, Bucket, etc.),
225
+ this is always the same as the environment of the stack they belong to;
226
+ however, for imported resources
227
+ (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
228
+ that might be different than the stack they were imported into.
229
+
230
+ ---
231
+
232
+ ##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.stack"></a>
233
+
234
+ ```typescript
235
+ public readonly stack: Stack;
236
+ ```
237
+
238
+ - *Type:* aws-cdk-lib.Stack
239
+
240
+ The stack in which this resource is defined.
241
+
242
+ ---
243
+
244
+ ##### `data`<sup>Required</sup> <a name="data" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.data"></a>
245
+
246
+ ```typescript
247
+ public readonly data: string;
248
+ ```
249
+
250
+ - *Type:* string
251
+
252
+ The rules file used in the namespace.
253
+
254
+ ---
255
+
256
+ ##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.name"></a>
257
+
258
+ ```typescript
259
+ public readonly name: string;
260
+ ```
261
+
262
+ - *Type:* string
263
+
264
+ The name of the rule groups namespace.
265
+
266
+ ---
267
+
268
+ ##### `ruleGroupsNamespaceArn`<sup>Required</sup> <a name="ruleGroupsNamespaceArn" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.ruleGroupsNamespaceArn"></a>
269
+
270
+ ```typescript
271
+ public readonly ruleGroupsNamespaceArn: string;
272
+ ```
273
+
274
+ - *Type:* string
275
+
276
+ The workspace to add the rule groups namespace.
277
+
278
+ ---
279
+
280
+ ##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.workspace"></a>
281
+
282
+ ```typescript
283
+ public readonly workspace: IWorkspace;
284
+ ```
285
+
286
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
287
+
288
+ The workspace to add the rule groups namespace.
289
+
290
+ ---
291
+
292
+
293
+ ### RuleGroupsNamespaceBase <a name="RuleGroupsNamespaceBase" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase"></a>
294
+
295
+ - *Implements:* <a href="#@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace">IRuleGroupsNamespace</a>
296
+
297
+ #### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer"></a>
298
+
299
+ ```typescript
300
+ import { RuleGroupsNamespaceBase } from '@robhan-cdk-lib/aws_aps'
301
+
302
+ new RuleGroupsNamespaceBase(scope: Construct, id: string, props?: ResourceProps)
303
+ ```
304
+
305
+ | **Name** | **Type** | **Description** |
306
+ | --- | --- | --- |
307
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
308
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
309
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer.parameter.props">props</a></code> | <code>aws-cdk-lib.ResourceProps</code> | *No description.* |
310
+
311
+ ---
312
+
313
+ ##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer.parameter.scope"></a>
314
+
315
+ - *Type:* constructs.Construct
316
+
317
+ ---
318
+
319
+ ##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer.parameter.id"></a>
320
+
321
+ - *Type:* string
322
+
323
+ ---
324
+
325
+ ##### `props`<sup>Optional</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer.parameter.props"></a>
326
+
327
+ - *Type:* aws-cdk-lib.ResourceProps
328
+
329
+ ---
330
+
331
+ #### Methods <a name="Methods" id="Methods"></a>
332
+
333
+ | **Name** | **Description** |
334
+ | --- | --- |
335
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.toString">toString</a></code> | Returns a string representation of this construct. |
336
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
337
+
338
+ ---
339
+
340
+ ##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.toString"></a>
341
+
342
+ ```typescript
343
+ public toString(): string
344
+ ```
345
+
346
+ Returns a string representation of this construct.
347
+
348
+ ##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.applyRemovalPolicy"></a>
349
+
350
+ ```typescript
351
+ public applyRemovalPolicy(policy: RemovalPolicy): void
352
+ ```
353
+
354
+ Apply the given removal policy to this resource.
355
+
356
+ The Removal Policy controls what happens to this resource when it stops
357
+ being managed by CloudFormation, either because you've removed it from the
358
+ CDK application or because you've made a change that requires the resource
359
+ to be replaced.
360
+
361
+ The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
362
+ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
363
+
364
+ ###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.applyRemovalPolicy.parameter.policy"></a>
365
+
366
+ - *Type:* aws-cdk-lib.RemovalPolicy
367
+
368
+ ---
369
+
370
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
371
+
372
+ | **Name** | **Description** |
373
+ | --- | --- |
374
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
375
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
376
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
377
+
378
+ ---
379
+
380
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isConstruct"></a>
381
+
382
+ ```typescript
383
+ import { RuleGroupsNamespaceBase } from '@robhan-cdk-lib/aws_aps'
384
+
385
+ RuleGroupsNamespaceBase.isConstruct(x: any)
386
+ ```
387
+
388
+ Checks if `x` is a construct.
389
+
390
+ ###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isConstruct.parameter.x"></a>
391
+
392
+ - *Type:* any
393
+
394
+ Any object.
395
+
396
+ ---
397
+
398
+ ##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isOwnedResource"></a>
399
+
400
+ ```typescript
401
+ import { RuleGroupsNamespaceBase } from '@robhan-cdk-lib/aws_aps'
402
+
403
+ RuleGroupsNamespaceBase.isOwnedResource(construct: IConstruct)
404
+ ```
405
+
406
+ Returns true if the construct was created by CDK, and false otherwise.
407
+
408
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isOwnedResource.parameter.construct"></a>
409
+
410
+ - *Type:* constructs.IConstruct
411
+
412
+ ---
413
+
414
+ ##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isResource"></a>
415
+
416
+ ```typescript
417
+ import { RuleGroupsNamespaceBase } from '@robhan-cdk-lib/aws_aps'
418
+
419
+ RuleGroupsNamespaceBase.isResource(construct: IConstruct)
420
+ ```
421
+
422
+ Check whether the given construct is a Resource.
423
+
424
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isResource.parameter.construct"></a>
425
+
426
+ - *Type:* constructs.IConstruct
427
+
428
+ ---
429
+
430
+ #### Properties <a name="Properties" id="Properties"></a>
431
+
432
+ | **Name** | **Type** | **Description** |
433
+ | --- | --- | --- |
434
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
435
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
436
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
437
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.data">data</a></code> | <code>string</code> | The rules file used in the namespace. |
438
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.name">name</a></code> | <code>string</code> | The name of the rule groups namespace. |
439
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.ruleGroupsNamespaceArn">ruleGroupsNamespaceArn</a></code> | <code>string</code> | The ARN of the rule groups namespace. |
440
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | The workspace to add the rule groups namespace. |
441
+
442
+ ---
443
+
444
+ ##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.node"></a>
445
+
446
+ ```typescript
447
+ public readonly node: Node;
448
+ ```
449
+
450
+ - *Type:* constructs.Node
451
+
452
+ The tree node.
453
+
454
+ ---
455
+
456
+ ##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.env"></a>
457
+
458
+ ```typescript
459
+ public readonly env: ResourceEnvironment;
460
+ ```
461
+
462
+ - *Type:* aws-cdk-lib.ResourceEnvironment
463
+
464
+ The environment this resource belongs to.
465
+
466
+ For resources that are created and managed by the CDK
467
+ (generally, those created by creating new class instances like Role, Bucket, etc.),
468
+ this is always the same as the environment of the stack they belong to;
469
+ however, for imported resources
470
+ (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
471
+ that might be different than the stack they were imported into.
472
+
473
+ ---
474
+
475
+ ##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.stack"></a>
476
+
477
+ ```typescript
478
+ public readonly stack: Stack;
479
+ ```
480
+
481
+ - *Type:* aws-cdk-lib.Stack
482
+
483
+ The stack in which this resource is defined.
484
+
485
+ ---
486
+
487
+ ##### `data`<sup>Required</sup> <a name="data" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.data"></a>
488
+
489
+ ```typescript
490
+ public readonly data: string;
491
+ ```
492
+
493
+ - *Type:* string
494
+
495
+ The rules file used in the namespace.
496
+
497
+ ---
498
+
499
+ ##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.name"></a>
500
+
501
+ ```typescript
502
+ public readonly name: string;
503
+ ```
504
+
505
+ - *Type:* string
506
+
507
+ The name of the rule groups namespace.
508
+
509
+ ---
510
+
511
+ ##### `ruleGroupsNamespaceArn`<sup>Required</sup> <a name="ruleGroupsNamespaceArn" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.ruleGroupsNamespaceArn"></a>
512
+
513
+ ```typescript
514
+ public readonly ruleGroupsNamespaceArn: string;
515
+ ```
516
+
517
+ - *Type:* string
518
+
519
+ The ARN of the rule groups namespace.
520
+
521
+ ---
522
+
523
+ ##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.workspace"></a>
524
+
525
+ ```typescript
526
+ public readonly workspace: IWorkspace;
527
+ ```
528
+
529
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
530
+
531
+ The workspace to add the rule groups namespace.
532
+
533
+ ---
534
+
535
+
536
+ ### Scraper <a name="Scraper" id="@robhan-cdk-lib/aws_aps.Scraper"></a>
537
+
538
+ #### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.Scraper.Initializer"></a>
539
+
540
+ ```typescript
541
+ import { Scraper } from '@robhan-cdk-lib/aws_aps'
542
+
543
+ new Scraper(scope: Construct, id: string, props: ScraperProps)
544
+ ```
545
+
546
+ | **Name** | **Type** | **Description** |
547
+ | --- | --- | --- |
548
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
549
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
550
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.Initializer.parameter.props">props</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperProps">ScraperProps</a></code> | *No description.* |
551
+
552
+ ---
553
+
554
+ ##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.Scraper.Initializer.parameter.scope"></a>
555
+
556
+ - *Type:* constructs.Construct
557
+
558
+ ---
559
+
560
+ ##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.Scraper.Initializer.parameter.id"></a>
561
+
562
+ - *Type:* string
563
+
564
+ ---
565
+
566
+ ##### `props`<sup>Required</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.Scraper.Initializer.parameter.props"></a>
567
+
568
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.ScraperProps">ScraperProps</a>
569
+
570
+ ---
571
+
572
+ #### Methods <a name="Methods" id="Methods"></a>
573
+
574
+ | **Name** | **Description** |
575
+ | --- | --- |
576
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.toString">toString</a></code> | Returns a string representation of this construct. |
577
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
578
+
579
+ ---
580
+
581
+ ##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.Scraper.toString"></a>
582
+
583
+ ```typescript
584
+ public toString(): string
585
+ ```
586
+
587
+ Returns a string representation of this construct.
588
+
589
+ ##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.Scraper.applyRemovalPolicy"></a>
590
+
591
+ ```typescript
592
+ public applyRemovalPolicy(policy: RemovalPolicy): void
593
+ ```
594
+
595
+ Apply the given removal policy to this resource.
596
+
597
+ The Removal Policy controls what happens to this resource when it stops
598
+ being managed by CloudFormation, either because you've removed it from the
599
+ CDK application or because you've made a change that requires the resource
600
+ to be replaced.
601
+
602
+ The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
603
+ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
604
+
605
+ ###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.Scraper.applyRemovalPolicy.parameter.policy"></a>
606
+
607
+ - *Type:* aws-cdk-lib.RemovalPolicy
608
+
609
+ ---
610
+
611
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
612
+
613
+ | **Name** | **Description** |
614
+ | --- | --- |
615
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
616
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
617
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
618
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.frommScraperAttributes">frommScraperAttributes</a></code> | *No description.* |
619
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.isScraper">isScraper</a></code> | *No description.* |
620
+
621
+ ---
622
+
623
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.Scraper.isConstruct"></a>
624
+
625
+ ```typescript
626
+ import { Scraper } from '@robhan-cdk-lib/aws_aps'
627
+
628
+ Scraper.isConstruct(x: any)
629
+ ```
630
+
631
+ Checks if `x` is a construct.
632
+
633
+ ###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.Scraper.isConstruct.parameter.x"></a>
634
+
635
+ - *Type:* any
636
+
637
+ Any object.
638
+
639
+ ---
640
+
641
+ ##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.Scraper.isOwnedResource"></a>
642
+
643
+ ```typescript
644
+ import { Scraper } from '@robhan-cdk-lib/aws_aps'
645
+
646
+ Scraper.isOwnedResource(construct: IConstruct)
647
+ ```
648
+
649
+ Returns true if the construct was created by CDK, and false otherwise.
650
+
651
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.Scraper.isOwnedResource.parameter.construct"></a>
652
+
653
+ - *Type:* constructs.IConstruct
654
+
655
+ ---
656
+
657
+ ##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.Scraper.isResource"></a>
658
+
659
+ ```typescript
660
+ import { Scraper } from '@robhan-cdk-lib/aws_aps'
661
+
662
+ Scraper.isResource(construct: IConstruct)
663
+ ```
664
+
665
+ Check whether the given construct is a Resource.
666
+
667
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.Scraper.isResource.parameter.construct"></a>
668
+
669
+ - *Type:* constructs.IConstruct
670
+
671
+ ---
672
+
673
+ ##### `frommScraperAttributes` <a name="frommScraperAttributes" id="@robhan-cdk-lib/aws_aps.Scraper.frommScraperAttributes"></a>
674
+
675
+ ```typescript
676
+ import { Scraper } from '@robhan-cdk-lib/aws_aps'
677
+
678
+ Scraper.frommScraperAttributes(scope: Construct, id: string, attrs: ScraperAttributes)
679
+ ```
680
+
681
+ ###### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.Scraper.frommScraperAttributes.parameter.scope"></a>
682
+
683
+ - *Type:* constructs.Construct
684
+
685
+ ---
686
+
687
+ ###### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.Scraper.frommScraperAttributes.parameter.id"></a>
688
+
689
+ - *Type:* string
690
+
691
+ ---
692
+
693
+ ###### `attrs`<sup>Required</sup> <a name="attrs" id="@robhan-cdk-lib/aws_aps.Scraper.frommScraperAttributes.parameter.attrs"></a>
694
+
695
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.ScraperAttributes">ScraperAttributes</a>
696
+
697
+ ---
698
+
699
+ ##### `isScraper` <a name="isScraper" id="@robhan-cdk-lib/aws_aps.Scraper.isScraper"></a>
700
+
701
+ ```typescript
702
+ import { Scraper } from '@robhan-cdk-lib/aws_aps'
703
+
704
+ Scraper.isScraper(x: any)
705
+ ```
706
+
707
+ ###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.Scraper.isScraper.parameter.x"></a>
708
+
709
+ - *Type:* any
710
+
711
+ ---
712
+
713
+ #### Properties <a name="Properties" id="Properties"></a>
714
+
715
+ | **Name** | **Type** | **Description** |
716
+ | --- | --- | --- |
717
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
718
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
719
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
720
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.property.destination">destination</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Destination">Destination</a></code> | The Amazon Managed Service for Prometheus workspace the scraper sends metrics to. |
721
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.property.scrapeConfiguration">scrapeConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.ScrapeConfiguration">ScrapeConfiguration</a></code> | The configuration in use by the scraper. |
722
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.property.scraperArn">scraperArn</a></code> | <code>string</code> | The ARN of the scraper. |
723
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.property.scraperId">scraperId</a></code> | <code>string</code> | The ID of the scraper. |
724
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.property.source">source</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Source">Source</a></code> | The Amazon EKS cluster from which the scraper collects metrics. |
725
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.property.alias">alias</a></code> | <code>string</code> | An optional user-assigned scraper alias. |
726
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.property.roleConfiguration">roleConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.RoleConfiguration">RoleConfiguration</a></code> | The role configuration in an Amazon Managed Service for Prometheus scraper. |
727
+
728
+ ---
729
+
730
+ ##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.Scraper.property.node"></a>
731
+
732
+ ```typescript
733
+ public readonly node: Node;
734
+ ```
735
+
736
+ - *Type:* constructs.Node
737
+
738
+ The tree node.
739
+
740
+ ---
741
+
742
+ ##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.Scraper.property.env"></a>
743
+
744
+ ```typescript
745
+ public readonly env: ResourceEnvironment;
746
+ ```
747
+
748
+ - *Type:* aws-cdk-lib.ResourceEnvironment
749
+
750
+ The environment this resource belongs to.
751
+
752
+ For resources that are created and managed by the CDK
753
+ (generally, those created by creating new class instances like Role, Bucket, etc.),
754
+ this is always the same as the environment of the stack they belong to;
755
+ however, for imported resources
756
+ (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
757
+ that might be different than the stack they were imported into.
758
+
759
+ ---
760
+
761
+ ##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.Scraper.property.stack"></a>
762
+
763
+ ```typescript
764
+ public readonly stack: Stack;
765
+ ```
766
+
767
+ - *Type:* aws-cdk-lib.Stack
768
+
769
+ The stack in which this resource is defined.
770
+
771
+ ---
772
+
773
+ ##### `destination`<sup>Required</sup> <a name="destination" id="@robhan-cdk-lib/aws_aps.Scraper.property.destination"></a>
774
+
775
+ ```typescript
776
+ public readonly destination: Destination;
777
+ ```
778
+
779
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.Destination">Destination</a>
780
+
781
+ The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
782
+
783
+ ---
784
+
785
+ ##### `scrapeConfiguration`<sup>Required</sup> <a name="scrapeConfiguration" id="@robhan-cdk-lib/aws_aps.Scraper.property.scrapeConfiguration"></a>
786
+
787
+ ```typescript
788
+ public readonly scrapeConfiguration: ScrapeConfiguration;
789
+ ```
790
+
791
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.ScrapeConfiguration">ScrapeConfiguration</a>
792
+
793
+ The configuration in use by the scraper.
794
+
795
+ ---
796
+
797
+ ##### `scraperArn`<sup>Required</sup> <a name="scraperArn" id="@robhan-cdk-lib/aws_aps.Scraper.property.scraperArn"></a>
798
+
799
+ ```typescript
800
+ public readonly scraperArn: string;
801
+ ```
802
+
803
+ - *Type:* string
804
+
805
+ The ARN of the scraper.
806
+
807
+ ---
808
+
809
+ ##### `scraperId`<sup>Required</sup> <a name="scraperId" id="@robhan-cdk-lib/aws_aps.Scraper.property.scraperId"></a>
810
+
811
+ ```typescript
812
+ public readonly scraperId: string;
813
+ ```
814
+
815
+ - *Type:* string
816
+
817
+ The ID of the scraper.
818
+
819
+ ---
820
+
821
+ ##### `source`<sup>Required</sup> <a name="source" id="@robhan-cdk-lib/aws_aps.Scraper.property.source"></a>
822
+
823
+ ```typescript
824
+ public readonly source: Source;
825
+ ```
826
+
827
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.Source">Source</a>
828
+
829
+ The Amazon EKS cluster from which the scraper collects metrics.
830
+
831
+ ---
832
+
833
+ ##### `alias`<sup>Optional</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.Scraper.property.alias"></a>
834
+
835
+ ```typescript
836
+ public readonly alias: string;
837
+ ```
838
+
839
+ - *Type:* string
840
+
841
+ An optional user-assigned scraper alias.
842
+
843
+ ---
844
+
845
+ ##### `roleConfiguration`<sup>Optional</sup> <a name="roleConfiguration" id="@robhan-cdk-lib/aws_aps.Scraper.property.roleConfiguration"></a>
846
+
847
+ ```typescript
848
+ public readonly roleConfiguration: RoleConfiguration;
849
+ ```
850
+
851
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.RoleConfiguration">RoleConfiguration</a>
852
+
853
+ The role configuration in an Amazon Managed Service for Prometheus scraper.
854
+
855
+ ---
856
+
857
+
858
+ ### ScraperBase <a name="ScraperBase" id="@robhan-cdk-lib/aws_aps.ScraperBase"></a>
859
+
860
+ - *Implements:* <a href="#@robhan-cdk-lib/aws_aps.IScraper">IScraper</a>
861
+
862
+ #### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.ScraperBase.Initializer"></a>
863
+
864
+ ```typescript
865
+ import { ScraperBase } from '@robhan-cdk-lib/aws_aps'
866
+
867
+ new ScraperBase(scope: Construct, id: string, props?: ResourceProps)
868
+ ```
869
+
870
+ | **Name** | **Type** | **Description** |
871
+ | --- | --- | --- |
872
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
873
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
874
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.Initializer.parameter.props">props</a></code> | <code>aws-cdk-lib.ResourceProps</code> | *No description.* |
875
+
876
+ ---
877
+
878
+ ##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.ScraperBase.Initializer.parameter.scope"></a>
879
+
880
+ - *Type:* constructs.Construct
881
+
882
+ ---
883
+
884
+ ##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.ScraperBase.Initializer.parameter.id"></a>
885
+
886
+ - *Type:* string
887
+
888
+ ---
889
+
890
+ ##### `props`<sup>Optional</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.ScraperBase.Initializer.parameter.props"></a>
891
+
892
+ - *Type:* aws-cdk-lib.ResourceProps
893
+
894
+ ---
895
+
896
+ #### Methods <a name="Methods" id="Methods"></a>
897
+
898
+ | **Name** | **Description** |
899
+ | --- | --- |
900
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.toString">toString</a></code> | Returns a string representation of this construct. |
901
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
902
+
903
+ ---
904
+
905
+ ##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.ScraperBase.toString"></a>
906
+
907
+ ```typescript
908
+ public toString(): string
909
+ ```
910
+
911
+ Returns a string representation of this construct.
912
+
913
+ ##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.ScraperBase.applyRemovalPolicy"></a>
914
+
915
+ ```typescript
916
+ public applyRemovalPolicy(policy: RemovalPolicy): void
917
+ ```
918
+
919
+ Apply the given removal policy to this resource.
920
+
921
+ The Removal Policy controls what happens to this resource when it stops
922
+ being managed by CloudFormation, either because you've removed it from the
923
+ CDK application or because you've made a change that requires the resource
924
+ to be replaced.
925
+
926
+ The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
927
+ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
928
+
929
+ ###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.ScraperBase.applyRemovalPolicy.parameter.policy"></a>
930
+
931
+ - *Type:* aws-cdk-lib.RemovalPolicy
932
+
933
+ ---
934
+
935
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
936
+
937
+ | **Name** | **Description** |
938
+ | --- | --- |
939
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
940
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
941
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
942
+
943
+ ---
944
+
945
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.ScraperBase.isConstruct"></a>
946
+
947
+ ```typescript
948
+ import { ScraperBase } from '@robhan-cdk-lib/aws_aps'
949
+
950
+ ScraperBase.isConstruct(x: any)
951
+ ```
952
+
953
+ Checks if `x` is a construct.
954
+
955
+ ###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.ScraperBase.isConstruct.parameter.x"></a>
956
+
957
+ - *Type:* any
958
+
959
+ Any object.
960
+
961
+ ---
962
+
963
+ ##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.ScraperBase.isOwnedResource"></a>
964
+
965
+ ```typescript
966
+ import { ScraperBase } from '@robhan-cdk-lib/aws_aps'
967
+
968
+ ScraperBase.isOwnedResource(construct: IConstruct)
969
+ ```
970
+
971
+ Returns true if the construct was created by CDK, and false otherwise.
972
+
973
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.ScraperBase.isOwnedResource.parameter.construct"></a>
974
+
975
+ - *Type:* constructs.IConstruct
976
+
977
+ ---
978
+
979
+ ##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.ScraperBase.isResource"></a>
980
+
981
+ ```typescript
982
+ import { ScraperBase } from '@robhan-cdk-lib/aws_aps'
983
+
984
+ ScraperBase.isResource(construct: IConstruct)
985
+ ```
986
+
987
+ Check whether the given construct is a Resource.
988
+
989
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.ScraperBase.isResource.parameter.construct"></a>
990
+
991
+ - *Type:* constructs.IConstruct
992
+
993
+ ---
994
+
995
+ #### Properties <a name="Properties" id="Properties"></a>
996
+
997
+ | **Name** | **Type** | **Description** |
998
+ | --- | --- | --- |
999
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
1000
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
1001
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
1002
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.property.destination">destination</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Destination">Destination</a></code> | The Amazon Managed Service for Prometheus workspace the scraper sends metrics to. |
1003
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.property.scrapeConfiguration">scrapeConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.ScrapeConfiguration">ScrapeConfiguration</a></code> | The configuration in use by the scraper. |
1004
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.property.scraperArn">scraperArn</a></code> | <code>string</code> | The ARN of the scraper. |
1005
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.property.scraperId">scraperId</a></code> | <code>string</code> | The ID of the scraper. |
1006
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.property.source">source</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Source">Source</a></code> | The Amazon EKS cluster from which the scraper collects metrics. |
1007
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.property.alias">alias</a></code> | <code>string</code> | An optional user-assigned scraper alias. |
1008
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperBase.property.roleConfiguration">roleConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.RoleConfiguration">RoleConfiguration</a></code> | The role configuration in an Amazon Managed Service for Prometheus scraper. |
1009
+
1010
+ ---
1011
+
1012
+ ##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.ScraperBase.property.node"></a>
1013
+
1014
+ ```typescript
1015
+ public readonly node: Node;
1016
+ ```
1017
+
1018
+ - *Type:* constructs.Node
1019
+
1020
+ The tree node.
1021
+
1022
+ ---
1023
+
1024
+ ##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.ScraperBase.property.env"></a>
1025
+
1026
+ ```typescript
1027
+ public readonly env: ResourceEnvironment;
1028
+ ```
1029
+
1030
+ - *Type:* aws-cdk-lib.ResourceEnvironment
1031
+
1032
+ The environment this resource belongs to.
1033
+
1034
+ For resources that are created and managed by the CDK
1035
+ (generally, those created by creating new class instances like Role, Bucket, etc.),
1036
+ this is always the same as the environment of the stack they belong to;
1037
+ however, for imported resources
1038
+ (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
1039
+ that might be different than the stack they were imported into.
1040
+
1041
+ ---
1042
+
1043
+ ##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.ScraperBase.property.stack"></a>
1044
+
1045
+ ```typescript
1046
+ public readonly stack: Stack;
1047
+ ```
1048
+
1049
+ - *Type:* aws-cdk-lib.Stack
1050
+
1051
+ The stack in which this resource is defined.
1052
+
1053
+ ---
1054
+
1055
+ ##### `destination`<sup>Required</sup> <a name="destination" id="@robhan-cdk-lib/aws_aps.ScraperBase.property.destination"></a>
1056
+
1057
+ ```typescript
1058
+ public readonly destination: Destination;
1059
+ ```
1060
+
1061
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.Destination">Destination</a>
1062
+
1063
+ The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
1064
+
1065
+ ---
1066
+
1067
+ ##### `scrapeConfiguration`<sup>Required</sup> <a name="scrapeConfiguration" id="@robhan-cdk-lib/aws_aps.ScraperBase.property.scrapeConfiguration"></a>
1068
+
1069
+ ```typescript
1070
+ public readonly scrapeConfiguration: ScrapeConfiguration;
1071
+ ```
1072
+
1073
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.ScrapeConfiguration">ScrapeConfiguration</a>
1074
+
1075
+ The configuration in use by the scraper.
1076
+
1077
+ ---
1078
+
1079
+ ##### `scraperArn`<sup>Required</sup> <a name="scraperArn" id="@robhan-cdk-lib/aws_aps.ScraperBase.property.scraperArn"></a>
1080
+
1081
+ ```typescript
1082
+ public readonly scraperArn: string;
1083
+ ```
1084
+
1085
+ - *Type:* string
1086
+
1087
+ The ARN of the scraper.
1088
+
1089
+ ---
1090
+
1091
+ ##### `scraperId`<sup>Required</sup> <a name="scraperId" id="@robhan-cdk-lib/aws_aps.ScraperBase.property.scraperId"></a>
1092
+
1093
+ ```typescript
1094
+ public readonly scraperId: string;
1095
+ ```
1096
+
1097
+ - *Type:* string
1098
+
1099
+ The ID of the scraper.
1100
+
1101
+ ---
1102
+
1103
+ ##### `source`<sup>Required</sup> <a name="source" id="@robhan-cdk-lib/aws_aps.ScraperBase.property.source"></a>
1104
+
1105
+ ```typescript
1106
+ public readonly source: Source;
1107
+ ```
1108
+
1109
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.Source">Source</a>
1110
+
1111
+ The Amazon EKS cluster from which the scraper collects metrics.
1112
+
1113
+ ---
1114
+
1115
+ ##### `alias`<sup>Optional</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.ScraperBase.property.alias"></a>
1116
+
1117
+ ```typescript
1118
+ public readonly alias: string;
1119
+ ```
1120
+
1121
+ - *Type:* string
1122
+
1123
+ An optional user-assigned scraper alias.
1124
+
1125
+ 1-100 characters.
1126
+
1127
+ Pattern: ^[0-9A-Za-z][-.0-9A-Z_a-z]*$
1128
+
1129
+ ---
1130
+
1131
+ ##### `roleConfiguration`<sup>Optional</sup> <a name="roleConfiguration" id="@robhan-cdk-lib/aws_aps.ScraperBase.property.roleConfiguration"></a>
1132
+
1133
+ ```typescript
1134
+ public readonly roleConfiguration: RoleConfiguration;
1135
+ ```
1136
+
1137
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.RoleConfiguration">RoleConfiguration</a>
1138
+
1139
+ The role configuration in an Amazon Managed Service for Prometheus scraper.
1140
+
1141
+ ---
1142
+
1143
+
1144
+ ### Workspace <a name="Workspace" id="@robhan-cdk-lib/aws_aps.Workspace"></a>
1145
+
1146
+ #### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.Workspace.Initializer"></a>
1147
+
1148
+ ```typescript
1149
+ import { Workspace } from '@robhan-cdk-lib/aws_aps'
1150
+
1151
+ new Workspace(scope: Construct, id: string, props: WorkspaceProps)
1152
+ ```
1153
+
1154
+ | **Name** | **Type** | **Description** |
1155
+ | --- | --- | --- |
1156
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
1157
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
1158
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.Initializer.parameter.props">props</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceProps">WorkspaceProps</a></code> | *No description.* |
1159
+
1160
+ ---
1161
+
1162
+ ##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.Workspace.Initializer.parameter.scope"></a>
1163
+
1164
+ - *Type:* constructs.Construct
1165
+
1166
+ ---
1167
+
1168
+ ##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.Workspace.Initializer.parameter.id"></a>
1169
+
1170
+ - *Type:* string
1171
+
1172
+ ---
1173
+
1174
+ ##### `props`<sup>Required</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.Workspace.Initializer.parameter.props"></a>
1175
+
1176
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.WorkspaceProps">WorkspaceProps</a>
1177
+
1178
+ ---
1179
+
1180
+ #### Methods <a name="Methods" id="Methods"></a>
1181
+
1182
+ | **Name** | **Description** |
1183
+ | --- | --- |
1184
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.toString">toString</a></code> | Returns a string representation of this construct. |
1185
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
1186
+
1187
+ ---
1188
+
1189
+ ##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.Workspace.toString"></a>
1190
+
1191
+ ```typescript
1192
+ public toString(): string
1193
+ ```
1194
+
1195
+ Returns a string representation of this construct.
1196
+
1197
+ ##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.Workspace.applyRemovalPolicy"></a>
1198
+
1199
+ ```typescript
1200
+ public applyRemovalPolicy(policy: RemovalPolicy): void
1201
+ ```
1202
+
1203
+ Apply the given removal policy to this resource.
1204
+
1205
+ The Removal Policy controls what happens to this resource when it stops
1206
+ being managed by CloudFormation, either because you've removed it from the
1207
+ CDK application or because you've made a change that requires the resource
1208
+ to be replaced.
1209
+
1210
+ The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
1211
+ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
1212
+
1213
+ ###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.Workspace.applyRemovalPolicy.parameter.policy"></a>
1214
+
1215
+ - *Type:* aws-cdk-lib.RemovalPolicy
1216
+
1217
+ ---
1218
+
1219
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
1220
+
1221
+ | **Name** | **Description** |
1222
+ | --- | --- |
1223
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
1224
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
1225
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
1226
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.frommWorkspaceAttributes">frommWorkspaceAttributes</a></code> | *No description.* |
1227
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.isWorkspace">isWorkspace</a></code> | *No description.* |
1228
+
1229
+ ---
1230
+
1231
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.Workspace.isConstruct"></a>
1232
+
1233
+ ```typescript
1234
+ import { Workspace } from '@robhan-cdk-lib/aws_aps'
1235
+
1236
+ Workspace.isConstruct(x: any)
1237
+ ```
1238
+
1239
+ Checks if `x` is a construct.
1240
+
1241
+ ###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.Workspace.isConstruct.parameter.x"></a>
1242
+
1243
+ - *Type:* any
1244
+
1245
+ Any object.
1246
+
1247
+ ---
1248
+
1249
+ ##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.Workspace.isOwnedResource"></a>
1250
+
1251
+ ```typescript
1252
+ import { Workspace } from '@robhan-cdk-lib/aws_aps'
1253
+
1254
+ Workspace.isOwnedResource(construct: IConstruct)
1255
+ ```
1256
+
1257
+ Returns true if the construct was created by CDK, and false otherwise.
1258
+
1259
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.Workspace.isOwnedResource.parameter.construct"></a>
1260
+
1261
+ - *Type:* constructs.IConstruct
1262
+
1263
+ ---
1264
+
1265
+ ##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.Workspace.isResource"></a>
1266
+
1267
+ ```typescript
1268
+ import { Workspace } from '@robhan-cdk-lib/aws_aps'
1269
+
1270
+ Workspace.isResource(construct: IConstruct)
1271
+ ```
1272
+
1273
+ Check whether the given construct is a Resource.
1274
+
1275
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.Workspace.isResource.parameter.construct"></a>
1276
+
1277
+ - *Type:* constructs.IConstruct
1278
+
1279
+ ---
1280
+
1281
+ ##### `frommWorkspaceAttributes` <a name="frommWorkspaceAttributes" id="@robhan-cdk-lib/aws_aps.Workspace.frommWorkspaceAttributes"></a>
1282
+
1283
+ ```typescript
1284
+ import { Workspace } from '@robhan-cdk-lib/aws_aps'
1285
+
1286
+ Workspace.frommWorkspaceAttributes(scope: Construct, id: string, attrs: WorkspaceAttributes)
1287
+ ```
1288
+
1289
+ ###### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.Workspace.frommWorkspaceAttributes.parameter.scope"></a>
1290
+
1291
+ - *Type:* constructs.Construct
1292
+
1293
+ ---
1294
+
1295
+ ###### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.Workspace.frommWorkspaceAttributes.parameter.id"></a>
1296
+
1297
+ - *Type:* string
1298
+
1299
+ ---
1300
+
1301
+ ###### `attrs`<sup>Required</sup> <a name="attrs" id="@robhan-cdk-lib/aws_aps.Workspace.frommWorkspaceAttributes.parameter.attrs"></a>
1302
+
1303
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.WorkspaceAttributes">WorkspaceAttributes</a>
1304
+
1305
+ ---
1306
+
1307
+ ##### `isWorkspace` <a name="isWorkspace" id="@robhan-cdk-lib/aws_aps.Workspace.isWorkspace"></a>
1308
+
1309
+ ```typescript
1310
+ import { Workspace } from '@robhan-cdk-lib/aws_aps'
1311
+
1312
+ Workspace.isWorkspace(x: any)
1313
+ ```
1314
+
1315
+ ###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.Workspace.isWorkspace.parameter.x"></a>
1316
+
1317
+ - *Type:* any
1318
+
1319
+ ---
1320
+
1321
+ #### Properties <a name="Properties" id="Properties"></a>
1322
+
1323
+ | **Name** | **Type** | **Description** |
1324
+ | --- | --- | --- |
1325
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
1326
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
1327
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
1328
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.property.workspaceArn">workspaceArn</a></code> | <code>string</code> | The ARN of the workspace. |
1329
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.property.workspaceId">workspaceId</a></code> | <code>string</code> | The unique ID for the workspace. |
1330
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.property.alertManagerDefinition">alertManagerDefinition</a></code> | <code>string</code> | The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace. |
1331
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.property.alias">alias</a></code> | <code>string</code> | The alias that is assigned to this workspace to help identify it. |
1332
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.property.kmsKey">kmsKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | The customer managed AWS KMS key to use for encrypting data within your workspace. |
1333
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.property.loggingConfiguration">loggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.LoggingConfiguration">LoggingConfiguration</a></code> | Contains information about the current rules and alerting logging configuration for the workspace. |
1334
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.property.queryLoggingConfiguration">queryLoggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration">QueryLoggingConfiguration</a></code> | The definition of logging configuration in an Amazon Managed Service for Prometheus workspace. |
1335
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.property.workspaceConfiguration">workspaceConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceConfiguration">WorkspaceConfiguration</a></code> | Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace. |
1336
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Workspace.property.prometheusEndpoint">prometheusEndpoint</a></code> | <code>string</code> | The Prometheus endpoint available for this workspace.. |
1337
+
1338
+ ---
1339
+
1340
+ ##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.Workspace.property.node"></a>
1341
+
1342
+ ```typescript
1343
+ public readonly node: Node;
1344
+ ```
1345
+
1346
+ - *Type:* constructs.Node
1347
+
1348
+ The tree node.
1349
+
1350
+ ---
1351
+
1352
+ ##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.Workspace.property.env"></a>
1353
+
1354
+ ```typescript
1355
+ public readonly env: ResourceEnvironment;
1356
+ ```
1357
+
1358
+ - *Type:* aws-cdk-lib.ResourceEnvironment
1359
+
1360
+ The environment this resource belongs to.
1361
+
1362
+ For resources that are created and managed by the CDK
1363
+ (generally, those created by creating new class instances like Role, Bucket, etc.),
1364
+ this is always the same as the environment of the stack they belong to;
1365
+ however, for imported resources
1366
+ (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
1367
+ that might be different than the stack they were imported into.
1368
+
1369
+ ---
1370
+
1371
+ ##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.Workspace.property.stack"></a>
1372
+
1373
+ ```typescript
1374
+ public readonly stack: Stack;
1375
+ ```
1376
+
1377
+ - *Type:* aws-cdk-lib.Stack
1378
+
1379
+ The stack in which this resource is defined.
1380
+
1381
+ ---
1382
+
1383
+ ##### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_aps.Workspace.property.workspaceArn"></a>
1384
+
1385
+ ```typescript
1386
+ public readonly workspaceArn: string;
1387
+ ```
1388
+
1389
+ - *Type:* string
1390
+
1391
+ The ARN of the workspace.
1392
+
1393
+ ---
1394
+
1395
+ ##### `workspaceId`<sup>Required</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_aps.Workspace.property.workspaceId"></a>
1396
+
1397
+ ```typescript
1398
+ public readonly workspaceId: string;
1399
+ ```
1400
+
1401
+ - *Type:* string
1402
+
1403
+ The unique ID for the workspace.
1404
+
1405
+ ---
1406
+
1407
+ ##### `alertManagerDefinition`<sup>Optional</sup> <a name="alertManagerDefinition" id="@robhan-cdk-lib/aws_aps.Workspace.property.alertManagerDefinition"></a>
1408
+
1409
+ ```typescript
1410
+ public readonly alertManagerDefinition: string;
1411
+ ```
1412
+
1413
+ - *Type:* string
1414
+
1415
+ The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace.
1416
+
1417
+ ---
1418
+
1419
+ ##### `alias`<sup>Optional</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.Workspace.property.alias"></a>
1420
+
1421
+ ```typescript
1422
+ public readonly alias: string;
1423
+ ```
1424
+
1425
+ - *Type:* string
1426
+
1427
+ The alias that is assigned to this workspace to help identify it.
1428
+
1429
+ It does not need to be
1430
+ unique.
1431
+
1432
+ ---
1433
+
1434
+ ##### `kmsKey`<sup>Optional</sup> <a name="kmsKey" id="@robhan-cdk-lib/aws_aps.Workspace.property.kmsKey"></a>
1435
+
1436
+ ```typescript
1437
+ public readonly kmsKey: IKey;
1438
+ ```
1439
+
1440
+ - *Type:* aws-cdk-lib.aws_kms.IKey
1441
+
1442
+ The customer managed AWS KMS key to use for encrypting data within your workspace.
1443
+
1444
+ ---
1445
+
1446
+ ##### `loggingConfiguration`<sup>Optional</sup> <a name="loggingConfiguration" id="@robhan-cdk-lib/aws_aps.Workspace.property.loggingConfiguration"></a>
1447
+
1448
+ ```typescript
1449
+ public readonly loggingConfiguration: LoggingConfiguration;
1450
+ ```
1451
+
1452
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.LoggingConfiguration">LoggingConfiguration</a>
1453
+
1454
+ Contains information about the current rules and alerting logging configuration for the workspace.
1455
+
1456
+ Note: These logging configurations are only for rules and alerting logs.
1457
+
1458
+ ---
1459
+
1460
+ ##### `queryLoggingConfiguration`<sup>Optional</sup> <a name="queryLoggingConfiguration" id="@robhan-cdk-lib/aws_aps.Workspace.property.queryLoggingConfiguration"></a>
1461
+
1462
+ ```typescript
1463
+ public readonly queryLoggingConfiguration: QueryLoggingConfiguration;
1464
+ ```
1465
+
1466
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration">QueryLoggingConfiguration</a>
1467
+
1468
+ The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
1469
+
1470
+ ---
1471
+
1472
+ ##### `workspaceConfiguration`<sup>Optional</sup> <a name="workspaceConfiguration" id="@robhan-cdk-lib/aws_aps.Workspace.property.workspaceConfiguration"></a>
1473
+
1474
+ ```typescript
1475
+ public readonly workspaceConfiguration: WorkspaceConfiguration;
1476
+ ```
1477
+
1478
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.WorkspaceConfiguration">WorkspaceConfiguration</a>
1479
+
1480
+ Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace.
1481
+
1482
+ ---
1483
+
1484
+ ##### `prometheusEndpoint`<sup>Required</sup> <a name="prometheusEndpoint" id="@robhan-cdk-lib/aws_aps.Workspace.property.prometheusEndpoint"></a>
1485
+
1486
+ ```typescript
1487
+ public readonly prometheusEndpoint: string;
1488
+ ```
1489
+
1490
+ - *Type:* string
1491
+
1492
+ The Prometheus endpoint available for this workspace..
1493
+
1494
+ ---
1495
+
1496
+
1497
+ ### WorkspaceBase <a name="WorkspaceBase" id="@robhan-cdk-lib/aws_aps.WorkspaceBase"></a>
1498
+
1499
+ - *Implements:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
1500
+
1501
+ #### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.Initializer"></a>
1502
+
1503
+ ```typescript
1504
+ import { WorkspaceBase } from '@robhan-cdk-lib/aws_aps'
1505
+
1506
+ new WorkspaceBase(scope: Construct, id: string, props?: ResourceProps)
1507
+ ```
1508
+
1509
+ | **Name** | **Type** | **Description** |
1510
+ | --- | --- | --- |
1511
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
1512
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
1513
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.Initializer.parameter.props">props</a></code> | <code>aws-cdk-lib.ResourceProps</code> | *No description.* |
1514
+
1515
+ ---
1516
+
1517
+ ##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.Initializer.parameter.scope"></a>
1518
+
1519
+ - *Type:* constructs.Construct
1520
+
1521
+ ---
1522
+
1523
+ ##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.Initializer.parameter.id"></a>
1524
+
1525
+ - *Type:* string
1526
+
1527
+ ---
1528
+
1529
+ ##### `props`<sup>Optional</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.Initializer.parameter.props"></a>
1530
+
1531
+ - *Type:* aws-cdk-lib.ResourceProps
1532
+
1533
+ ---
1534
+
1535
+ #### Methods <a name="Methods" id="Methods"></a>
1536
+
1537
+ | **Name** | **Description** |
1538
+ | --- | --- |
1539
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.toString">toString</a></code> | Returns a string representation of this construct. |
1540
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
1541
+
1542
+ ---
1543
+
1544
+ ##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.toString"></a>
1545
+
1546
+ ```typescript
1547
+ public toString(): string
1548
+ ```
1549
+
1550
+ Returns a string representation of this construct.
1551
+
1552
+ ##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.applyRemovalPolicy"></a>
1553
+
1554
+ ```typescript
1555
+ public applyRemovalPolicy(policy: RemovalPolicy): void
1556
+ ```
1557
+
1558
+ Apply the given removal policy to this resource.
1559
+
1560
+ The Removal Policy controls what happens to this resource when it stops
1561
+ being managed by CloudFormation, either because you've removed it from the
1562
+ CDK application or because you've made a change that requires the resource
1563
+ to be replaced.
1564
+
1565
+ The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
1566
+ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
1567
+
1568
+ ###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.applyRemovalPolicy.parameter.policy"></a>
1569
+
1570
+ - *Type:* aws-cdk-lib.RemovalPolicy
1571
+
1572
+ ---
1573
+
1574
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
1575
+
1576
+ | **Name** | **Description** |
1577
+ | --- | --- |
1578
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
1579
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
1580
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
1581
+
1582
+ ---
1583
+
1584
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.isConstruct"></a>
1585
+
1586
+ ```typescript
1587
+ import { WorkspaceBase } from '@robhan-cdk-lib/aws_aps'
1588
+
1589
+ WorkspaceBase.isConstruct(x: any)
1590
+ ```
1591
+
1592
+ Checks if `x` is a construct.
1593
+
1594
+ ###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.isConstruct.parameter.x"></a>
1595
+
1596
+ - *Type:* any
1597
+
1598
+ Any object.
1599
+
1600
+ ---
1601
+
1602
+ ##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.isOwnedResource"></a>
1603
+
1604
+ ```typescript
1605
+ import { WorkspaceBase } from '@robhan-cdk-lib/aws_aps'
1606
+
1607
+ WorkspaceBase.isOwnedResource(construct: IConstruct)
1608
+ ```
1609
+
1610
+ Returns true if the construct was created by CDK, and false otherwise.
1611
+
1612
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.isOwnedResource.parameter.construct"></a>
1613
+
1614
+ - *Type:* constructs.IConstruct
1615
+
1616
+ ---
1617
+
1618
+ ##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.isResource"></a>
1619
+
1620
+ ```typescript
1621
+ import { WorkspaceBase } from '@robhan-cdk-lib/aws_aps'
1622
+
1623
+ WorkspaceBase.isResource(construct: IConstruct)
1624
+ ```
1625
+
1626
+ Check whether the given construct is a Resource.
1627
+
1628
+ ###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.isResource.parameter.construct"></a>
1629
+
1630
+ - *Type:* constructs.IConstruct
1631
+
1632
+ ---
1633
+
1634
+ #### Properties <a name="Properties" id="Properties"></a>
1635
+
1636
+ | **Name** | **Type** | **Description** |
1637
+ | --- | --- | --- |
1638
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
1639
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
1640
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
1641
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.property.workspaceArn">workspaceArn</a></code> | <code>string</code> | The ARN of the workspace. |
1642
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.property.workspaceId">workspaceId</a></code> | <code>string</code> | The unique ID for the workspace. |
1643
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.property.alertManagerDefinition">alertManagerDefinition</a></code> | <code>string</code> | The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace. |
1644
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.property.alias">alias</a></code> | <code>string</code> | The alias that is assigned to this workspace to help identify it. |
1645
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.property.kmsKey">kmsKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | The customer managed AWS KMS key to use for encrypting data within your workspace. |
1646
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.property.loggingConfiguration">loggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.LoggingConfiguration">LoggingConfiguration</a></code> | Contains information about the current rules and alerting logging configuration for the workspace. |
1647
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.property.queryLoggingConfiguration">queryLoggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration">QueryLoggingConfiguration</a></code> | The definition of logging configuration in an Amazon Managed Service for Prometheus workspace. |
1648
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase.property.workspaceConfiguration">workspaceConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceConfiguration">WorkspaceConfiguration</a></code> | Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace. |
1649
+
1650
+ ---
1651
+
1652
+ ##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.node"></a>
1653
+
1654
+ ```typescript
1655
+ public readonly node: Node;
1656
+ ```
1657
+
1658
+ - *Type:* constructs.Node
1659
+
1660
+ The tree node.
1661
+
1662
+ ---
1663
+
1664
+ ##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.env"></a>
1665
+
1666
+ ```typescript
1667
+ public readonly env: ResourceEnvironment;
1668
+ ```
1669
+
1670
+ - *Type:* aws-cdk-lib.ResourceEnvironment
1671
+
1672
+ The environment this resource belongs to.
1673
+
1674
+ For resources that are created and managed by the CDK
1675
+ (generally, those created by creating new class instances like Role, Bucket, etc.),
1676
+ this is always the same as the environment of the stack they belong to;
1677
+ however, for imported resources
1678
+ (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
1679
+ that might be different than the stack they were imported into.
1680
+
1681
+ ---
1682
+
1683
+ ##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.stack"></a>
1684
+
1685
+ ```typescript
1686
+ public readonly stack: Stack;
1687
+ ```
1688
+
1689
+ - *Type:* aws-cdk-lib.Stack
1690
+
1691
+ The stack in which this resource is defined.
1692
+
1693
+ ---
1694
+
1695
+ ##### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.workspaceArn"></a>
1696
+
1697
+ ```typescript
1698
+ public readonly workspaceArn: string;
1699
+ ```
1700
+
1701
+ - *Type:* string
1702
+
1703
+ The ARN of the workspace.
1704
+
1705
+ ---
1706
+
1707
+ ##### `workspaceId`<sup>Required</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.workspaceId"></a>
1708
+
1709
+ ```typescript
1710
+ public readonly workspaceId: string;
1711
+ ```
1712
+
1713
+ - *Type:* string
1714
+
1715
+ The unique ID for the workspace.
1716
+
1717
+ ---
1718
+
1719
+ ##### `alertManagerDefinition`<sup>Optional</sup> <a name="alertManagerDefinition" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.alertManagerDefinition"></a>
1720
+
1721
+ ```typescript
1722
+ public readonly alertManagerDefinition: string;
1723
+ ```
1724
+
1725
+ - *Type:* string
1726
+
1727
+ The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace.
1728
+
1729
+ ---
1730
+
1731
+ ##### `alias`<sup>Optional</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.alias"></a>
1732
+
1733
+ ```typescript
1734
+ public readonly alias: string;
1735
+ ```
1736
+
1737
+ - *Type:* string
1738
+
1739
+ The alias that is assigned to this workspace to help identify it.
1740
+
1741
+ It does not need to be
1742
+ unique.
1743
+
1744
+ ---
1745
+
1746
+ ##### `kmsKey`<sup>Optional</sup> <a name="kmsKey" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.kmsKey"></a>
1747
+
1748
+ ```typescript
1749
+ public readonly kmsKey: IKey;
1750
+ ```
1751
+
1752
+ - *Type:* aws-cdk-lib.aws_kms.IKey
1753
+
1754
+ The customer managed AWS KMS key to use for encrypting data within your workspace.
1755
+
1756
+ ---
1757
+
1758
+ ##### `loggingConfiguration`<sup>Optional</sup> <a name="loggingConfiguration" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.loggingConfiguration"></a>
1759
+
1760
+ ```typescript
1761
+ public readonly loggingConfiguration: LoggingConfiguration;
1762
+ ```
1763
+
1764
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.LoggingConfiguration">LoggingConfiguration</a>
1765
+
1766
+ Contains information about the current rules and alerting logging configuration for the workspace.
1767
+
1768
+ Note: These logging configurations are only for rules and alerting logs.
1769
+
1770
+ ---
1771
+
1772
+ ##### `queryLoggingConfiguration`<sup>Optional</sup> <a name="queryLoggingConfiguration" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.queryLoggingConfiguration"></a>
1773
+
1774
+ ```typescript
1775
+ public readonly queryLoggingConfiguration: QueryLoggingConfiguration;
1776
+ ```
1777
+
1778
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration">QueryLoggingConfiguration</a>
1779
+
1780
+ The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
1781
+
1782
+ ---
1783
+
1784
+ ##### `workspaceConfiguration`<sup>Optional</sup> <a name="workspaceConfiguration" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.workspaceConfiguration"></a>
1785
+
1786
+ ```typescript
1787
+ public readonly workspaceConfiguration: WorkspaceConfiguration;
1788
+ ```
1789
+
1790
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.WorkspaceConfiguration">WorkspaceConfiguration</a>
1791
+
1792
+ Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace.
1793
+
1794
+ ---
1795
+
1796
+
1797
+ ## Structs <a name="Structs" id="Structs"></a>
1798
+
1799
+ ### AmpConfiguration <a name="AmpConfiguration" id="@robhan-cdk-lib/aws_aps.AmpConfiguration"></a>
1800
+
1801
+ The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.
1802
+
1803
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.AmpConfiguration.Initializer"></a>
1804
+
1805
+ ```typescript
1806
+ import { AmpConfiguration } from '@robhan-cdk-lib/aws_aps'
1807
+
1808
+ const ampConfiguration: AmpConfiguration = { ... }
1809
+ ```
1810
+
1811
+ #### Properties <a name="Properties" id="Properties"></a>
1812
+
1813
+ | **Name** | **Type** | **Description** |
1814
+ | --- | --- | --- |
1815
+ | <code><a href="#@robhan-cdk-lib/aws_aps.AmpConfiguration.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | The Amazon Managed Service for Prometheus workspace. |
1816
+
1817
+ ---
1818
+
1819
+ ##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.AmpConfiguration.property.workspace"></a>
1820
+
1821
+ ```typescript
1822
+ public readonly workspace: IWorkspace;
1823
+ ```
1824
+
1825
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
1826
+
1827
+ The Amazon Managed Service for Prometheus workspace.
1828
+
1829
+ ---
1830
+
1831
+ ### CloudWatchLogDestination <a name="CloudWatchLogDestination" id="@robhan-cdk-lib/aws_aps.CloudWatchLogDestination"></a>
1832
+
1833
+ Configuration details for logging to CloudWatch Logs.
1834
+
1835
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.CloudWatchLogDestination.Initializer"></a>
1836
+
1837
+ ```typescript
1838
+ import { CloudWatchLogDestination } from '@robhan-cdk-lib/aws_aps'
1839
+
1840
+ const cloudWatchLogDestination: CloudWatchLogDestination = { ... }
1841
+ ```
1842
+
1843
+ #### Properties <a name="Properties" id="Properties"></a>
1844
+
1845
+ | **Name** | **Type** | **Description** |
1846
+ | --- | --- | --- |
1847
+ | <code><a href="#@robhan-cdk-lib/aws_aps.CloudWatchLogDestination.property.logGroup">logGroup</a></code> | <code>aws-cdk-lib.aws_logs.ILogGroup</code> | The CloudWatch log group. |
1848
+
1849
+ ---
1850
+
1851
+ ##### `logGroup`<sup>Required</sup> <a name="logGroup" id="@robhan-cdk-lib/aws_aps.CloudWatchLogDestination.property.logGroup"></a>
1852
+
1853
+ ```typescript
1854
+ public readonly logGroup: ILogGroup;
1855
+ ```
1856
+
1857
+ - *Type:* aws-cdk-lib.aws_logs.ILogGroup
1858
+
1859
+ The CloudWatch log group.
1860
+
1861
+ ---
1862
+
1863
+ ### Destination <a name="Destination" id="@robhan-cdk-lib/aws_aps.Destination"></a>
1864
+
1865
+ Where to send the metrics from a scraper.
1866
+
1867
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.Destination.Initializer"></a>
1868
+
1869
+ ```typescript
1870
+ import { Destination } from '@robhan-cdk-lib/aws_aps'
1871
+
1872
+ const destination: Destination = { ... }
1873
+ ```
1874
+
1875
+ #### Properties <a name="Properties" id="Properties"></a>
1876
+
1877
+ | **Name** | **Type** | **Description** |
1878
+ | --- | --- | --- |
1879
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Destination.property.ampConfiguration">ampConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.AmpConfiguration">AmpConfiguration</a></code> | The Amazon Managed Service for Prometheus workspace to send metrics to. |
1880
+
1881
+ ---
1882
+
1883
+ ##### `ampConfiguration`<sup>Required</sup> <a name="ampConfiguration" id="@robhan-cdk-lib/aws_aps.Destination.property.ampConfiguration"></a>
1884
+
1885
+ ```typescript
1886
+ public readonly ampConfiguration: AmpConfiguration;
1887
+ ```
1888
+
1889
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.AmpConfiguration">AmpConfiguration</a>
1890
+
1891
+ The Amazon Managed Service for Prometheus workspace to send metrics to.
1892
+
1893
+ ---
1894
+
1895
+ ### EksConfiguration <a name="EksConfiguration" id="@robhan-cdk-lib/aws_aps.EksConfiguration"></a>
1896
+
1897
+ The EksConfiguration structure describes the connection to the Amazon EKS cluster from which a scraper collects metrics.
1898
+
1899
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.EksConfiguration.Initializer"></a>
1900
+
1901
+ ```typescript
1902
+ import { EksConfiguration } from '@robhan-cdk-lib/aws_aps'
1903
+
1904
+ const eksConfiguration: EksConfiguration = { ... }
1905
+ ```
1906
+
1907
+ #### Properties <a name="Properties" id="Properties"></a>
1908
+
1909
+ | **Name** | **Type** | **Description** |
1910
+ | --- | --- | --- |
1911
+ | <code><a href="#@robhan-cdk-lib/aws_aps.EksConfiguration.property.cluster">cluster</a></code> | <code>aws-cdk-lib.aws_eks.ICluster</code> | The Amazon EKS cluster. |
1912
+ | <code><a href="#@robhan-cdk-lib/aws_aps.EksConfiguration.property.subnets">subnets</a></code> | <code>aws-cdk-lib.aws_ec2.ISubnet[]</code> | A list of subnets for the Amazon EKS cluster VPC configuration. |
1913
+ | <code><a href="#@robhan-cdk-lib/aws_aps.EksConfiguration.property.securityGroups">securityGroups</a></code> | <code>aws-cdk-lib.aws_ec2.ISecurityGroup[]</code> | A list of the security group IDs for the Amazon EKS cluster VPC configuration. |
1914
+
1915
+ ---
1916
+
1917
+ ##### `cluster`<sup>Required</sup> <a name="cluster" id="@robhan-cdk-lib/aws_aps.EksConfiguration.property.cluster"></a>
1918
+
1919
+ ```typescript
1920
+ public readonly cluster: ICluster;
1921
+ ```
1922
+
1923
+ - *Type:* aws-cdk-lib.aws_eks.ICluster
1924
+
1925
+ The Amazon EKS cluster.
1926
+
1927
+ ---
1928
+
1929
+ ##### `subnets`<sup>Required</sup> <a name="subnets" id="@robhan-cdk-lib/aws_aps.EksConfiguration.property.subnets"></a>
1930
+
1931
+ ```typescript
1932
+ public readonly subnets: ISubnet[];
1933
+ ```
1934
+
1935
+ - *Type:* aws-cdk-lib.aws_ec2.ISubnet[]
1936
+
1937
+ A list of subnets for the Amazon EKS cluster VPC configuration.
1938
+
1939
+ Min 1, max 5.
1940
+
1941
+ ---
1942
+
1943
+ ##### `securityGroups`<sup>Optional</sup> <a name="securityGroups" id="@robhan-cdk-lib/aws_aps.EksConfiguration.property.securityGroups"></a>
1944
+
1945
+ ```typescript
1946
+ public readonly securityGroups: ISecurityGroup[];
1947
+ ```
1948
+
1949
+ - *Type:* aws-cdk-lib.aws_ec2.ISecurityGroup[]
1950
+
1951
+ A list of the security group IDs for the Amazon EKS cluster VPC configuration.
1952
+
1953
+ Min 1, max 5.
1954
+
1955
+ ---
1956
+
1957
+ ### Label <a name="Label" id="@robhan-cdk-lib/aws_aps.Label"></a>
1958
+
1959
+ A label is a name:value pair used to add context to ingested metrics.
1960
+
1961
+ This structure defines the
1962
+ name and value for one label that is used in a label set. You can set ingestion limits on time
1963
+ series that match defined label sets, to help prevent a workspace from being overwhelmed with
1964
+ unexpected spikes in time series ingestion.
1965
+
1966
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.Label.Initializer"></a>
1967
+
1968
+ ```typescript
1969
+ import { Label } from '@robhan-cdk-lib/aws_aps'
1970
+
1971
+ const label: Label = { ... }
1972
+ ```
1973
+
1974
+ #### Properties <a name="Properties" id="Properties"></a>
1975
+
1976
+ | **Name** | **Type** | **Description** |
1977
+ | --- | --- | --- |
1978
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Label.property.name">name</a></code> | <code>string</code> | The name for this label. |
1979
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Label.property.value">value</a></code> | <code>string</code> | The value for this label. |
1980
+
1981
+ ---
1982
+
1983
+ ##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_aps.Label.property.name"></a>
1984
+
1985
+ ```typescript
1986
+ public readonly name: string;
1987
+ ```
1988
+
1989
+ - *Type:* string
1990
+
1991
+ The name for this label.
1992
+
1993
+ Pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
1994
+
1995
+ At least one character.
1996
+
1997
+ ---
1998
+
1999
+ ##### `value`<sup>Required</sup> <a name="value" id="@robhan-cdk-lib/aws_aps.Label.property.value"></a>
2000
+
2001
+ ```typescript
2002
+ public readonly value: string;
2003
+ ```
2004
+
2005
+ - *Type:* string
2006
+
2007
+ The value for this label.
2008
+
2009
+ At least one character.
2010
+
2011
+ ---
2012
+
2013
+ ### LimitsPerLabelSet <a name="LimitsPerLabelSet" id="@robhan-cdk-lib/aws_aps.LimitsPerLabelSet"></a>
2014
+
2015
+ This defines a label set for the workspace, and defines the ingestion limit for active time series that match that label set.
2016
+
2017
+ Each label name in a label set must be unique.
2018
+
2019
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.LimitsPerLabelSet.Initializer"></a>
2020
+
2021
+ ```typescript
2022
+ import { LimitsPerLabelSet } from '@robhan-cdk-lib/aws_aps'
2023
+
2024
+ const limitsPerLabelSet: LimitsPerLabelSet = { ... }
2025
+ ```
2026
+
2027
+ #### Properties <a name="Properties" id="Properties"></a>
2028
+
2029
+ | **Name** | **Type** | **Description** |
2030
+ | --- | --- | --- |
2031
+ | <code><a href="#@robhan-cdk-lib/aws_aps.LimitsPerLabelSet.property.labelSet">labelSet</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Label">Label</a>[]</code> | This defines one label set that will have an enforced ingestion limit. |
2032
+ | <code><a href="#@robhan-cdk-lib/aws_aps.LimitsPerLabelSet.property.limits">limits</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.LimitsPerLabelSetEntry">LimitsPerLabelSetEntry</a></code> | This structure contains the information about the limits that apply to time series that match this label set. |
2033
+
2034
+ ---
2035
+
2036
+ ##### `labelSet`<sup>Required</sup> <a name="labelSet" id="@robhan-cdk-lib/aws_aps.LimitsPerLabelSet.property.labelSet"></a>
2037
+
2038
+ ```typescript
2039
+ public readonly labelSet: Label[];
2040
+ ```
2041
+
2042
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.Label">Label</a>[]
2043
+
2044
+ This defines one label set that will have an enforced ingestion limit.
2045
+
2046
+ You can set ingestion
2047
+ limits on time series that match defined label sets, to help prevent a workspace from being
2048
+ overwhelmed with unexpected spikes in time series ingestion.
2049
+
2050
+ Label values accept all UTF-8 characters with one exception. If the label name is metric
2051
+ name label __name__, then the metric part of the name must conform to the following pattern:
2052
+ [a-zA-Z_:][a-zA-Z0-9_:]*
2053
+
2054
+ Minimum 0
2055
+
2056
+ ---
2057
+
2058
+ ##### `limits`<sup>Required</sup> <a name="limits" id="@robhan-cdk-lib/aws_aps.LimitsPerLabelSet.property.limits"></a>
2059
+
2060
+ ```typescript
2061
+ public readonly limits: LimitsPerLabelSetEntry;
2062
+ ```
2063
+
2064
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.LimitsPerLabelSetEntry">LimitsPerLabelSetEntry</a>
2065
+
2066
+ This structure contains the information about the limits that apply to time series that match this label set.
2067
+
2068
+ ---
2069
+
2070
+ ### LimitsPerLabelSetEntry <a name="LimitsPerLabelSetEntry" id="@robhan-cdk-lib/aws_aps.LimitsPerLabelSetEntry"></a>
2071
+
2072
+ This structure contains the limits that apply to time series that match one label set.
2073
+
2074
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.LimitsPerLabelSetEntry.Initializer"></a>
2075
+
2076
+ ```typescript
2077
+ import { LimitsPerLabelSetEntry } from '@robhan-cdk-lib/aws_aps'
2078
+
2079
+ const limitsPerLabelSetEntry: LimitsPerLabelSetEntry = { ... }
2080
+ ```
2081
+
2082
+ #### Properties <a name="Properties" id="Properties"></a>
2083
+
2084
+ | **Name** | **Type** | **Description** |
2085
+ | --- | --- | --- |
2086
+ | <code><a href="#@robhan-cdk-lib/aws_aps.LimitsPerLabelSetEntry.property.maxSeries">maxSeries</a></code> | <code>number</code> | The maximum number of active series that can be ingested that match this label set. |
2087
+
2088
+ ---
2089
+
2090
+ ##### `maxSeries`<sup>Optional</sup> <a name="maxSeries" id="@robhan-cdk-lib/aws_aps.LimitsPerLabelSetEntry.property.maxSeries"></a>
2091
+
2092
+ ```typescript
2093
+ public readonly maxSeries: number;
2094
+ ```
2095
+
2096
+ - *Type:* number
2097
+
2098
+ The maximum number of active series that can be ingested that match this label set.
2099
+
2100
+ Setting this to 0 causes no label set limit to be enforced, but it does cause Amazon Managed
2101
+ Service for Prometheus to vend label set metrics to CloudWatch Logs.
2102
+
2103
+ Minimum 0
2104
+
2105
+ ---
2106
+
2107
+ ### LoggingConfiguration <a name="LoggingConfiguration" id="@robhan-cdk-lib/aws_aps.LoggingConfiguration"></a>
2108
+
2109
+ Contains information about the rules and alerting logging configuration for the workspace.
2110
+
2111
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.LoggingConfiguration.Initializer"></a>
2112
+
2113
+ ```typescript
2114
+ import { LoggingConfiguration } from '@robhan-cdk-lib/aws_aps'
2115
+
2116
+ const loggingConfiguration: LoggingConfiguration = { ... }
2117
+ ```
2118
+
2119
+ #### Properties <a name="Properties" id="Properties"></a>
2120
+
2121
+ | **Name** | **Type** | **Description** |
2122
+ | --- | --- | --- |
2123
+ | <code><a href="#@robhan-cdk-lib/aws_aps.LoggingConfiguration.property.logGroup">logGroup</a></code> | <code>aws-cdk-lib.aws_logs.ILogGroup</code> | The CloudWatch log group to which the vended log data will be published. |
2124
+
2125
+ ---
2126
+
2127
+ ##### `logGroup`<sup>Optional</sup> <a name="logGroup" id="@robhan-cdk-lib/aws_aps.LoggingConfiguration.property.logGroup"></a>
2128
+
2129
+ ```typescript
2130
+ public readonly logGroup: ILogGroup;
2131
+ ```
2132
+
2133
+ - *Type:* aws-cdk-lib.aws_logs.ILogGroup
2134
+
2135
+ The CloudWatch log group to which the vended log data will be published.
2136
+
2137
+ ---
2138
+
2139
+ ### LoggingDestination <a name="LoggingDestination" id="@robhan-cdk-lib/aws_aps.LoggingDestination"></a>
2140
+
2141
+ The logging destination in an Amazon Managed Service for Prometheus workspace.
2142
+
2143
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.LoggingDestination.Initializer"></a>
2144
+
2145
+ ```typescript
2146
+ import { LoggingDestination } from '@robhan-cdk-lib/aws_aps'
2147
+
2148
+ const loggingDestination: LoggingDestination = { ... }
2149
+ ```
2150
+
2151
+ #### Properties <a name="Properties" id="Properties"></a>
2152
+
2153
+ | **Name** | **Type** | **Description** |
2154
+ | --- | --- | --- |
2155
+ | <code><a href="#@robhan-cdk-lib/aws_aps.LoggingDestination.property.cloudWatchLogs">cloudWatchLogs</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.CloudWatchLogDestination">CloudWatchLogDestination</a></code> | Configuration details for logging to CloudWatch Logs. |
2156
+ | <code><a href="#@robhan-cdk-lib/aws_aps.LoggingDestination.property.filters">filters</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.LoggingFilter">LoggingFilter</a></code> | Filtering criteria that determine which queries are logged. |
2157
+
2158
+ ---
2159
+
2160
+ ##### `cloudWatchLogs`<sup>Required</sup> <a name="cloudWatchLogs" id="@robhan-cdk-lib/aws_aps.LoggingDestination.property.cloudWatchLogs"></a>
2161
+
2162
+ ```typescript
2163
+ public readonly cloudWatchLogs: CloudWatchLogDestination;
2164
+ ```
2165
+
2166
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.CloudWatchLogDestination">CloudWatchLogDestination</a>
2167
+
2168
+ Configuration details for logging to CloudWatch Logs.
2169
+
2170
+ ---
2171
+
2172
+ ##### `filters`<sup>Required</sup> <a name="filters" id="@robhan-cdk-lib/aws_aps.LoggingDestination.property.filters"></a>
2173
+
2174
+ ```typescript
2175
+ public readonly filters: LoggingFilter;
2176
+ ```
2177
+
2178
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.LoggingFilter">LoggingFilter</a>
2179
+
2180
+ Filtering criteria that determine which queries are logged.
2181
+
2182
+ ---
2183
+
2184
+ ### LoggingFilter <a name="LoggingFilter" id="@robhan-cdk-lib/aws_aps.LoggingFilter"></a>
2185
+
2186
+ Filtering criteria that determine which queries are logged.
2187
+
2188
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.LoggingFilter.Initializer"></a>
2189
+
2190
+ ```typescript
2191
+ import { LoggingFilter } from '@robhan-cdk-lib/aws_aps'
2192
+
2193
+ const loggingFilter: LoggingFilter = { ... }
2194
+ ```
2195
+
2196
+ #### Properties <a name="Properties" id="Properties"></a>
2197
+
2198
+ | **Name** | **Type** | **Description** |
2199
+ | --- | --- | --- |
2200
+ | <code><a href="#@robhan-cdk-lib/aws_aps.LoggingFilter.property.qspThreshold">qspThreshold</a></code> | <code>number</code> | Integer. |
2201
+
2202
+ ---
2203
+
2204
+ ##### `qspThreshold`<sup>Required</sup> <a name="qspThreshold" id="@robhan-cdk-lib/aws_aps.LoggingFilter.property.qspThreshold"></a>
2205
+
2206
+ ```typescript
2207
+ public readonly qspThreshold: number;
2208
+ ```
2209
+
2210
+ - *Type:* number
2211
+
2212
+ Integer.
2213
+
2214
+ Minimum 0
2215
+
2216
+ ---
2217
+
2218
+ ### QueryLoggingConfiguration <a name="QueryLoggingConfiguration" id="@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration"></a>
2219
+
2220
+ The query logging configuration in an Amazon Managed Service for Prometheus workspace.
2221
+
2222
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration.Initializer"></a>
2223
+
2224
+ ```typescript
2225
+ import { QueryLoggingConfiguration } from '@robhan-cdk-lib/aws_aps'
2226
+
2227
+ const queryLoggingConfiguration: QueryLoggingConfiguration = { ... }
2228
+ ```
2229
+
2230
+ #### Properties <a name="Properties" id="Properties"></a>
2231
+
2232
+ | **Name** | **Type** | **Description** |
2233
+ | --- | --- | --- |
2234
+ | <code><a href="#@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration.property.destinations">destinations</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.LoggingDestination">LoggingDestination</a>[]</code> | Defines a destination and its associated filtering criteria for query logging. |
2235
+
2236
+ ---
2237
+
2238
+ ##### `destinations`<sup>Required</sup> <a name="destinations" id="@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration.property.destinations"></a>
2239
+
2240
+ ```typescript
2241
+ public readonly destinations: LoggingDestination[];
2242
+ ```
2243
+
2244
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.LoggingDestination">LoggingDestination</a>[]
2245
+
2246
+ Defines a destination and its associated filtering criteria for query logging.
2247
+
2248
+ Minimum 1 and maximum 1 item in array.
2249
+
2250
+ ---
2251
+
2252
+ ### RoleConfiguration <a name="RoleConfiguration" id="@robhan-cdk-lib/aws_aps.RoleConfiguration"></a>
2253
+
2254
+ The role configuration in an Amazon Managed Service for Prometheus scraper.
2255
+
2256
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.RoleConfiguration.Initializer"></a>
2257
+
2258
+ ```typescript
2259
+ import { RoleConfiguration } from '@robhan-cdk-lib/aws_aps'
2260
+
2261
+ const roleConfiguration: RoleConfiguration = { ... }
2262
+ ```
2263
+
2264
+ #### Properties <a name="Properties" id="Properties"></a>
2265
+
2266
+ | **Name** | **Type** | **Description** |
2267
+ | --- | --- | --- |
2268
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RoleConfiguration.property.sourceRole">sourceRole</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | The source role. |
2269
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RoleConfiguration.property.targetRole">targetRole</a></code> | <code>aws-cdk-lib.aws_iam.IRole</code> | The target role. |
2270
+
2271
+ ---
2272
+
2273
+ ##### `sourceRole`<sup>Optional</sup> <a name="sourceRole" id="@robhan-cdk-lib/aws_aps.RoleConfiguration.property.sourceRole"></a>
2274
+
2275
+ ```typescript
2276
+ public readonly sourceRole: IRole;
2277
+ ```
2278
+
2279
+ - *Type:* aws-cdk-lib.aws_iam.IRole
2280
+
2281
+ The source role.
2282
+
2283
+ ---
2284
+
2285
+ ##### `targetRole`<sup>Optional</sup> <a name="targetRole" id="@robhan-cdk-lib/aws_aps.RoleConfiguration.property.targetRole"></a>
2286
+
2287
+ ```typescript
2288
+ public readonly targetRole: IRole;
2289
+ ```
2290
+
2291
+ - *Type:* aws-cdk-lib.aws_iam.IRole
2292
+
2293
+ The target role.
2294
+
2295
+ ---
2296
+
2297
+ ### RuleGroupsNamespaceAttributes <a name="RuleGroupsNamespaceAttributes" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceAttributes"></a>
2298
+
2299
+ Properties for importing a rule groups namespace in an Amazon Managed Service for Prometheus workspace from attributes.
2300
+
2301
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceAttributes.Initializer"></a>
2302
+
2303
+ ```typescript
2304
+ import { RuleGroupsNamespaceAttributes } from '@robhan-cdk-lib/aws_aps'
2305
+
2306
+ const ruleGroupsNamespaceAttributes: RuleGroupsNamespaceAttributes = { ... }
2307
+ ```
2308
+
2309
+ #### Properties <a name="Properties" id="Properties"></a>
2310
+
2311
+ | **Name** | **Type** | **Description** |
2312
+ | --- | --- | --- |
2313
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceAttributes.property.data">data</a></code> | <code>string</code> | The rules file used in the namespace. |
2314
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceAttributes.property.name">name</a></code> | <code>string</code> | The name of the rule groups namespace. |
2315
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceAttributes.property.ruleGroupsNamespaceArn">ruleGroupsNamespaceArn</a></code> | <code>string</code> | The ARN of the rule groups namespace. |
2316
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceAttributes.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | The workspace to add the rule groups namespace. |
2317
+
2318
+ ---
2319
+
2320
+ ##### `data`<sup>Required</sup> <a name="data" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceAttributes.property.data"></a>
2321
+
2322
+ ```typescript
2323
+ public readonly data: string;
2324
+ ```
2325
+
2326
+ - *Type:* string
2327
+
2328
+ The rules file used in the namespace.
2329
+
2330
+ ---
2331
+
2332
+ ##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceAttributes.property.name"></a>
2333
+
2334
+ ```typescript
2335
+ public readonly name: string;
2336
+ ```
2337
+
2338
+ - *Type:* string
2339
+
2340
+ The name of the rule groups namespace.
2341
+
2342
+ Between 1 and 64 characters.
2343
+
2344
+ ---
2345
+
2346
+ ##### `ruleGroupsNamespaceArn`<sup>Required</sup> <a name="ruleGroupsNamespaceArn" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceAttributes.property.ruleGroupsNamespaceArn"></a>
2347
+
2348
+ ```typescript
2349
+ public readonly ruleGroupsNamespaceArn: string;
2350
+ ```
2351
+
2352
+ - *Type:* string
2353
+
2354
+ The ARN of the rule groups namespace.
2355
+
2356
+ ---
2357
+
2358
+ ##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceAttributes.property.workspace"></a>
2359
+
2360
+ ```typescript
2361
+ public readonly workspace: IWorkspace;
2362
+ ```
2363
+
2364
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
2365
+
2366
+ The workspace to add the rule groups namespace.
2367
+
2368
+ ---
2369
+
2370
+ ### RuleGroupsNamespaceProps <a name="RuleGroupsNamespaceProps" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceProps"></a>
2371
+
2372
+ Properties for creating a rule groups namespace in an Amazon Managed Service for Prometheus workspace.
2373
+
2374
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceProps.Initializer"></a>
2375
+
2376
+ ```typescript
2377
+ import { RuleGroupsNamespaceProps } from '@robhan-cdk-lib/aws_aps'
2378
+
2379
+ const ruleGroupsNamespaceProps: RuleGroupsNamespaceProps = { ... }
2380
+ ```
2381
+
2382
+ #### Properties <a name="Properties" id="Properties"></a>
2383
+
2384
+ | **Name** | **Type** | **Description** |
2385
+ | --- | --- | --- |
2386
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceProps.property.data">data</a></code> | <code>string</code> | The rules file used in the namespace. |
2387
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceProps.property.name">name</a></code> | <code>string</code> | The name of the rule groups namespace. |
2388
+ | <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceProps.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | The workspace to add the rule groups namespace. |
2389
+
2390
+ ---
2391
+
2392
+ ##### `data`<sup>Required</sup> <a name="data" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceProps.property.data"></a>
2393
+
2394
+ ```typescript
2395
+ public readonly data: string;
2396
+ ```
2397
+
2398
+ - *Type:* string
2399
+
2400
+ The rules file used in the namespace.
2401
+
2402
+ ---
2403
+
2404
+ ##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceProps.property.name"></a>
2405
+
2406
+ ```typescript
2407
+ public readonly name: string;
2408
+ ```
2409
+
2410
+ - *Type:* string
2411
+
2412
+ The name of the rule groups namespace.
2413
+
2414
+ Between 1 and 64 characters.
2415
+
2416
+ ---
2417
+
2418
+ ##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceProps.property.workspace"></a>
2419
+
2420
+ ```typescript
2421
+ public readonly workspace: IWorkspace;
2422
+ ```
2423
+
2424
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
2425
+
2426
+ The workspace to add the rule groups namespace.
2427
+
2428
+ ---
2429
+
2430
+ ### ScrapeConfiguration <a name="ScrapeConfiguration" id="@robhan-cdk-lib/aws_aps.ScrapeConfiguration"></a>
2431
+
2432
+ A scrape configuration for a scraper, base 64 encoded.
2433
+
2434
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.ScrapeConfiguration.Initializer"></a>
2435
+
2436
+ ```typescript
2437
+ import { ScrapeConfiguration } from '@robhan-cdk-lib/aws_aps'
2438
+
2439
+ const scrapeConfiguration: ScrapeConfiguration = { ... }
2440
+ ```
2441
+
2442
+ #### Properties <a name="Properties" id="Properties"></a>
2443
+
2444
+ | **Name** | **Type** | **Description** |
2445
+ | --- | --- | --- |
2446
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScrapeConfiguration.property.configurationBlob">configurationBlob</a></code> | <code>string</code> | The base 64 encoded scrape configuration file. |
2447
+
2448
+ ---
2449
+
2450
+ ##### `configurationBlob`<sup>Required</sup> <a name="configurationBlob" id="@robhan-cdk-lib/aws_aps.ScrapeConfiguration.property.configurationBlob"></a>
2451
+
2452
+ ```typescript
2453
+ public readonly configurationBlob: string;
2454
+ ```
2455
+
2456
+ - *Type:* string
2457
+
2458
+ The base 64 encoded scrape configuration file.
2459
+
2460
+ ---
2461
+
2462
+ ### ScraperAttributes <a name="ScraperAttributes" id="@robhan-cdk-lib/aws_aps.ScraperAttributes"></a>
2463
+
2464
+ Properties for importing an Amazon Managed Service for Prometheus Scraper from attributes.
2465
+
2466
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.ScraperAttributes.Initializer"></a>
2467
+
2468
+ ```typescript
2469
+ import { ScraperAttributes } from '@robhan-cdk-lib/aws_aps'
2470
+
2471
+ const scraperAttributes: ScraperAttributes = { ... }
2472
+ ```
2473
+
2474
+ #### Properties <a name="Properties" id="Properties"></a>
2475
+
2476
+ | **Name** | **Type** | **Description** |
2477
+ | --- | --- | --- |
2478
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperAttributes.property.destination">destination</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Destination">Destination</a></code> | The Amazon Managed Service for Prometheus workspace the scraper sends metrics to. |
2479
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperAttributes.property.scrapeConfiguration">scrapeConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.ScrapeConfiguration">ScrapeConfiguration</a></code> | The configuration in use by the scraper. |
2480
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperAttributes.property.scraperArn">scraperArn</a></code> | <code>string</code> | The ARN of the scraper. |
2481
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperAttributes.property.source">source</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Source">Source</a></code> | The Amazon EKS cluster from which the scraper collects metrics. |
2482
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperAttributes.property.alias">alias</a></code> | <code>string</code> | An optional user-assigned scraper alias. |
2483
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperAttributes.property.roleConfiguration">roleConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.RoleConfiguration">RoleConfiguration</a></code> | The role configuration in an Amazon Managed Service for Prometheus scraper. |
2484
+
2485
+ ---
2486
+
2487
+ ##### `destination`<sup>Required</sup> <a name="destination" id="@robhan-cdk-lib/aws_aps.ScraperAttributes.property.destination"></a>
2488
+
2489
+ ```typescript
2490
+ public readonly destination: Destination;
2491
+ ```
2492
+
2493
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.Destination">Destination</a>
2494
+
2495
+ The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
2496
+
2497
+ ---
2498
+
2499
+ ##### `scrapeConfiguration`<sup>Required</sup> <a name="scrapeConfiguration" id="@robhan-cdk-lib/aws_aps.ScraperAttributes.property.scrapeConfiguration"></a>
2500
+
2501
+ ```typescript
2502
+ public readonly scrapeConfiguration: ScrapeConfiguration;
2503
+ ```
2504
+
2505
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.ScrapeConfiguration">ScrapeConfiguration</a>
2506
+
2507
+ The configuration in use by the scraper.
2508
+
2509
+ ---
2510
+
2511
+ ##### `scraperArn`<sup>Required</sup> <a name="scraperArn" id="@robhan-cdk-lib/aws_aps.ScraperAttributes.property.scraperArn"></a>
2512
+
2513
+ ```typescript
2514
+ public readonly scraperArn: string;
2515
+ ```
2516
+
2517
+ - *Type:* string
2518
+
2519
+ The ARN of the scraper.
2520
+
2521
+ ---
2522
+
2523
+ ##### `source`<sup>Required</sup> <a name="source" id="@robhan-cdk-lib/aws_aps.ScraperAttributes.property.source"></a>
2524
+
2525
+ ```typescript
2526
+ public readonly source: Source;
2527
+ ```
2528
+
2529
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.Source">Source</a>
2530
+
2531
+ The Amazon EKS cluster from which the scraper collects metrics.
2532
+
2533
+ ---
2534
+
2535
+ ##### `alias`<sup>Optional</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.ScraperAttributes.property.alias"></a>
2536
+
2537
+ ```typescript
2538
+ public readonly alias: string;
2539
+ ```
2540
+
2541
+ - *Type:* string
2542
+
2543
+ An optional user-assigned scraper alias.
2544
+
2545
+ 1-100 characters.
2546
+
2547
+ Pattern: ^[0-9A-Za-z][-.0-9A-Z_a-z]*$
2548
+
2549
+ ---
2550
+
2551
+ ##### `roleConfiguration`<sup>Optional</sup> <a name="roleConfiguration" id="@robhan-cdk-lib/aws_aps.ScraperAttributes.property.roleConfiguration"></a>
2552
+
2553
+ ```typescript
2554
+ public readonly roleConfiguration: RoleConfiguration;
2555
+ ```
2556
+
2557
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.RoleConfiguration">RoleConfiguration</a>
2558
+
2559
+ The role configuration in an Amazon Managed Service for Prometheus scraper.
2560
+
2561
+ ---
2562
+
2563
+ ### ScraperProps <a name="ScraperProps" id="@robhan-cdk-lib/aws_aps.ScraperProps"></a>
2564
+
2565
+ Properties for creating an Amazon Managed Service for Prometheus Scraper.
2566
+
2567
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.ScraperProps.Initializer"></a>
2568
+
2569
+ ```typescript
2570
+ import { ScraperProps } from '@robhan-cdk-lib/aws_aps'
2571
+
2572
+ const scraperProps: ScraperProps = { ... }
2573
+ ```
2574
+
2575
+ #### Properties <a name="Properties" id="Properties"></a>
2576
+
2577
+ | **Name** | **Type** | **Description** |
2578
+ | --- | --- | --- |
2579
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperProps.property.destination">destination</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Destination">Destination</a></code> | The Amazon Managed Service for Prometheus workspace the scraper sends metrics to. |
2580
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperProps.property.scrapeConfiguration">scrapeConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.ScrapeConfiguration">ScrapeConfiguration</a></code> | The configuration in use by the scraper. |
2581
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperProps.property.source">source</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Source">Source</a></code> | The Amazon EKS cluster from which the scraper collects metrics. |
2582
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperProps.property.alias">alias</a></code> | <code>string</code> | An optional user-assigned scraper alias. |
2583
+ | <code><a href="#@robhan-cdk-lib/aws_aps.ScraperProps.property.roleConfiguration">roleConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.RoleConfiguration">RoleConfiguration</a></code> | The role configuration in an Amazon Managed Service for Prometheus scraper. |
2584
+
2585
+ ---
2586
+
2587
+ ##### `destination`<sup>Required</sup> <a name="destination" id="@robhan-cdk-lib/aws_aps.ScraperProps.property.destination"></a>
2588
+
2589
+ ```typescript
2590
+ public readonly destination: Destination;
2591
+ ```
2592
+
2593
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.Destination">Destination</a>
2594
+
2595
+ The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
2596
+
2597
+ ---
2598
+
2599
+ ##### `scrapeConfiguration`<sup>Required</sup> <a name="scrapeConfiguration" id="@robhan-cdk-lib/aws_aps.ScraperProps.property.scrapeConfiguration"></a>
2600
+
2601
+ ```typescript
2602
+ public readonly scrapeConfiguration: ScrapeConfiguration;
2603
+ ```
2604
+
2605
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.ScrapeConfiguration">ScrapeConfiguration</a>
2606
+
2607
+ The configuration in use by the scraper.
2608
+
2609
+ ---
2610
+
2611
+ ##### `source`<sup>Required</sup> <a name="source" id="@robhan-cdk-lib/aws_aps.ScraperProps.property.source"></a>
2612
+
2613
+ ```typescript
2614
+ public readonly source: Source;
2615
+ ```
2616
+
2617
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.Source">Source</a>
2618
+
2619
+ The Amazon EKS cluster from which the scraper collects metrics.
2620
+
2621
+ ---
2622
+
2623
+ ##### `alias`<sup>Optional</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.ScraperProps.property.alias"></a>
2624
+
2625
+ ```typescript
2626
+ public readonly alias: string;
2627
+ ```
2628
+
2629
+ - *Type:* string
2630
+
2631
+ An optional user-assigned scraper alias.
2632
+
2633
+ 1-100 characters.
2634
+
2635
+ Pattern: ^[0-9A-Za-z][-.0-9A-Z_a-z]*$
2636
+
2637
+ ---
2638
+
2639
+ ##### `roleConfiguration`<sup>Optional</sup> <a name="roleConfiguration" id="@robhan-cdk-lib/aws_aps.ScraperProps.property.roleConfiguration"></a>
2640
+
2641
+ ```typescript
2642
+ public readonly roleConfiguration: RoleConfiguration;
2643
+ ```
2644
+
2645
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.RoleConfiguration">RoleConfiguration</a>
2646
+
2647
+ The role configuration in an Amazon Managed Service for Prometheus scraper.
2648
+
2649
+ ---
2650
+
2651
+ ### Source <a name="Source" id="@robhan-cdk-lib/aws_aps.Source"></a>
2652
+
2653
+ The source of collected metrics for a scraper.
2654
+
2655
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.Source.Initializer"></a>
2656
+
2657
+ ```typescript
2658
+ import { Source } from '@robhan-cdk-lib/aws_aps'
2659
+
2660
+ const source: Source = { ... }
2661
+ ```
2662
+
2663
+ #### Properties <a name="Properties" id="Properties"></a>
2664
+
2665
+ | **Name** | **Type** | **Description** |
2666
+ | --- | --- | --- |
2667
+ | <code><a href="#@robhan-cdk-lib/aws_aps.Source.property.eksConfiguration">eksConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.EksConfiguration">EksConfiguration</a></code> | The Amazon EKS cluster from which a scraper collects metrics. |
2668
+
2669
+ ---
2670
+
2671
+ ##### `eksConfiguration`<sup>Required</sup> <a name="eksConfiguration" id="@robhan-cdk-lib/aws_aps.Source.property.eksConfiguration"></a>
2672
+
2673
+ ```typescript
2674
+ public readonly eksConfiguration: EksConfiguration;
2675
+ ```
2676
+
2677
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.EksConfiguration">EksConfiguration</a>
2678
+
2679
+ The Amazon EKS cluster from which a scraper collects metrics.
2680
+
2681
+ ---
2682
+
2683
+ ### WorkspaceAttributes <a name="WorkspaceAttributes" id="@robhan-cdk-lib/aws_aps.WorkspaceAttributes"></a>
2684
+
2685
+ Properties for importing an Amazon Managed Service for Prometheus Workspace from attributes.
2686
+
2687
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.WorkspaceAttributes.Initializer"></a>
2688
+
2689
+ ```typescript
2690
+ import { WorkspaceAttributes } from '@robhan-cdk-lib/aws_aps'
2691
+
2692
+ const workspaceAttributes: WorkspaceAttributes = { ... }
2693
+ ```
2694
+
2695
+ #### Properties <a name="Properties" id="Properties"></a>
2696
+
2697
+ | **Name** | **Type** | **Description** |
2698
+ | --- | --- | --- |
2699
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.workspaceArn">workspaceArn</a></code> | <code>string</code> | The arn of this workspace. |
2700
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.alertManagerDefinition">alertManagerDefinition</a></code> | <code>string</code> | The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace. |
2701
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.alias">alias</a></code> | <code>string</code> | The alias that is assigned to this workspace to help identify it. |
2702
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.kmsKey">kmsKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | The customer managed AWS KMS key to use for encrypting data within your workspace. |
2703
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.loggingConfiguration">loggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.LoggingConfiguration">LoggingConfiguration</a></code> | Contains information about the current rules and alerting logging configuration for the workspace. |
2704
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.queryLoggingConfiguration">queryLoggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration">QueryLoggingConfiguration</a></code> | The definition of logging configuration in an Amazon Managed Service for Prometheus workspace. |
2705
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.workspaceConfiguration">workspaceConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceConfiguration">WorkspaceConfiguration</a></code> | Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace. |
2706
+
2707
+ ---
2708
+
2709
+ ##### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.workspaceArn"></a>
2710
+
2711
+ ```typescript
2712
+ public readonly workspaceArn: string;
2713
+ ```
2714
+
2715
+ - *Type:* string
2716
+
2717
+ The arn of this workspace.
2718
+
2719
+ ---
2720
+
2721
+ ##### `alertManagerDefinition`<sup>Optional</sup> <a name="alertManagerDefinition" id="@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.alertManagerDefinition"></a>
2722
+
2723
+ ```typescript
2724
+ public readonly alertManagerDefinition: string;
2725
+ ```
2726
+
2727
+ - *Type:* string
2728
+
2729
+ The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace.
2730
+
2731
+ ---
2732
+
2733
+ ##### `alias`<sup>Optional</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.alias"></a>
2734
+
2735
+ ```typescript
2736
+ public readonly alias: string;
2737
+ ```
2738
+
2739
+ - *Type:* string
2740
+
2741
+ The alias that is assigned to this workspace to help identify it.
2742
+
2743
+ It does not need to be
2744
+ unique.
2745
+
2746
+ ---
2747
+
2748
+ ##### `kmsKey`<sup>Optional</sup> <a name="kmsKey" id="@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.kmsKey"></a>
2749
+
2750
+ ```typescript
2751
+ public readonly kmsKey: IKey;
2752
+ ```
2753
+
2754
+ - *Type:* aws-cdk-lib.aws_kms.IKey
2755
+
2756
+ The customer managed AWS KMS key to use for encrypting data within your workspace.
2757
+
2758
+ ---
2759
+
2760
+ ##### `loggingConfiguration`<sup>Optional</sup> <a name="loggingConfiguration" id="@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.loggingConfiguration"></a>
2761
+
2762
+ ```typescript
2763
+ public readonly loggingConfiguration: LoggingConfiguration;
2764
+ ```
2765
+
2766
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.LoggingConfiguration">LoggingConfiguration</a>
2767
+
2768
+ Contains information about the current rules and alerting logging configuration for the workspace.
2769
+
2770
+ Note: These logging configurations are only for rules and alerting logs.
2771
+
2772
+ ---
2773
+
2774
+ ##### `queryLoggingConfiguration`<sup>Optional</sup> <a name="queryLoggingConfiguration" id="@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.queryLoggingConfiguration"></a>
2775
+
2776
+ ```typescript
2777
+ public readonly queryLoggingConfiguration: QueryLoggingConfiguration;
2778
+ ```
2779
+
2780
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration">QueryLoggingConfiguration</a>
2781
+
2782
+ The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
2783
+
2784
+ ---
2785
+
2786
+ ##### `workspaceConfiguration`<sup>Optional</sup> <a name="workspaceConfiguration" id="@robhan-cdk-lib/aws_aps.WorkspaceAttributes.property.workspaceConfiguration"></a>
2787
+
2788
+ ```typescript
2789
+ public readonly workspaceConfiguration: WorkspaceConfiguration;
2790
+ ```
2791
+
2792
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.WorkspaceConfiguration">WorkspaceConfiguration</a>
2793
+
2794
+ Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace.
2795
+
2796
+ ---
2797
+
2798
+ ### WorkspaceConfiguration <a name="WorkspaceConfiguration" id="@robhan-cdk-lib/aws_aps.WorkspaceConfiguration"></a>
2799
+
2800
+ Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace.
2801
+
2802
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.WorkspaceConfiguration.Initializer"></a>
2803
+
2804
+ ```typescript
2805
+ import { WorkspaceConfiguration } from '@robhan-cdk-lib/aws_aps'
2806
+
2807
+ const workspaceConfiguration: WorkspaceConfiguration = { ... }
2808
+ ```
2809
+
2810
+ #### Properties <a name="Properties" id="Properties"></a>
2811
+
2812
+ | **Name** | **Type** | **Description** |
2813
+ | --- | --- | --- |
2814
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceConfiguration.property.limitsPerLabelSets">limitsPerLabelSets</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.LimitsPerLabelSet">LimitsPerLabelSet</a>[]</code> | This is an array of structures, where each structure defines a label set for the workspace, and defines the ingestion limit for active time series for each of those label sets. |
2815
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceConfiguration.property.retentionPeriodInDays">retentionPeriodInDays</a></code> | <code>number</code> | Specifies how many days that metrics will be retained in the workspace. |
2816
+
2817
+ ---
2818
+
2819
+ ##### `limitsPerLabelSets`<sup>Optional</sup> <a name="limitsPerLabelSets" id="@robhan-cdk-lib/aws_aps.WorkspaceConfiguration.property.limitsPerLabelSets"></a>
2820
+
2821
+ ```typescript
2822
+ public readonly limitsPerLabelSets: LimitsPerLabelSet[];
2823
+ ```
2824
+
2825
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.LimitsPerLabelSet">LimitsPerLabelSet</a>[]
2826
+
2827
+ This is an array of structures, where each structure defines a label set for the workspace, and defines the ingestion limit for active time series for each of those label sets.
2828
+
2829
+ Each
2830
+ label name in a label set must be unique.
2831
+
2832
+ Minimum 0
2833
+
2834
+ ---
2835
+
2836
+ ##### `retentionPeriodInDays`<sup>Optional</sup> <a name="retentionPeriodInDays" id="@robhan-cdk-lib/aws_aps.WorkspaceConfiguration.property.retentionPeriodInDays"></a>
2837
+
2838
+ ```typescript
2839
+ public readonly retentionPeriodInDays: number;
2840
+ ```
2841
+
2842
+ - *Type:* number
2843
+
2844
+ Specifies how many days that metrics will be retained in the workspace.
2845
+
2846
+ Minimum 1
2847
+
2848
+ ---
2849
+
2850
+ ### WorkspaceProps <a name="WorkspaceProps" id="@robhan-cdk-lib/aws_aps.WorkspaceProps"></a>
2851
+
2852
+ Properties for creating an Amazon Managed Service for Prometheus Workspace.
2853
+
2854
+ #### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.WorkspaceProps.Initializer"></a>
2855
+
2856
+ ```typescript
2857
+ import { WorkspaceProps } from '@robhan-cdk-lib/aws_aps'
2858
+
2859
+ const workspaceProps: WorkspaceProps = { ... }
2860
+ ```
2861
+
2862
+ #### Properties <a name="Properties" id="Properties"></a>
2863
+
2864
+ | **Name** | **Type** | **Description** |
2865
+ | --- | --- | --- |
2866
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceProps.property.alertManagerDefinition">alertManagerDefinition</a></code> | <code>string</code> | The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace. |
2867
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceProps.property.alias">alias</a></code> | <code>string</code> | The alias that is assigned to this workspace to help identify it. It does not need to be unique. |
2868
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceProps.property.kmsKey">kmsKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | The customer managed AWS KMS key to use for encrypting data within your workspace. |
2869
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceProps.property.loggingConfiguration">loggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.LoggingConfiguration">LoggingConfiguration</a></code> | Contains information about the current rules and alerting logging configuration for the workspace. |
2870
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceProps.property.queryLoggingConfiguration">queryLoggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration">QueryLoggingConfiguration</a></code> | The definition of logging configuration in an Amazon Managed Service for Prometheus workspace. |
2871
+ | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceProps.property.workspaceConfiguration">workspaceConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceConfiguration">WorkspaceConfiguration</a></code> | Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace. |
2872
+
2873
+ ---
2874
+
2875
+ ##### `alertManagerDefinition`<sup>Optional</sup> <a name="alertManagerDefinition" id="@robhan-cdk-lib/aws_aps.WorkspaceProps.property.alertManagerDefinition"></a>
2876
+
2877
+ ```typescript
2878
+ public readonly alertManagerDefinition: string;
2879
+ ```
2880
+
2881
+ - *Type:* string
2882
+
2883
+ The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace.
2884
+
2885
+ ---
2886
+
2887
+ ##### `alias`<sup>Optional</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.WorkspaceProps.property.alias"></a>
2888
+
2889
+ ```typescript
2890
+ public readonly alias: string;
2891
+ ```
2892
+
2893
+ - *Type:* string
2894
+
2895
+ The alias that is assigned to this workspace to help identify it. It does not need to be unique.
2896
+
2897
+ 0 to 100 characters
2898
+
2899
+ ---
2900
+
2901
+ ##### `kmsKey`<sup>Optional</sup> <a name="kmsKey" id="@robhan-cdk-lib/aws_aps.WorkspaceProps.property.kmsKey"></a>
2902
+
2903
+ ```typescript
2904
+ public readonly kmsKey: IKey;
2905
+ ```
2906
+
2907
+ - *Type:* aws-cdk-lib.aws_kms.IKey
2908
+
2909
+ The customer managed AWS KMS key to use for encrypting data within your workspace.
2910
+
2911
+ ---
2912
+
2913
+ ##### `loggingConfiguration`<sup>Optional</sup> <a name="loggingConfiguration" id="@robhan-cdk-lib/aws_aps.WorkspaceProps.property.loggingConfiguration"></a>
2914
+
2915
+ ```typescript
2916
+ public readonly loggingConfiguration: LoggingConfiguration;
2917
+ ```
2918
+
2919
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.LoggingConfiguration">LoggingConfiguration</a>
2920
+
2921
+ Contains information about the current rules and alerting logging configuration for the workspace.
2922
+
2923
+ Note: These logging configurations are only for rules and alerting logs.
2924
+
2925
+ ---
2926
+
2927
+ ##### `queryLoggingConfiguration`<sup>Optional</sup> <a name="queryLoggingConfiguration" id="@robhan-cdk-lib/aws_aps.WorkspaceProps.property.queryLoggingConfiguration"></a>
2928
+
2929
+ ```typescript
2930
+ public readonly queryLoggingConfiguration: QueryLoggingConfiguration;
2931
+ ```
2932
+
2933
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration">QueryLoggingConfiguration</a>
2934
+
2935
+ The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
2936
+
2937
+ ---
2938
+
2939
+ ##### `workspaceConfiguration`<sup>Optional</sup> <a name="workspaceConfiguration" id="@robhan-cdk-lib/aws_aps.WorkspaceProps.property.workspaceConfiguration"></a>
2940
+
2941
+ ```typescript
2942
+ public readonly workspaceConfiguration: WorkspaceConfiguration;
2943
+ ```
2944
+
2945
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.WorkspaceConfiguration">WorkspaceConfiguration</a>
2946
+
2947
+ Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace.
2948
+
2949
+ ---
2950
+
2951
+
2952
+ ## Protocols <a name="Protocols" id="Protocols"></a>
2953
+
2954
+ ### IRuleGroupsNamespace <a name="IRuleGroupsNamespace" id="@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace"></a>
2955
+
2956
+ - *Extends:* aws-cdk-lib.IResource
2957
+
2958
+ - *Implemented By:* <a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace">RuleGroupsNamespace</a>, <a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase">RuleGroupsNamespaceBase</a>, <a href="#@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace">IRuleGroupsNamespace</a>
2959
+
2960
+
2961
+ #### Properties <a name="Properties" id="Properties"></a>
2962
+
2963
+ | **Name** | **Type** | **Description** |
2964
+ | --- | --- | --- |
2965
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
2966
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
2967
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
2968
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.data">data</a></code> | <code>string</code> | The rules file used in the namespace. |
2969
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.name">name</a></code> | <code>string</code> | The name of the rule groups namespace. |
2970
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.ruleGroupsNamespaceArn">ruleGroupsNamespaceArn</a></code> | <code>string</code> | The ARN of the rule groups namespace. |
2971
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | The workspace to add the rule groups namespace. |
2972
+
2973
+ ---
2974
+
2975
+ ##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.node"></a>
2976
+
2977
+ ```typescript
2978
+ public readonly node: Node;
2979
+ ```
2980
+
2981
+ - *Type:* constructs.Node
2982
+
2983
+ The tree node.
2984
+
2985
+ ---
2986
+
2987
+ ##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.env"></a>
2988
+
2989
+ ```typescript
2990
+ public readonly env: ResourceEnvironment;
2991
+ ```
2992
+
2993
+ - *Type:* aws-cdk-lib.ResourceEnvironment
2994
+
2995
+ The environment this resource belongs to.
2996
+
2997
+ For resources that are created and managed by the CDK
2998
+ (generally, those created by creating new class instances like Role, Bucket, etc.),
2999
+ this is always the same as the environment of the stack they belong to;
3000
+ however, for imported resources
3001
+ (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
3002
+ that might be different than the stack they were imported into.
3003
+
3004
+ ---
3005
+
3006
+ ##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.stack"></a>
3007
+
3008
+ ```typescript
3009
+ public readonly stack: Stack;
3010
+ ```
3011
+
3012
+ - *Type:* aws-cdk-lib.Stack
3013
+
3014
+ The stack in which this resource is defined.
3015
+
3016
+ ---
3017
+
3018
+ ##### `data`<sup>Required</sup> <a name="data" id="@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.data"></a>
3019
+
3020
+ ```typescript
3021
+ public readonly data: string;
3022
+ ```
3023
+
3024
+ - *Type:* string
3025
+
3026
+ The rules file used in the namespace.
3027
+
3028
+ ---
3029
+
3030
+ ##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.name"></a>
3031
+
3032
+ ```typescript
3033
+ public readonly name: string;
3034
+ ```
3035
+
3036
+ - *Type:* string
3037
+
3038
+ The name of the rule groups namespace.
3039
+
3040
+ ---
3041
+
3042
+ ##### `ruleGroupsNamespaceArn`<sup>Required</sup> <a name="ruleGroupsNamespaceArn" id="@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.ruleGroupsNamespaceArn"></a>
3043
+
3044
+ ```typescript
3045
+ public readonly ruleGroupsNamespaceArn: string;
3046
+ ```
3047
+
3048
+ - *Type:* string
3049
+
3050
+ The ARN of the rule groups namespace.
3051
+
3052
+ ---
3053
+
3054
+ ##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace.property.workspace"></a>
3055
+
3056
+ ```typescript
3057
+ public readonly workspace: IWorkspace;
3058
+ ```
3059
+
3060
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
3061
+
3062
+ The workspace to add the rule groups namespace.
3063
+
3064
+ ---
3065
+
3066
+ ### IScraper <a name="IScraper" id="@robhan-cdk-lib/aws_aps.IScraper"></a>
3067
+
3068
+ - *Extends:* aws-cdk-lib.IResource
3069
+
3070
+ - *Implemented By:* <a href="#@robhan-cdk-lib/aws_aps.Scraper">Scraper</a>, <a href="#@robhan-cdk-lib/aws_aps.ScraperBase">ScraperBase</a>, <a href="#@robhan-cdk-lib/aws_aps.IScraper">IScraper</a>
3071
+
3072
+
3073
+ #### Properties <a name="Properties" id="Properties"></a>
3074
+
3075
+ | **Name** | **Type** | **Description** |
3076
+ | --- | --- | --- |
3077
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IScraper.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
3078
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IScraper.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
3079
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IScraper.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
3080
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IScraper.property.destination">destination</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Destination">Destination</a></code> | The Amazon Managed Service for Prometheus workspace the scraper sends metrics to. |
3081
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IScraper.property.scrapeConfiguration">scrapeConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.ScrapeConfiguration">ScrapeConfiguration</a></code> | The configuration in use by the scraper. |
3082
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IScraper.property.scraperArn">scraperArn</a></code> | <code>string</code> | The ARN of the scraper. |
3083
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IScraper.property.scraperId">scraperId</a></code> | <code>string</code> | The ID of the scraper. |
3084
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IScraper.property.source">source</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Source">Source</a></code> | The Amazon EKS cluster from which the scraper collects metrics. |
3085
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IScraper.property.alias">alias</a></code> | <code>string</code> | An optional user-assigned scraper alias. |
3086
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IScraper.property.roleConfiguration">roleConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.RoleConfiguration">RoleConfiguration</a></code> | The role configuration in an Amazon Managed Service for Prometheus scraper. |
3087
+
3088
+ ---
3089
+
3090
+ ##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.IScraper.property.node"></a>
3091
+
3092
+ ```typescript
3093
+ public readonly node: Node;
3094
+ ```
3095
+
3096
+ - *Type:* constructs.Node
3097
+
3098
+ The tree node.
3099
+
3100
+ ---
3101
+
3102
+ ##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.IScraper.property.env"></a>
3103
+
3104
+ ```typescript
3105
+ public readonly env: ResourceEnvironment;
3106
+ ```
3107
+
3108
+ - *Type:* aws-cdk-lib.ResourceEnvironment
3109
+
3110
+ The environment this resource belongs to.
3111
+
3112
+ For resources that are created and managed by the CDK
3113
+ (generally, those created by creating new class instances like Role, Bucket, etc.),
3114
+ this is always the same as the environment of the stack they belong to;
3115
+ however, for imported resources
3116
+ (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
3117
+ that might be different than the stack they were imported into.
3118
+
3119
+ ---
3120
+
3121
+ ##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.IScraper.property.stack"></a>
3122
+
3123
+ ```typescript
3124
+ public readonly stack: Stack;
3125
+ ```
3126
+
3127
+ - *Type:* aws-cdk-lib.Stack
3128
+
3129
+ The stack in which this resource is defined.
3130
+
3131
+ ---
3132
+
3133
+ ##### `destination`<sup>Required</sup> <a name="destination" id="@robhan-cdk-lib/aws_aps.IScraper.property.destination"></a>
3134
+
3135
+ ```typescript
3136
+ public readonly destination: Destination;
3137
+ ```
3138
+
3139
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.Destination">Destination</a>
3140
+
3141
+ The Amazon Managed Service for Prometheus workspace the scraper sends metrics to.
3142
+
3143
+ ---
3144
+
3145
+ ##### `scrapeConfiguration`<sup>Required</sup> <a name="scrapeConfiguration" id="@robhan-cdk-lib/aws_aps.IScraper.property.scrapeConfiguration"></a>
3146
+
3147
+ ```typescript
3148
+ public readonly scrapeConfiguration: ScrapeConfiguration;
3149
+ ```
3150
+
3151
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.ScrapeConfiguration">ScrapeConfiguration</a>
3152
+
3153
+ The configuration in use by the scraper.
3154
+
3155
+ ---
3156
+
3157
+ ##### `scraperArn`<sup>Required</sup> <a name="scraperArn" id="@robhan-cdk-lib/aws_aps.IScraper.property.scraperArn"></a>
3158
+
3159
+ ```typescript
3160
+ public readonly scraperArn: string;
3161
+ ```
3162
+
3163
+ - *Type:* string
3164
+
3165
+ The ARN of the scraper.
3166
+
3167
+ ---
3168
+
3169
+ ##### `scraperId`<sup>Required</sup> <a name="scraperId" id="@robhan-cdk-lib/aws_aps.IScraper.property.scraperId"></a>
3170
+
3171
+ ```typescript
3172
+ public readonly scraperId: string;
3173
+ ```
3174
+
3175
+ - *Type:* string
3176
+
3177
+ The ID of the scraper.
3178
+
3179
+ ---
3180
+
3181
+ ##### `source`<sup>Required</sup> <a name="source" id="@robhan-cdk-lib/aws_aps.IScraper.property.source"></a>
3182
+
3183
+ ```typescript
3184
+ public readonly source: Source;
3185
+ ```
3186
+
3187
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.Source">Source</a>
3188
+
3189
+ The Amazon EKS cluster from which the scraper collects metrics.
3190
+
3191
+ ---
3192
+
3193
+ ##### `alias`<sup>Optional</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.IScraper.property.alias"></a>
3194
+
3195
+ ```typescript
3196
+ public readonly alias: string;
3197
+ ```
3198
+
3199
+ - *Type:* string
3200
+
3201
+ An optional user-assigned scraper alias.
3202
+
3203
+ 1-100 characters.
3204
+
3205
+ Pattern: ^[0-9A-Za-z][-.0-9A-Z_a-z]*$
3206
+
3207
+ ---
3208
+
3209
+ ##### `roleConfiguration`<sup>Optional</sup> <a name="roleConfiguration" id="@robhan-cdk-lib/aws_aps.IScraper.property.roleConfiguration"></a>
3210
+
3211
+ ```typescript
3212
+ public readonly roleConfiguration: RoleConfiguration;
3213
+ ```
3214
+
3215
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.RoleConfiguration">RoleConfiguration</a>
3216
+
3217
+ The role configuration in an Amazon Managed Service for Prometheus scraper.
3218
+
3219
+ ---
3220
+
3221
+ ### IWorkspace <a name="IWorkspace" id="@robhan-cdk-lib/aws_aps.IWorkspace"></a>
3222
+
3223
+ - *Extends:* aws-cdk-lib.IResource
3224
+
3225
+ - *Implemented By:* <a href="#@robhan-cdk-lib/aws_aps.Workspace">Workspace</a>, <a href="#@robhan-cdk-lib/aws_aps.WorkspaceBase">WorkspaceBase</a>, <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
3226
+
3227
+
3228
+ #### Properties <a name="Properties" id="Properties"></a>
3229
+
3230
+ | **Name** | **Type** | **Description** |
3231
+ | --- | --- | --- |
3232
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
3233
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace.property.env">env</a></code> | <code>aws-cdk-lib.ResourceEnvironment</code> | The environment this resource belongs to. |
3234
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
3235
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace.property.workspaceArn">workspaceArn</a></code> | <code>string</code> | The ARN of the workspace. |
3236
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace.property.workspaceId">workspaceId</a></code> | <code>string</code> | The unique ID for the workspace. |
3237
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace.property.alertManagerDefinition">alertManagerDefinition</a></code> | <code>string</code> | The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace. |
3238
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace.property.alias">alias</a></code> | <code>string</code> | The alias that is assigned to this workspace to help identify it. |
3239
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace.property.kmsKey">kmsKey</a></code> | <code>aws-cdk-lib.aws_kms.IKey</code> | The customer managed AWS KMS key to use for encrypting data within your workspace. |
3240
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace.property.loggingConfiguration">loggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.LoggingConfiguration">LoggingConfiguration</a></code> | Contains information about the current rules and alerting logging configuration for the workspace. |
3241
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace.property.queryLoggingConfiguration">queryLoggingConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration">QueryLoggingConfiguration</a></code> | The definition of logging configuration in an Amazon Managed Service for Prometheus workspace. |
3242
+ | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace.property.workspaceConfiguration">workspaceConfiguration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.WorkspaceConfiguration">WorkspaceConfiguration</a></code> | Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace. |
3243
+
3244
+ ---
3245
+
3246
+ ##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.IWorkspace.property.node"></a>
3247
+
3248
+ ```typescript
3249
+ public readonly node: Node;
3250
+ ```
3251
+
3252
+ - *Type:* constructs.Node
3253
+
3254
+ The tree node.
3255
+
3256
+ ---
3257
+
3258
+ ##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.IWorkspace.property.env"></a>
3259
+
3260
+ ```typescript
3261
+ public readonly env: ResourceEnvironment;
3262
+ ```
3263
+
3264
+ - *Type:* aws-cdk-lib.ResourceEnvironment
3265
+
3266
+ The environment this resource belongs to.
3267
+
3268
+ For resources that are created and managed by the CDK
3269
+ (generally, those created by creating new class instances like Role, Bucket, etc.),
3270
+ this is always the same as the environment of the stack they belong to;
3271
+ however, for imported resources
3272
+ (those obtained from static methods like fromRoleArn, fromBucketName, etc.),
3273
+ that might be different than the stack they were imported into.
3274
+
3275
+ ---
3276
+
3277
+ ##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.IWorkspace.property.stack"></a>
3278
+
3279
+ ```typescript
3280
+ public readonly stack: Stack;
3281
+ ```
3282
+
3283
+ - *Type:* aws-cdk-lib.Stack
3284
+
3285
+ The stack in which this resource is defined.
3286
+
3287
+ ---
3288
+
3289
+ ##### `workspaceArn`<sup>Required</sup> <a name="workspaceArn" id="@robhan-cdk-lib/aws_aps.IWorkspace.property.workspaceArn"></a>
3290
+
3291
+ ```typescript
3292
+ public readonly workspaceArn: string;
3293
+ ```
3294
+
3295
+ - *Type:* string
3296
+
3297
+ The ARN of the workspace.
3298
+
3299
+ ---
3300
+
3301
+ ##### `workspaceId`<sup>Required</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_aps.IWorkspace.property.workspaceId"></a>
3302
+
3303
+ ```typescript
3304
+ public readonly workspaceId: string;
3305
+ ```
3306
+
3307
+ - *Type:* string
3308
+
3309
+ The unique ID for the workspace.
3310
+
3311
+ ---
3312
+
3313
+ ##### `alertManagerDefinition`<sup>Optional</sup> <a name="alertManagerDefinition" id="@robhan-cdk-lib/aws_aps.IWorkspace.property.alertManagerDefinition"></a>
3314
+
3315
+ ```typescript
3316
+ public readonly alertManagerDefinition: string;
3317
+ ```
3318
+
3319
+ - *Type:* string
3320
+
3321
+ The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace.
3322
+
3323
+ ---
3324
+
3325
+ ##### `alias`<sup>Optional</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.IWorkspace.property.alias"></a>
3326
+
3327
+ ```typescript
3328
+ public readonly alias: string;
3329
+ ```
3330
+
3331
+ - *Type:* string
3332
+
3333
+ The alias that is assigned to this workspace to help identify it.
3334
+
3335
+ It does not need to be
3336
+ unique.
3337
+
3338
+ ---
3339
+
3340
+ ##### `kmsKey`<sup>Optional</sup> <a name="kmsKey" id="@robhan-cdk-lib/aws_aps.IWorkspace.property.kmsKey"></a>
3341
+
3342
+ ```typescript
3343
+ public readonly kmsKey: IKey;
3344
+ ```
3345
+
3346
+ - *Type:* aws-cdk-lib.aws_kms.IKey
3347
+
3348
+ The customer managed AWS KMS key to use for encrypting data within your workspace.
3349
+
3350
+ ---
3351
+
3352
+ ##### `loggingConfiguration`<sup>Optional</sup> <a name="loggingConfiguration" id="@robhan-cdk-lib/aws_aps.IWorkspace.property.loggingConfiguration"></a>
3353
+
3354
+ ```typescript
3355
+ public readonly loggingConfiguration: LoggingConfiguration;
3356
+ ```
3357
+
3358
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.LoggingConfiguration">LoggingConfiguration</a>
3359
+
3360
+ Contains information about the current rules and alerting logging configuration for the workspace.
3361
+
3362
+ Note: These logging configurations are only for rules and alerting logs.
3363
+
3364
+ ---
3365
+
3366
+ ##### `queryLoggingConfiguration`<sup>Optional</sup> <a name="queryLoggingConfiguration" id="@robhan-cdk-lib/aws_aps.IWorkspace.property.queryLoggingConfiguration"></a>
3367
+
3368
+ ```typescript
3369
+ public readonly queryLoggingConfiguration: QueryLoggingConfiguration;
3370
+ ```
3371
+
3372
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration">QueryLoggingConfiguration</a>
3373
+
3374
+ The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
3375
+
3376
+ ---
3377
+
3378
+ ##### `workspaceConfiguration`<sup>Optional</sup> <a name="workspaceConfiguration" id="@robhan-cdk-lib/aws_aps.IWorkspace.property.workspaceConfiguration"></a>
3379
+
3380
+ ```typescript
3381
+ public readonly workspaceConfiguration: WorkspaceConfiguration;
3382
+ ```
3383
+
3384
+ - *Type:* <a href="#@robhan-cdk-lib/aws_aps.WorkspaceConfiguration">WorkspaceConfiguration</a>
3385
+
3386
+ Use this structure to define label sets and the ingestion limits for time series that match label sets, and to specify the retention period of the workspace.
3387
+
3388
+ ---
3389
+