@robhan-cdk-lib/aws_aps 0.0.143 → 0.0.145
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/.jsii +1613 -431
- package/API.md +1999 -277
- package/LICENSE +1 -1
- package/lib/anomaly-detector-base.d.ts +163 -0
- package/lib/anomaly-detector-base.js +12 -0
- package/lib/anomaly-detector.d.ts +95 -0
- package/lib/anomaly-detector.js +83 -0
- package/lib/index.d.ts +4 -0
- package/lib/index.js +7 -1
- package/lib/resource-policy-base.d.ts +22 -0
- package/lib/resource-policy-base.js +12 -0
- package/lib/resource-policy.d.ts +42 -0
- package/lib/resource-policy.js +56 -0
- package/lib/rule-groups-namespace-base.js +1 -1
- package/lib/rule-groups-namespace.js +1 -1
- package/lib/scraper-base.js +1 -1
- package/lib/scraper.js +1 -1
- package/lib/validation/anomaly-detector-base.d.ts +5 -0
- package/lib/validation/anomaly-detector-base.js +171 -0
- package/lib/workspace-base.js +1 -1
- package/lib/workspace.js +1 -1
- package/package.json +5 -5
package/API.md
CHANGED
|
@@ -2,44 +2,39 @@
|
|
|
2
2
|
|
|
3
3
|
## Constructs <a name="Constructs" id="Constructs"></a>
|
|
4
4
|
|
|
5
|
-
###
|
|
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.
|
|
5
|
+
### AnomalyDetector <a name="AnomalyDetector" id="@robhan-cdk-lib/aws_aps.AnomalyDetector"></a>
|
|
11
6
|
|
|
12
|
-
#### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.
|
|
7
|
+
#### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.Initializer"></a>
|
|
13
8
|
|
|
14
9
|
```typescript
|
|
15
|
-
import {
|
|
10
|
+
import { AnomalyDetector } from '@robhan-cdk-lib/aws_aps'
|
|
16
11
|
|
|
17
|
-
new
|
|
12
|
+
new AnomalyDetector(scope: Construct, id: string, props: AnomalyDetectorProps)
|
|
18
13
|
```
|
|
19
14
|
|
|
20
15
|
| **Name** | **Type** | **Description** |
|
|
21
16
|
| --- | --- | --- |
|
|
22
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
23
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
24
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
17
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
18
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
19
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.Initializer.parameter.props">props</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorProps">AnomalyDetectorProps</a></code> | *No description.* |
|
|
25
20
|
|
|
26
21
|
---
|
|
27
22
|
|
|
28
|
-
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.
|
|
23
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.Initializer.parameter.scope"></a>
|
|
29
24
|
|
|
30
25
|
- *Type:* constructs.Construct
|
|
31
26
|
|
|
32
27
|
---
|
|
33
28
|
|
|
34
|
-
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.
|
|
29
|
+
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.Initializer.parameter.id"></a>
|
|
35
30
|
|
|
36
31
|
- *Type:* string
|
|
37
32
|
|
|
38
33
|
---
|
|
39
34
|
|
|
40
|
-
##### `props`<sup>Required</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.
|
|
35
|
+
##### `props`<sup>Required</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.Initializer.parameter.props"></a>
|
|
41
36
|
|
|
42
|
-
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.
|
|
37
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorProps">AnomalyDetectorProps</a>
|
|
43
38
|
|
|
44
39
|
---
|
|
45
40
|
|
|
@@ -47,12 +42,12 @@ new RuleGroupsNamespace(scope: Construct, id: string, props: RuleGroupsNamespace
|
|
|
47
42
|
|
|
48
43
|
| **Name** | **Description** |
|
|
49
44
|
| --- | --- |
|
|
50
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
51
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
45
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
46
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
52
47
|
|
|
53
48
|
---
|
|
54
49
|
|
|
55
|
-
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.
|
|
50
|
+
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.toString"></a>
|
|
56
51
|
|
|
57
52
|
```typescript
|
|
58
53
|
public toString(): string
|
|
@@ -60,7 +55,7 @@ public toString(): string
|
|
|
60
55
|
|
|
61
56
|
Returns a string representation of this construct.
|
|
62
57
|
|
|
63
|
-
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.
|
|
58
|
+
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.applyRemovalPolicy"></a>
|
|
64
59
|
|
|
65
60
|
```typescript
|
|
66
61
|
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
@@ -76,7 +71,7 @@ to be replaced.
|
|
|
76
71
|
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
77
72
|
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
78
73
|
|
|
79
|
-
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.
|
|
74
|
+
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.applyRemovalPolicy.parameter.policy"></a>
|
|
80
75
|
|
|
81
76
|
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
82
77
|
|
|
@@ -86,20 +81,19 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
|
86
81
|
|
|
87
82
|
| **Name** | **Description** |
|
|
88
83
|
| --- | --- |
|
|
89
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
90
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
91
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
92
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
93
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isRuleGroupsNamespace">isRuleGroupsNamespace</a></code> | *No description.* |
|
|
84
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
85
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
|
|
86
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
87
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.isAnomalyDetector">isAnomalyDetector</a></code> | *No description.* |
|
|
94
88
|
|
|
95
89
|
---
|
|
96
90
|
|
|
97
|
-
##### `isConstruct` <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.
|
|
91
|
+
##### `isConstruct` <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.isConstruct"></a>
|
|
98
92
|
|
|
99
93
|
```typescript
|
|
100
|
-
import {
|
|
94
|
+
import { AnomalyDetector } from '@robhan-cdk-lib/aws_aps'
|
|
101
95
|
|
|
102
|
-
|
|
96
|
+
AnomalyDetector.isConstruct(x: any)
|
|
103
97
|
```
|
|
104
98
|
|
|
105
99
|
Checks if `x` is a construct.
|
|
@@ -118,7 +112,7 @@ library can be accidentally installed, and `instanceof` will behave
|
|
|
118
112
|
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
119
113
|
this type-testing method instead.
|
|
120
114
|
|
|
121
|
-
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.
|
|
115
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.isConstruct.parameter.x"></a>
|
|
122
116
|
|
|
123
117
|
- *Type:* any
|
|
124
118
|
|
|
@@ -126,73 +120,47 @@ Any object.
|
|
|
126
120
|
|
|
127
121
|
---
|
|
128
122
|
|
|
129
|
-
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.
|
|
123
|
+
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.isOwnedResource"></a>
|
|
130
124
|
|
|
131
125
|
```typescript
|
|
132
|
-
import {
|
|
126
|
+
import { AnomalyDetector } from '@robhan-cdk-lib/aws_aps'
|
|
133
127
|
|
|
134
|
-
|
|
128
|
+
AnomalyDetector.isOwnedResource(construct: IConstruct)
|
|
135
129
|
```
|
|
136
130
|
|
|
137
131
|
Returns true if the construct was created by CDK, and false otherwise.
|
|
138
132
|
|
|
139
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.
|
|
133
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.isOwnedResource.parameter.construct"></a>
|
|
140
134
|
|
|
141
135
|
- *Type:* constructs.IConstruct
|
|
142
136
|
|
|
143
137
|
---
|
|
144
138
|
|
|
145
|
-
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.
|
|
139
|
+
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.isResource"></a>
|
|
146
140
|
|
|
147
141
|
```typescript
|
|
148
|
-
import {
|
|
142
|
+
import { AnomalyDetector } from '@robhan-cdk-lib/aws_aps'
|
|
149
143
|
|
|
150
|
-
|
|
144
|
+
AnomalyDetector.isResource(construct: IConstruct)
|
|
151
145
|
```
|
|
152
146
|
|
|
153
147
|
Check whether the given construct is a Resource.
|
|
154
148
|
|
|
155
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.
|
|
149
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.isResource.parameter.construct"></a>
|
|
156
150
|
|
|
157
151
|
- *Type:* constructs.IConstruct
|
|
158
152
|
|
|
159
153
|
---
|
|
160
154
|
|
|
161
|
-
##### `
|
|
162
|
-
|
|
163
|
-
```typescript
|
|
164
|
-
import { RuleGroupsNamespace } from '@robhan-cdk-lib/aws_aps'
|
|
165
|
-
|
|
166
|
-
RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes(scope: Construct, id: string, attrs: RuleGroupsNamespaceAttributes)
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
###### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes.parameter.scope"></a>
|
|
170
|
-
|
|
171
|
-
- *Type:* constructs.Construct
|
|
172
|
-
|
|
173
|
-
---
|
|
174
|
-
|
|
175
|
-
###### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes.parameter.id"></a>
|
|
176
|
-
|
|
177
|
-
- *Type:* string
|
|
178
|
-
|
|
179
|
-
---
|
|
180
|
-
|
|
181
|
-
###### `attrs`<sup>Required</sup> <a name="attrs" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes.parameter.attrs"></a>
|
|
182
|
-
|
|
183
|
-
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceAttributes">RuleGroupsNamespaceAttributes</a>
|
|
184
|
-
|
|
185
|
-
---
|
|
186
|
-
|
|
187
|
-
##### `isRuleGroupsNamespace` <a name="isRuleGroupsNamespace" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isRuleGroupsNamespace"></a>
|
|
155
|
+
##### `isAnomalyDetector` <a name="isAnomalyDetector" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.isAnomalyDetector"></a>
|
|
188
156
|
|
|
189
157
|
```typescript
|
|
190
|
-
import {
|
|
158
|
+
import { AnomalyDetector } from '@robhan-cdk-lib/aws_aps'
|
|
191
159
|
|
|
192
|
-
|
|
160
|
+
AnomalyDetector.isAnomalyDetector(x: any)
|
|
193
161
|
```
|
|
194
162
|
|
|
195
|
-
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.
|
|
163
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.isAnomalyDetector.parameter.x"></a>
|
|
196
164
|
|
|
197
165
|
- *Type:* any
|
|
198
166
|
|
|
@@ -202,17 +170,20 @@ RuleGroupsNamespace.isRuleGroupsNamespace(x: any)
|
|
|
202
170
|
|
|
203
171
|
| **Name** | **Type** | **Description** |
|
|
204
172
|
| --- | --- | --- |
|
|
205
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
206
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
207
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
208
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
209
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
210
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
211
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
173
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
174
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
175
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
176
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.property.alias">alias</a></code> | <code>string</code> | The user-friendly name of the anomaly detector. 1 to 64 characters length. |
|
|
177
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.property.anomalyDetectorArn">anomalyDetectorArn</a></code> | <code>string</code> | The Amazon Resource Name (ARN) of the anomaly detector. |
|
|
178
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.property.configuration">configuration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorConfiguration">AnomalyDetectorConfiguration</a></code> | The algorithm configuration of the anomaly detector. |
|
|
179
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics. |
|
|
180
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.property.evaluationIntervalInSeconds">evaluationIntervalInSeconds</a></code> | <code>number</code> | The frequency, in seconds, at which the anomaly detector evaluates metrics. |
|
|
181
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.property.labels">labels</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Label">Label</a>[]</code> | The Amazon Managed Service for Prometheus metric labels associated with the anomaly detector. |
|
|
182
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector.property.missingDataAction">missingDataAction</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.MissingDataAction">MissingDataAction</a></code> | The action taken when data is missing during evaluation. |
|
|
212
183
|
|
|
213
184
|
---
|
|
214
185
|
|
|
215
|
-
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.
|
|
186
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.property.node"></a>
|
|
216
187
|
|
|
217
188
|
```typescript
|
|
218
189
|
public readonly node: Node;
|
|
@@ -224,7 +195,7 @@ The tree node.
|
|
|
224
195
|
|
|
225
196
|
---
|
|
226
197
|
|
|
227
|
-
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.
|
|
198
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.property.env"></a>
|
|
228
199
|
|
|
229
200
|
```typescript
|
|
230
201
|
public readonly env: ResourceEnvironment;
|
|
@@ -244,7 +215,7 @@ different than the stack they were imported into.
|
|
|
244
215
|
|
|
245
216
|
---
|
|
246
217
|
|
|
247
|
-
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.
|
|
218
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.property.stack"></a>
|
|
248
219
|
|
|
249
220
|
```typescript
|
|
250
221
|
public readonly stack: Stack;
|
|
@@ -256,43 +227,46 @@ The stack in which this resource is defined.
|
|
|
256
227
|
|
|
257
228
|
---
|
|
258
229
|
|
|
259
|
-
##### `
|
|
230
|
+
##### `alias`<sup>Required</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.property.alias"></a>
|
|
260
231
|
|
|
261
232
|
```typescript
|
|
262
|
-
public readonly
|
|
233
|
+
public readonly alias: string;
|
|
263
234
|
```
|
|
264
235
|
|
|
265
236
|
- *Type:* string
|
|
266
237
|
|
|
267
|
-
The
|
|
238
|
+
The user-friendly name of the anomaly detector. 1 to 64 characters length.
|
|
239
|
+
|
|
240
|
+
Minimum length of 1. Maximum length of 64.
|
|
241
|
+
Pattern: [0-9A-Za-z][-.0-9A-Z_a-z]*
|
|
268
242
|
|
|
269
243
|
---
|
|
270
244
|
|
|
271
|
-
##### `
|
|
245
|
+
##### `anomalyDetectorArn`<sup>Required</sup> <a name="anomalyDetectorArn" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.property.anomalyDetectorArn"></a>
|
|
272
246
|
|
|
273
247
|
```typescript
|
|
274
|
-
public readonly
|
|
248
|
+
public readonly anomalyDetectorArn: string;
|
|
275
249
|
```
|
|
276
250
|
|
|
277
251
|
- *Type:* string
|
|
278
252
|
|
|
279
|
-
The
|
|
253
|
+
The Amazon Resource Name (ARN) of the anomaly detector.
|
|
280
254
|
|
|
281
255
|
---
|
|
282
256
|
|
|
283
|
-
##### `
|
|
257
|
+
##### `configuration`<sup>Required</sup> <a name="configuration" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.property.configuration"></a>
|
|
284
258
|
|
|
285
259
|
```typescript
|
|
286
|
-
public readonly
|
|
260
|
+
public readonly configuration: AnomalyDetectorConfiguration;
|
|
287
261
|
```
|
|
288
262
|
|
|
289
|
-
- *Type:*
|
|
263
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorConfiguration">AnomalyDetectorConfiguration</a>
|
|
290
264
|
|
|
291
|
-
The
|
|
265
|
+
The algorithm configuration of the anomaly detector.
|
|
292
266
|
|
|
293
267
|
---
|
|
294
268
|
|
|
295
|
-
##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.
|
|
269
|
+
##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.property.workspace"></a>
|
|
296
270
|
|
|
297
271
|
```typescript
|
|
298
272
|
public readonly workspace: IWorkspace;
|
|
@@ -300,44 +274,87 @@ public readonly workspace: IWorkspace;
|
|
|
300
274
|
|
|
301
275
|
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
|
|
302
276
|
|
|
303
|
-
|
|
277
|
+
An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.
|
|
304
278
|
|
|
305
279
|
---
|
|
306
280
|
|
|
281
|
+
##### `evaluationIntervalInSeconds`<sup>Optional</sup> <a name="evaluationIntervalInSeconds" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.property.evaluationIntervalInSeconds"></a>
|
|
307
282
|
|
|
308
|
-
|
|
283
|
+
```typescript
|
|
284
|
+
public readonly evaluationIntervalInSeconds: number;
|
|
285
|
+
```
|
|
309
286
|
|
|
310
|
-
- *
|
|
287
|
+
- *Type:* number
|
|
311
288
|
|
|
312
|
-
|
|
289
|
+
The frequency, in seconds, at which the anomaly detector evaluates metrics.
|
|
290
|
+
|
|
291
|
+
Minimum value of 30. Maximum value of 86400.
|
|
292
|
+
|
|
293
|
+
---
|
|
294
|
+
|
|
295
|
+
##### `labels`<sup>Optional</sup> <a name="labels" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.property.labels"></a>
|
|
313
296
|
|
|
314
297
|
```typescript
|
|
315
|
-
|
|
298
|
+
public readonly labels: Label[];
|
|
299
|
+
```
|
|
316
300
|
|
|
317
|
-
|
|
301
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.Label">Label</a>[]
|
|
302
|
+
|
|
303
|
+
The Amazon Managed Service for Prometheus metric labels associated with the anomaly detector.
|
|
304
|
+
|
|
305
|
+
Map Entries: Minimum number of 0 items. Maximum number of 140 items.
|
|
306
|
+
Key Length Constraints: Minimum length of 1. Maximum length of 7168.
|
|
307
|
+
Key Pattern: (?!__)[a-zA-Z_][a-zA-Z0-9_]*
|
|
308
|
+
Value Length Constraints: Minimum length of 1. Maximum length of 7168.
|
|
309
|
+
|
|
310
|
+
---
|
|
311
|
+
|
|
312
|
+
##### `missingDataAction`<sup>Optional</sup> <a name="missingDataAction" id="@robhan-cdk-lib/aws_aps.AnomalyDetector.property.missingDataAction"></a>
|
|
313
|
+
|
|
314
|
+
```typescript
|
|
315
|
+
public readonly missingDataAction: MissingDataAction;
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.MissingDataAction">MissingDataAction</a>
|
|
319
|
+
|
|
320
|
+
The action taken when data is missing during evaluation.
|
|
321
|
+
|
|
322
|
+
---
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
### AnomalyDetectorBase <a name="AnomalyDetectorBase" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase"></a>
|
|
326
|
+
|
|
327
|
+
- *Implements:* <a href="#@robhan-cdk-lib/aws_aps.IAnomalyDetector">IAnomalyDetector</a>
|
|
328
|
+
|
|
329
|
+
#### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.Initializer"></a>
|
|
330
|
+
|
|
331
|
+
```typescript
|
|
332
|
+
import { AnomalyDetectorBase } from '@robhan-cdk-lib/aws_aps'
|
|
333
|
+
|
|
334
|
+
new AnomalyDetectorBase(scope: Construct, id: string, props?: ResourceProps)
|
|
318
335
|
```
|
|
319
336
|
|
|
320
337
|
| **Name** | **Type** | **Description** |
|
|
321
338
|
| --- | --- | --- |
|
|
322
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
323
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
324
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
339
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
340
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
341
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.Initializer.parameter.props">props</a></code> | <code>aws-cdk-lib.ResourceProps</code> | *No description.* |
|
|
325
342
|
|
|
326
343
|
---
|
|
327
344
|
|
|
328
|
-
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.
|
|
345
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.Initializer.parameter.scope"></a>
|
|
329
346
|
|
|
330
347
|
- *Type:* constructs.Construct
|
|
331
348
|
|
|
332
349
|
---
|
|
333
350
|
|
|
334
|
-
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.
|
|
351
|
+
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.Initializer.parameter.id"></a>
|
|
335
352
|
|
|
336
353
|
- *Type:* string
|
|
337
354
|
|
|
338
355
|
---
|
|
339
356
|
|
|
340
|
-
##### `props`<sup>Optional</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.
|
|
357
|
+
##### `props`<sup>Optional</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.Initializer.parameter.props"></a>
|
|
341
358
|
|
|
342
359
|
- *Type:* aws-cdk-lib.ResourceProps
|
|
343
360
|
|
|
@@ -347,12 +364,12 @@ new RuleGroupsNamespaceBase(scope: Construct, id: string, props?: ResourceProps)
|
|
|
347
364
|
|
|
348
365
|
| **Name** | **Description** |
|
|
349
366
|
| --- | --- |
|
|
350
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
351
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
367
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
368
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
352
369
|
|
|
353
370
|
---
|
|
354
371
|
|
|
355
|
-
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.
|
|
372
|
+
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.toString"></a>
|
|
356
373
|
|
|
357
374
|
```typescript
|
|
358
375
|
public toString(): string
|
|
@@ -360,7 +377,7 @@ public toString(): string
|
|
|
360
377
|
|
|
361
378
|
Returns a string representation of this construct.
|
|
362
379
|
|
|
363
|
-
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.
|
|
380
|
+
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.applyRemovalPolicy"></a>
|
|
364
381
|
|
|
365
382
|
```typescript
|
|
366
383
|
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
@@ -376,7 +393,7 @@ to be replaced.
|
|
|
376
393
|
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
377
394
|
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
378
395
|
|
|
379
|
-
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.
|
|
396
|
+
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.applyRemovalPolicy.parameter.policy"></a>
|
|
380
397
|
|
|
381
398
|
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
382
399
|
|
|
@@ -386,18 +403,18 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
|
386
403
|
|
|
387
404
|
| **Name** | **Description** |
|
|
388
405
|
| --- | --- |
|
|
389
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
390
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
391
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
406
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
407
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
|
|
408
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
392
409
|
|
|
393
410
|
---
|
|
394
411
|
|
|
395
|
-
##### `isConstruct` <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.
|
|
412
|
+
##### `isConstruct` <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.isConstruct"></a>
|
|
396
413
|
|
|
397
414
|
```typescript
|
|
398
|
-
import {
|
|
415
|
+
import { AnomalyDetectorBase } from '@robhan-cdk-lib/aws_aps'
|
|
399
416
|
|
|
400
|
-
|
|
417
|
+
AnomalyDetectorBase.isConstruct(x: any)
|
|
401
418
|
```
|
|
402
419
|
|
|
403
420
|
Checks if `x` is a construct.
|
|
@@ -416,7 +433,7 @@ library can be accidentally installed, and `instanceof` will behave
|
|
|
416
433
|
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
417
434
|
this type-testing method instead.
|
|
418
435
|
|
|
419
|
-
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.
|
|
436
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.isConstruct.parameter.x"></a>
|
|
420
437
|
|
|
421
438
|
- *Type:* any
|
|
422
439
|
|
|
@@ -424,33 +441,33 @@ Any object.
|
|
|
424
441
|
|
|
425
442
|
---
|
|
426
443
|
|
|
427
|
-
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.
|
|
444
|
+
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.isOwnedResource"></a>
|
|
428
445
|
|
|
429
446
|
```typescript
|
|
430
|
-
import {
|
|
447
|
+
import { AnomalyDetectorBase } from '@robhan-cdk-lib/aws_aps'
|
|
431
448
|
|
|
432
|
-
|
|
449
|
+
AnomalyDetectorBase.isOwnedResource(construct: IConstruct)
|
|
433
450
|
```
|
|
434
451
|
|
|
435
452
|
Returns true if the construct was created by CDK, and false otherwise.
|
|
436
453
|
|
|
437
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.
|
|
454
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.isOwnedResource.parameter.construct"></a>
|
|
438
455
|
|
|
439
456
|
- *Type:* constructs.IConstruct
|
|
440
457
|
|
|
441
458
|
---
|
|
442
459
|
|
|
443
|
-
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.
|
|
460
|
+
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.isResource"></a>
|
|
444
461
|
|
|
445
462
|
```typescript
|
|
446
|
-
import {
|
|
463
|
+
import { AnomalyDetectorBase } from '@robhan-cdk-lib/aws_aps'
|
|
447
464
|
|
|
448
|
-
|
|
465
|
+
AnomalyDetectorBase.isResource(construct: IConstruct)
|
|
449
466
|
```
|
|
450
467
|
|
|
451
468
|
Check whether the given construct is a Resource.
|
|
452
469
|
|
|
453
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.
|
|
470
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.isResource.parameter.construct"></a>
|
|
454
471
|
|
|
455
472
|
- *Type:* constructs.IConstruct
|
|
456
473
|
|
|
@@ -460,17 +477,20 @@ Check whether the given construct is a Resource.
|
|
|
460
477
|
|
|
461
478
|
| **Name** | **Type** | **Description** |
|
|
462
479
|
| --- | --- | --- |
|
|
463
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
464
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
465
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
466
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
467
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
468
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
469
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
480
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
481
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
482
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
483
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.alias">alias</a></code> | <code>string</code> | The user-friendly name of the anomaly detector. 1 to 64 characters length. |
|
|
484
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.anomalyDetectorArn">anomalyDetectorArn</a></code> | <code>string</code> | The Amazon Resource Name (ARN) of the anomaly detector. |
|
|
485
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.configuration">configuration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorConfiguration">AnomalyDetectorConfiguration</a></code> | The algorithm configuration of the anomaly detector. |
|
|
486
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics. |
|
|
487
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.evaluationIntervalInSeconds">evaluationIntervalInSeconds</a></code> | <code>number</code> | The frequency, in seconds, at which the anomaly detector evaluates metrics. |
|
|
488
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.labels">labels</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Label">Label</a>[]</code> | The Amazon Managed Service for Prometheus metric labels associated with the anomaly detector. |
|
|
489
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.missingDataAction">missingDataAction</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.MissingDataAction">MissingDataAction</a></code> | The action taken when data is missing during evaluation. |
|
|
470
490
|
|
|
471
491
|
---
|
|
472
492
|
|
|
473
|
-
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.
|
|
493
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.node"></a>
|
|
474
494
|
|
|
475
495
|
```typescript
|
|
476
496
|
public readonly node: Node;
|
|
@@ -482,7 +502,7 @@ The tree node.
|
|
|
482
502
|
|
|
483
503
|
---
|
|
484
504
|
|
|
485
|
-
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.
|
|
505
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.env"></a>
|
|
486
506
|
|
|
487
507
|
```typescript
|
|
488
508
|
public readonly env: ResourceEnvironment;
|
|
@@ -502,7 +522,7 @@ different than the stack they were imported into.
|
|
|
502
522
|
|
|
503
523
|
---
|
|
504
524
|
|
|
505
|
-
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.
|
|
525
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.stack"></a>
|
|
506
526
|
|
|
507
527
|
```typescript
|
|
508
528
|
public readonly stack: Stack;
|
|
@@ -514,43 +534,46 @@ The stack in which this resource is defined.
|
|
|
514
534
|
|
|
515
535
|
---
|
|
516
536
|
|
|
517
|
-
##### `
|
|
537
|
+
##### `alias`<sup>Required</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.alias"></a>
|
|
518
538
|
|
|
519
539
|
```typescript
|
|
520
|
-
public readonly
|
|
540
|
+
public readonly alias: string;
|
|
521
541
|
```
|
|
522
542
|
|
|
523
543
|
- *Type:* string
|
|
524
544
|
|
|
525
|
-
The
|
|
545
|
+
The user-friendly name of the anomaly detector. 1 to 64 characters length.
|
|
546
|
+
|
|
547
|
+
Minimum length of 1. Maximum length of 64.
|
|
548
|
+
Pattern: [0-9A-Za-z][-.0-9A-Z_a-z]*
|
|
526
549
|
|
|
527
550
|
---
|
|
528
551
|
|
|
529
|
-
##### `
|
|
552
|
+
##### `anomalyDetectorArn`<sup>Required</sup> <a name="anomalyDetectorArn" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.anomalyDetectorArn"></a>
|
|
530
553
|
|
|
531
554
|
```typescript
|
|
532
|
-
public readonly
|
|
555
|
+
public readonly anomalyDetectorArn: string;
|
|
533
556
|
```
|
|
534
557
|
|
|
535
558
|
- *Type:* string
|
|
536
559
|
|
|
537
|
-
The
|
|
560
|
+
The Amazon Resource Name (ARN) of the anomaly detector.
|
|
538
561
|
|
|
539
562
|
---
|
|
540
563
|
|
|
541
|
-
##### `
|
|
564
|
+
##### `configuration`<sup>Required</sup> <a name="configuration" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.configuration"></a>
|
|
542
565
|
|
|
543
566
|
```typescript
|
|
544
|
-
public readonly
|
|
567
|
+
public readonly configuration: AnomalyDetectorConfiguration;
|
|
545
568
|
```
|
|
546
569
|
|
|
547
|
-
- *Type:*
|
|
570
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorConfiguration">AnomalyDetectorConfiguration</a>
|
|
548
571
|
|
|
549
|
-
The
|
|
572
|
+
The algorithm configuration of the anomaly detector.
|
|
550
573
|
|
|
551
574
|
---
|
|
552
575
|
|
|
553
|
-
##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.
|
|
576
|
+
##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.workspace"></a>
|
|
554
577
|
|
|
555
578
|
```typescript
|
|
556
579
|
public readonly workspace: IWorkspace;
|
|
@@ -558,44 +581,87 @@ public readonly workspace: IWorkspace;
|
|
|
558
581
|
|
|
559
582
|
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
|
|
560
583
|
|
|
561
|
-
|
|
584
|
+
An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.
|
|
562
585
|
|
|
563
586
|
---
|
|
564
587
|
|
|
588
|
+
##### `evaluationIntervalInSeconds`<sup>Optional</sup> <a name="evaluationIntervalInSeconds" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.evaluationIntervalInSeconds"></a>
|
|
565
589
|
|
|
566
|
-
|
|
590
|
+
```typescript
|
|
591
|
+
public readonly evaluationIntervalInSeconds: number;
|
|
592
|
+
```
|
|
567
593
|
|
|
568
|
-
|
|
594
|
+
- *Type:* number
|
|
595
|
+
|
|
596
|
+
The frequency, in seconds, at which the anomaly detector evaluates metrics.
|
|
597
|
+
|
|
598
|
+
Minimum value of 30. Maximum value of 86400.
|
|
599
|
+
|
|
600
|
+
---
|
|
601
|
+
|
|
602
|
+
##### `labels`<sup>Optional</sup> <a name="labels" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.labels"></a>
|
|
569
603
|
|
|
570
604
|
```typescript
|
|
571
|
-
|
|
605
|
+
public readonly labels: Label[];
|
|
606
|
+
```
|
|
572
607
|
|
|
573
|
-
|
|
608
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.Label">Label</a>[]
|
|
609
|
+
|
|
610
|
+
The Amazon Managed Service for Prometheus metric labels associated with the anomaly detector.
|
|
611
|
+
|
|
612
|
+
Map Entries: Minimum number of 0 items. Maximum number of 140 items.
|
|
613
|
+
Key Length Constraints: Minimum length of 1. Maximum length of 7168.
|
|
614
|
+
Key Pattern: (?!__)[a-zA-Z_][a-zA-Z0-9_]*
|
|
615
|
+
Value Length Constraints: Minimum length of 1. Maximum length of 7168.
|
|
616
|
+
|
|
617
|
+
---
|
|
618
|
+
|
|
619
|
+
##### `missingDataAction`<sup>Optional</sup> <a name="missingDataAction" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorBase.property.missingDataAction"></a>
|
|
620
|
+
|
|
621
|
+
```typescript
|
|
622
|
+
public readonly missingDataAction: MissingDataAction;
|
|
623
|
+
```
|
|
624
|
+
|
|
625
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.MissingDataAction">MissingDataAction</a>
|
|
626
|
+
|
|
627
|
+
The action taken when data is missing during evaluation.
|
|
628
|
+
|
|
629
|
+
---
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
### ResourcePolicy <a name="ResourcePolicy" id="@robhan-cdk-lib/aws_aps.ResourcePolicy"></a>
|
|
633
|
+
|
|
634
|
+
#### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.Initializer"></a>
|
|
635
|
+
|
|
636
|
+
```typescript
|
|
637
|
+
import { ResourcePolicy } from '@robhan-cdk-lib/aws_aps'
|
|
638
|
+
|
|
639
|
+
new ResourcePolicy(scope: Construct, id: string, props: ResourcePolicyProps)
|
|
574
640
|
```
|
|
575
641
|
|
|
576
642
|
| **Name** | **Type** | **Description** |
|
|
577
643
|
| --- | --- | --- |
|
|
578
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
579
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
580
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
644
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
645
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
646
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.Initializer.parameter.props">props</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyProps">ResourcePolicyProps</a></code> | *No description.* |
|
|
581
647
|
|
|
582
648
|
---
|
|
583
649
|
|
|
584
|
-
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.
|
|
650
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.Initializer.parameter.scope"></a>
|
|
585
651
|
|
|
586
652
|
- *Type:* constructs.Construct
|
|
587
653
|
|
|
588
654
|
---
|
|
589
655
|
|
|
590
|
-
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.
|
|
656
|
+
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.Initializer.parameter.id"></a>
|
|
591
657
|
|
|
592
658
|
- *Type:* string
|
|
593
659
|
|
|
594
660
|
---
|
|
595
661
|
|
|
596
|
-
##### `props`<sup>Required</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.
|
|
662
|
+
##### `props`<sup>Required</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.Initializer.parameter.props"></a>
|
|
597
663
|
|
|
598
|
-
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.
|
|
664
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyProps">ResourcePolicyProps</a>
|
|
599
665
|
|
|
600
666
|
---
|
|
601
667
|
|
|
@@ -603,12 +669,12 @@ new Scraper(scope: Construct, id: string, props: ScraperProps)
|
|
|
603
669
|
|
|
604
670
|
| **Name** | **Description** |
|
|
605
671
|
| --- | --- |
|
|
606
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
607
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
672
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
673
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
608
674
|
|
|
609
675
|
---
|
|
610
676
|
|
|
611
|
-
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.
|
|
677
|
+
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.toString"></a>
|
|
612
678
|
|
|
613
679
|
```typescript
|
|
614
680
|
public toString(): string
|
|
@@ -616,7 +682,7 @@ public toString(): string
|
|
|
616
682
|
|
|
617
683
|
Returns a string representation of this construct.
|
|
618
684
|
|
|
619
|
-
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.
|
|
685
|
+
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.applyRemovalPolicy"></a>
|
|
620
686
|
|
|
621
687
|
```typescript
|
|
622
688
|
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
@@ -632,7 +698,7 @@ to be replaced.
|
|
|
632
698
|
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
633
699
|
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
634
700
|
|
|
635
|
-
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.
|
|
701
|
+
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.applyRemovalPolicy.parameter.policy"></a>
|
|
636
702
|
|
|
637
703
|
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
638
704
|
|
|
@@ -642,20 +708,19 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
|
642
708
|
|
|
643
709
|
| **Name** | **Description** |
|
|
644
710
|
| --- | --- |
|
|
645
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
646
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
647
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
648
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
649
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.isScraper">isScraper</a></code> | *No description.* |
|
|
711
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
712
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
|
|
713
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
714
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.isResourcePolicy">isResourcePolicy</a></code> | *No description.* |
|
|
650
715
|
|
|
651
716
|
---
|
|
652
717
|
|
|
653
|
-
##### `isConstruct` <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.
|
|
718
|
+
##### `isConstruct` <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.isConstruct"></a>
|
|
654
719
|
|
|
655
720
|
```typescript
|
|
656
|
-
import {
|
|
721
|
+
import { ResourcePolicy } from '@robhan-cdk-lib/aws_aps'
|
|
657
722
|
|
|
658
|
-
|
|
723
|
+
ResourcePolicy.isConstruct(x: any)
|
|
659
724
|
```
|
|
660
725
|
|
|
661
726
|
Checks if `x` is a construct.
|
|
@@ -674,7 +739,7 @@ library can be accidentally installed, and `instanceof` will behave
|
|
|
674
739
|
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
675
740
|
this type-testing method instead.
|
|
676
741
|
|
|
677
|
-
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.
|
|
742
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.isConstruct.parameter.x"></a>
|
|
678
743
|
|
|
679
744
|
- *Type:* any
|
|
680
745
|
|
|
@@ -682,65 +747,1104 @@ Any object.
|
|
|
682
747
|
|
|
683
748
|
---
|
|
684
749
|
|
|
685
|
-
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.
|
|
750
|
+
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.isOwnedResource"></a>
|
|
686
751
|
|
|
687
752
|
```typescript
|
|
688
|
-
import {
|
|
753
|
+
import { ResourcePolicy } from '@robhan-cdk-lib/aws_aps'
|
|
689
754
|
|
|
690
|
-
|
|
755
|
+
ResourcePolicy.isOwnedResource(construct: IConstruct)
|
|
691
756
|
```
|
|
692
757
|
|
|
693
758
|
Returns true if the construct was created by CDK, and false otherwise.
|
|
694
759
|
|
|
695
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.
|
|
760
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.isOwnedResource.parameter.construct"></a>
|
|
696
761
|
|
|
697
762
|
- *Type:* constructs.IConstruct
|
|
698
763
|
|
|
699
764
|
---
|
|
700
765
|
|
|
701
|
-
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.
|
|
766
|
+
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.isResource"></a>
|
|
702
767
|
|
|
703
768
|
```typescript
|
|
704
|
-
import {
|
|
769
|
+
import { ResourcePolicy } from '@robhan-cdk-lib/aws_aps'
|
|
705
770
|
|
|
706
|
-
|
|
771
|
+
ResourcePolicy.isResource(construct: IConstruct)
|
|
707
772
|
```
|
|
708
773
|
|
|
709
774
|
Check whether the given construct is a Resource.
|
|
710
775
|
|
|
711
|
-
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.
|
|
776
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.isResource.parameter.construct"></a>
|
|
712
777
|
|
|
713
778
|
- *Type:* constructs.IConstruct
|
|
714
779
|
|
|
715
780
|
---
|
|
716
781
|
|
|
717
|
-
##### `
|
|
782
|
+
##### `isResourcePolicy` <a name="isResourcePolicy" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.isResourcePolicy"></a>
|
|
718
783
|
|
|
719
784
|
```typescript
|
|
720
|
-
import {
|
|
785
|
+
import { ResourcePolicy } from '@robhan-cdk-lib/aws_aps'
|
|
721
786
|
|
|
722
|
-
|
|
787
|
+
ResourcePolicy.isResourcePolicy(x: any)
|
|
723
788
|
```
|
|
724
789
|
|
|
725
|
-
###### `
|
|
790
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.isResourcePolicy.parameter.x"></a>
|
|
726
791
|
|
|
727
|
-
- *Type:*
|
|
792
|
+
- *Type:* any
|
|
728
793
|
|
|
729
794
|
---
|
|
730
795
|
|
|
731
|
-
|
|
796
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
732
797
|
|
|
733
|
-
|
|
798
|
+
| **Name** | **Type** | **Description** |
|
|
799
|
+
| --- | --- | --- |
|
|
800
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
801
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
802
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
803
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.property.policyDocument">policyDocument</a></code> | <code>string</code> | The JSON to use as the Resource-based Policy. |
|
|
804
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | The workspace to attach the policy to. |
|
|
734
805
|
|
|
735
806
|
---
|
|
736
807
|
|
|
737
|
-
|
|
808
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.property.node"></a>
|
|
738
809
|
|
|
739
|
-
|
|
810
|
+
```typescript
|
|
811
|
+
public readonly node: Node;
|
|
812
|
+
```
|
|
740
813
|
|
|
741
|
-
|
|
814
|
+
- *Type:* constructs.Node
|
|
742
815
|
|
|
743
|
-
|
|
816
|
+
The tree node.
|
|
817
|
+
|
|
818
|
+
---
|
|
819
|
+
|
|
820
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.property.env"></a>
|
|
821
|
+
|
|
822
|
+
```typescript
|
|
823
|
+
public readonly env: ResourceEnvironment;
|
|
824
|
+
```
|
|
825
|
+
|
|
826
|
+
- *Type:* aws-cdk-lib.interfaces.ResourceEnvironment
|
|
827
|
+
|
|
828
|
+
The environment this resource belongs to.
|
|
829
|
+
|
|
830
|
+
For resources that are created and managed in a Stack (those created by
|
|
831
|
+
creating new class instances like `new Role()`, `new Bucket()`, etc.), this
|
|
832
|
+
is always the same as the environment of the stack they belong to.
|
|
833
|
+
|
|
834
|
+
For referenced resources (those obtained from referencing methods like
|
|
835
|
+
`Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
|
|
836
|
+
different than the stack they were imported into.
|
|
837
|
+
|
|
838
|
+
---
|
|
839
|
+
|
|
840
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.property.stack"></a>
|
|
841
|
+
|
|
842
|
+
```typescript
|
|
843
|
+
public readonly stack: Stack;
|
|
844
|
+
```
|
|
845
|
+
|
|
846
|
+
- *Type:* aws-cdk-lib.Stack
|
|
847
|
+
|
|
848
|
+
The stack in which this resource is defined.
|
|
849
|
+
|
|
850
|
+
---
|
|
851
|
+
|
|
852
|
+
##### `policyDocument`<sup>Required</sup> <a name="policyDocument" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.property.policyDocument"></a>
|
|
853
|
+
|
|
854
|
+
```typescript
|
|
855
|
+
public readonly policyDocument: string;
|
|
856
|
+
```
|
|
857
|
+
|
|
858
|
+
- *Type:* string
|
|
859
|
+
|
|
860
|
+
The JSON to use as the Resource-based Policy.
|
|
861
|
+
|
|
862
|
+
---
|
|
863
|
+
|
|
864
|
+
##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.ResourcePolicy.property.workspace"></a>
|
|
865
|
+
|
|
866
|
+
```typescript
|
|
867
|
+
public readonly workspace: IWorkspace;
|
|
868
|
+
```
|
|
869
|
+
|
|
870
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
|
|
871
|
+
|
|
872
|
+
The workspace to attach the policy to.
|
|
873
|
+
|
|
874
|
+
---
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
### ResourcePolicyBase <a name="ResourcePolicyBase" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase"></a>
|
|
878
|
+
|
|
879
|
+
- *Implements:* <a href="#@robhan-cdk-lib/aws_aps.IResourcePolicy">IResourcePolicy</a>
|
|
880
|
+
|
|
881
|
+
#### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.Initializer"></a>
|
|
882
|
+
|
|
883
|
+
```typescript
|
|
884
|
+
import { ResourcePolicyBase } from '@robhan-cdk-lib/aws_aps'
|
|
885
|
+
|
|
886
|
+
new ResourcePolicyBase(scope: Construct, id: string, props?: ResourceProps)
|
|
887
|
+
```
|
|
888
|
+
|
|
889
|
+
| **Name** | **Type** | **Description** |
|
|
890
|
+
| --- | --- | --- |
|
|
891
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
892
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
893
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase.Initializer.parameter.props">props</a></code> | <code>aws-cdk-lib.ResourceProps</code> | *No description.* |
|
|
894
|
+
|
|
895
|
+
---
|
|
896
|
+
|
|
897
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.Initializer.parameter.scope"></a>
|
|
898
|
+
|
|
899
|
+
- *Type:* constructs.Construct
|
|
900
|
+
|
|
901
|
+
---
|
|
902
|
+
|
|
903
|
+
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.Initializer.parameter.id"></a>
|
|
904
|
+
|
|
905
|
+
- *Type:* string
|
|
906
|
+
|
|
907
|
+
---
|
|
908
|
+
|
|
909
|
+
##### `props`<sup>Optional</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.Initializer.parameter.props"></a>
|
|
910
|
+
|
|
911
|
+
- *Type:* aws-cdk-lib.ResourceProps
|
|
912
|
+
|
|
913
|
+
---
|
|
914
|
+
|
|
915
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
916
|
+
|
|
917
|
+
| **Name** | **Description** |
|
|
918
|
+
| --- | --- |
|
|
919
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
920
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
921
|
+
|
|
922
|
+
---
|
|
923
|
+
|
|
924
|
+
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.toString"></a>
|
|
925
|
+
|
|
926
|
+
```typescript
|
|
927
|
+
public toString(): string
|
|
928
|
+
```
|
|
929
|
+
|
|
930
|
+
Returns a string representation of this construct.
|
|
931
|
+
|
|
932
|
+
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.applyRemovalPolicy"></a>
|
|
933
|
+
|
|
934
|
+
```typescript
|
|
935
|
+
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
936
|
+
```
|
|
937
|
+
|
|
938
|
+
Apply the given removal policy to this resource.
|
|
939
|
+
|
|
940
|
+
The Removal Policy controls what happens to this resource when it stops
|
|
941
|
+
being managed by CloudFormation, either because you've removed it from the
|
|
942
|
+
CDK application or because you've made a change that requires the resource
|
|
943
|
+
to be replaced.
|
|
944
|
+
|
|
945
|
+
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
946
|
+
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
947
|
+
|
|
948
|
+
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.applyRemovalPolicy.parameter.policy"></a>
|
|
949
|
+
|
|
950
|
+
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
951
|
+
|
|
952
|
+
---
|
|
953
|
+
|
|
954
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
955
|
+
|
|
956
|
+
| **Name** | **Description** |
|
|
957
|
+
| --- | --- |
|
|
958
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
959
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase.isOwnedResource">isOwnedResource</a></code> | Returns true if the construct was created by CDK, and false otherwise. |
|
|
960
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
961
|
+
|
|
962
|
+
---
|
|
963
|
+
|
|
964
|
+
##### `isConstruct` <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.isConstruct"></a>
|
|
965
|
+
|
|
966
|
+
```typescript
|
|
967
|
+
import { ResourcePolicyBase } from '@robhan-cdk-lib/aws_aps'
|
|
968
|
+
|
|
969
|
+
ResourcePolicyBase.isConstruct(x: any)
|
|
970
|
+
```
|
|
971
|
+
|
|
972
|
+
Checks if `x` is a construct.
|
|
973
|
+
|
|
974
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
975
|
+
instances, even when the construct library is symlinked.
|
|
976
|
+
|
|
977
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
978
|
+
disk are seen as independent, completely different libraries. As a
|
|
979
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
980
|
+
is seen as a different class, and an instance of one class will not test as
|
|
981
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
982
|
+
like this, but users may manually symlink construct libraries together or
|
|
983
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
984
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
985
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
986
|
+
this type-testing method instead.
|
|
987
|
+
|
|
988
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.isConstruct.parameter.x"></a>
|
|
989
|
+
|
|
990
|
+
- *Type:* any
|
|
991
|
+
|
|
992
|
+
Any object.
|
|
993
|
+
|
|
994
|
+
---
|
|
995
|
+
|
|
996
|
+
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.isOwnedResource"></a>
|
|
997
|
+
|
|
998
|
+
```typescript
|
|
999
|
+
import { ResourcePolicyBase } from '@robhan-cdk-lib/aws_aps'
|
|
1000
|
+
|
|
1001
|
+
ResourcePolicyBase.isOwnedResource(construct: IConstruct)
|
|
1002
|
+
```
|
|
1003
|
+
|
|
1004
|
+
Returns true if the construct was created by CDK, and false otherwise.
|
|
1005
|
+
|
|
1006
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.isOwnedResource.parameter.construct"></a>
|
|
1007
|
+
|
|
1008
|
+
- *Type:* constructs.IConstruct
|
|
1009
|
+
|
|
1010
|
+
---
|
|
1011
|
+
|
|
1012
|
+
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.isResource"></a>
|
|
1013
|
+
|
|
1014
|
+
```typescript
|
|
1015
|
+
import { ResourcePolicyBase } from '@robhan-cdk-lib/aws_aps'
|
|
1016
|
+
|
|
1017
|
+
ResourcePolicyBase.isResource(construct: IConstruct)
|
|
1018
|
+
```
|
|
1019
|
+
|
|
1020
|
+
Check whether the given construct is a Resource.
|
|
1021
|
+
|
|
1022
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.isResource.parameter.construct"></a>
|
|
1023
|
+
|
|
1024
|
+
- *Type:* constructs.IConstruct
|
|
1025
|
+
|
|
1026
|
+
---
|
|
1027
|
+
|
|
1028
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1029
|
+
|
|
1030
|
+
| **Name** | **Type** | **Description** |
|
|
1031
|
+
| --- | --- | --- |
|
|
1032
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
1033
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
1034
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
1035
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase.property.policyDocument">policyDocument</a></code> | <code>string</code> | The JSON to use as the Resource-based Policy. |
|
|
1036
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | The workspace to attach the policy to. |
|
|
1037
|
+
|
|
1038
|
+
---
|
|
1039
|
+
|
|
1040
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.property.node"></a>
|
|
1041
|
+
|
|
1042
|
+
```typescript
|
|
1043
|
+
public readonly node: Node;
|
|
1044
|
+
```
|
|
1045
|
+
|
|
1046
|
+
- *Type:* constructs.Node
|
|
1047
|
+
|
|
1048
|
+
The tree node.
|
|
1049
|
+
|
|
1050
|
+
---
|
|
1051
|
+
|
|
1052
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.property.env"></a>
|
|
1053
|
+
|
|
1054
|
+
```typescript
|
|
1055
|
+
public readonly env: ResourceEnvironment;
|
|
1056
|
+
```
|
|
1057
|
+
|
|
1058
|
+
- *Type:* aws-cdk-lib.interfaces.ResourceEnvironment
|
|
1059
|
+
|
|
1060
|
+
The environment this resource belongs to.
|
|
1061
|
+
|
|
1062
|
+
For resources that are created and managed in a Stack (those created by
|
|
1063
|
+
creating new class instances like `new Role()`, `new Bucket()`, etc.), this
|
|
1064
|
+
is always the same as the environment of the stack they belong to.
|
|
1065
|
+
|
|
1066
|
+
For referenced resources (those obtained from referencing methods like
|
|
1067
|
+
`Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
|
|
1068
|
+
different than the stack they were imported into.
|
|
1069
|
+
|
|
1070
|
+
---
|
|
1071
|
+
|
|
1072
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.property.stack"></a>
|
|
1073
|
+
|
|
1074
|
+
```typescript
|
|
1075
|
+
public readonly stack: Stack;
|
|
1076
|
+
```
|
|
1077
|
+
|
|
1078
|
+
- *Type:* aws-cdk-lib.Stack
|
|
1079
|
+
|
|
1080
|
+
The stack in which this resource is defined.
|
|
1081
|
+
|
|
1082
|
+
---
|
|
1083
|
+
|
|
1084
|
+
##### `policyDocument`<sup>Required</sup> <a name="policyDocument" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.property.policyDocument"></a>
|
|
1085
|
+
|
|
1086
|
+
```typescript
|
|
1087
|
+
public readonly policyDocument: string;
|
|
1088
|
+
```
|
|
1089
|
+
|
|
1090
|
+
- *Type:* string
|
|
1091
|
+
|
|
1092
|
+
The JSON to use as the Resource-based Policy.
|
|
1093
|
+
|
|
1094
|
+
---
|
|
1095
|
+
|
|
1096
|
+
##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.ResourcePolicyBase.property.workspace"></a>
|
|
1097
|
+
|
|
1098
|
+
```typescript
|
|
1099
|
+
public readonly workspace: IWorkspace;
|
|
1100
|
+
```
|
|
1101
|
+
|
|
1102
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
|
|
1103
|
+
|
|
1104
|
+
The workspace to attach the policy to.
|
|
1105
|
+
|
|
1106
|
+
---
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
### RuleGroupsNamespace <a name="RuleGroupsNamespace" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace"></a>
|
|
1110
|
+
|
|
1111
|
+
The definition of a rule groups namespace in an Amazon Managed Service for Prometheus workspace.
|
|
1112
|
+
|
|
1113
|
+
A rule groups namespace is associated with exactly one rules file. A workspace can have multiple
|
|
1114
|
+
rule groups namespaces.
|
|
1115
|
+
|
|
1116
|
+
#### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.Initializer"></a>
|
|
1117
|
+
|
|
1118
|
+
```typescript
|
|
1119
|
+
import { RuleGroupsNamespace } from '@robhan-cdk-lib/aws_aps'
|
|
1120
|
+
|
|
1121
|
+
new RuleGroupsNamespace(scope: Construct, id: string, props: RuleGroupsNamespaceProps)
|
|
1122
|
+
```
|
|
1123
|
+
|
|
1124
|
+
| **Name** | **Type** | **Description** |
|
|
1125
|
+
| --- | --- | --- |
|
|
1126
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
1127
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
1128
|
+
| <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.* |
|
|
1129
|
+
|
|
1130
|
+
---
|
|
1131
|
+
|
|
1132
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.Initializer.parameter.scope"></a>
|
|
1133
|
+
|
|
1134
|
+
- *Type:* constructs.Construct
|
|
1135
|
+
|
|
1136
|
+
---
|
|
1137
|
+
|
|
1138
|
+
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.Initializer.parameter.id"></a>
|
|
1139
|
+
|
|
1140
|
+
- *Type:* string
|
|
1141
|
+
|
|
1142
|
+
---
|
|
1143
|
+
|
|
1144
|
+
##### `props`<sup>Required</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.Initializer.parameter.props"></a>
|
|
1145
|
+
|
|
1146
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceProps">RuleGroupsNamespaceProps</a>
|
|
1147
|
+
|
|
1148
|
+
---
|
|
1149
|
+
|
|
1150
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
1151
|
+
|
|
1152
|
+
| **Name** | **Description** |
|
|
1153
|
+
| --- | --- |
|
|
1154
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
1155
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
1156
|
+
|
|
1157
|
+
---
|
|
1158
|
+
|
|
1159
|
+
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.toString"></a>
|
|
1160
|
+
|
|
1161
|
+
```typescript
|
|
1162
|
+
public toString(): string
|
|
1163
|
+
```
|
|
1164
|
+
|
|
1165
|
+
Returns a string representation of this construct.
|
|
1166
|
+
|
|
1167
|
+
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.applyRemovalPolicy"></a>
|
|
1168
|
+
|
|
1169
|
+
```typescript
|
|
1170
|
+
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
1171
|
+
```
|
|
1172
|
+
|
|
1173
|
+
Apply the given removal policy to this resource.
|
|
1174
|
+
|
|
1175
|
+
The Removal Policy controls what happens to this resource when it stops
|
|
1176
|
+
being managed by CloudFormation, either because you've removed it from the
|
|
1177
|
+
CDK application or because you've made a change that requires the resource
|
|
1178
|
+
to be replaced.
|
|
1179
|
+
|
|
1180
|
+
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
1181
|
+
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
1182
|
+
|
|
1183
|
+
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.applyRemovalPolicy.parameter.policy"></a>
|
|
1184
|
+
|
|
1185
|
+
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
1186
|
+
|
|
1187
|
+
---
|
|
1188
|
+
|
|
1189
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
1190
|
+
|
|
1191
|
+
| **Name** | **Description** |
|
|
1192
|
+
| --- | --- |
|
|
1193
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
1194
|
+
| <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. |
|
|
1195
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
1196
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes">fromRuleGroupsNamespaceAttributes</a></code> | *No description.* |
|
|
1197
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isRuleGroupsNamespace">isRuleGroupsNamespace</a></code> | *No description.* |
|
|
1198
|
+
|
|
1199
|
+
---
|
|
1200
|
+
|
|
1201
|
+
##### `isConstruct` <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isConstruct"></a>
|
|
1202
|
+
|
|
1203
|
+
```typescript
|
|
1204
|
+
import { RuleGroupsNamespace } from '@robhan-cdk-lib/aws_aps'
|
|
1205
|
+
|
|
1206
|
+
RuleGroupsNamespace.isConstruct(x: any)
|
|
1207
|
+
```
|
|
1208
|
+
|
|
1209
|
+
Checks if `x` is a construct.
|
|
1210
|
+
|
|
1211
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
1212
|
+
instances, even when the construct library is symlinked.
|
|
1213
|
+
|
|
1214
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
1215
|
+
disk are seen as independent, completely different libraries. As a
|
|
1216
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
1217
|
+
is seen as a different class, and an instance of one class will not test as
|
|
1218
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
1219
|
+
like this, but users may manually symlink construct libraries together or
|
|
1220
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
1221
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
1222
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
1223
|
+
this type-testing method instead.
|
|
1224
|
+
|
|
1225
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isConstruct.parameter.x"></a>
|
|
1226
|
+
|
|
1227
|
+
- *Type:* any
|
|
1228
|
+
|
|
1229
|
+
Any object.
|
|
1230
|
+
|
|
1231
|
+
---
|
|
1232
|
+
|
|
1233
|
+
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isOwnedResource"></a>
|
|
1234
|
+
|
|
1235
|
+
```typescript
|
|
1236
|
+
import { RuleGroupsNamespace } from '@robhan-cdk-lib/aws_aps'
|
|
1237
|
+
|
|
1238
|
+
RuleGroupsNamespace.isOwnedResource(construct: IConstruct)
|
|
1239
|
+
```
|
|
1240
|
+
|
|
1241
|
+
Returns true if the construct was created by CDK, and false otherwise.
|
|
1242
|
+
|
|
1243
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isOwnedResource.parameter.construct"></a>
|
|
1244
|
+
|
|
1245
|
+
- *Type:* constructs.IConstruct
|
|
1246
|
+
|
|
1247
|
+
---
|
|
1248
|
+
|
|
1249
|
+
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isResource"></a>
|
|
1250
|
+
|
|
1251
|
+
```typescript
|
|
1252
|
+
import { RuleGroupsNamespace } from '@robhan-cdk-lib/aws_aps'
|
|
1253
|
+
|
|
1254
|
+
RuleGroupsNamespace.isResource(construct: IConstruct)
|
|
1255
|
+
```
|
|
1256
|
+
|
|
1257
|
+
Check whether the given construct is a Resource.
|
|
1258
|
+
|
|
1259
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isResource.parameter.construct"></a>
|
|
1260
|
+
|
|
1261
|
+
- *Type:* constructs.IConstruct
|
|
1262
|
+
|
|
1263
|
+
---
|
|
1264
|
+
|
|
1265
|
+
##### `fromRuleGroupsNamespaceAttributes` <a name="fromRuleGroupsNamespaceAttributes" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes"></a>
|
|
1266
|
+
|
|
1267
|
+
```typescript
|
|
1268
|
+
import { RuleGroupsNamespace } from '@robhan-cdk-lib/aws_aps'
|
|
1269
|
+
|
|
1270
|
+
RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes(scope: Construct, id: string, attrs: RuleGroupsNamespaceAttributes)
|
|
1271
|
+
```
|
|
1272
|
+
|
|
1273
|
+
###### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes.parameter.scope"></a>
|
|
1274
|
+
|
|
1275
|
+
- *Type:* constructs.Construct
|
|
1276
|
+
|
|
1277
|
+
---
|
|
1278
|
+
|
|
1279
|
+
###### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes.parameter.id"></a>
|
|
1280
|
+
|
|
1281
|
+
- *Type:* string
|
|
1282
|
+
|
|
1283
|
+
---
|
|
1284
|
+
|
|
1285
|
+
###### `attrs`<sup>Required</sup> <a name="attrs" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.fromRuleGroupsNamespaceAttributes.parameter.attrs"></a>
|
|
1286
|
+
|
|
1287
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceAttributes">RuleGroupsNamespaceAttributes</a>
|
|
1288
|
+
|
|
1289
|
+
---
|
|
1290
|
+
|
|
1291
|
+
##### `isRuleGroupsNamespace` <a name="isRuleGroupsNamespace" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isRuleGroupsNamespace"></a>
|
|
1292
|
+
|
|
1293
|
+
```typescript
|
|
1294
|
+
import { RuleGroupsNamespace } from '@robhan-cdk-lib/aws_aps'
|
|
1295
|
+
|
|
1296
|
+
RuleGroupsNamespace.isRuleGroupsNamespace(x: any)
|
|
1297
|
+
```
|
|
1298
|
+
|
|
1299
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.isRuleGroupsNamespace.parameter.x"></a>
|
|
1300
|
+
|
|
1301
|
+
- *Type:* any
|
|
1302
|
+
|
|
1303
|
+
---
|
|
1304
|
+
|
|
1305
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1306
|
+
|
|
1307
|
+
| **Name** | **Type** | **Description** |
|
|
1308
|
+
| --- | --- | --- |
|
|
1309
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
1310
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
1311
|
+
| <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. |
|
|
1312
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.data">data</a></code> | <code>string</code> | The rules file used in the namespace. |
|
|
1313
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.name">name</a></code> | <code>string</code> | The name of the rule groups namespace. |
|
|
1314
|
+
| <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. |
|
|
1315
|
+
| <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. |
|
|
1316
|
+
|
|
1317
|
+
---
|
|
1318
|
+
|
|
1319
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.node"></a>
|
|
1320
|
+
|
|
1321
|
+
```typescript
|
|
1322
|
+
public readonly node: Node;
|
|
1323
|
+
```
|
|
1324
|
+
|
|
1325
|
+
- *Type:* constructs.Node
|
|
1326
|
+
|
|
1327
|
+
The tree node.
|
|
1328
|
+
|
|
1329
|
+
---
|
|
1330
|
+
|
|
1331
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.env"></a>
|
|
1332
|
+
|
|
1333
|
+
```typescript
|
|
1334
|
+
public readonly env: ResourceEnvironment;
|
|
1335
|
+
```
|
|
1336
|
+
|
|
1337
|
+
- *Type:* aws-cdk-lib.interfaces.ResourceEnvironment
|
|
1338
|
+
|
|
1339
|
+
The environment this resource belongs to.
|
|
1340
|
+
|
|
1341
|
+
For resources that are created and managed in a Stack (those created by
|
|
1342
|
+
creating new class instances like `new Role()`, `new Bucket()`, etc.), this
|
|
1343
|
+
is always the same as the environment of the stack they belong to.
|
|
1344
|
+
|
|
1345
|
+
For referenced resources (those obtained from referencing methods like
|
|
1346
|
+
`Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
|
|
1347
|
+
different than the stack they were imported into.
|
|
1348
|
+
|
|
1349
|
+
---
|
|
1350
|
+
|
|
1351
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.stack"></a>
|
|
1352
|
+
|
|
1353
|
+
```typescript
|
|
1354
|
+
public readonly stack: Stack;
|
|
1355
|
+
```
|
|
1356
|
+
|
|
1357
|
+
- *Type:* aws-cdk-lib.Stack
|
|
1358
|
+
|
|
1359
|
+
The stack in which this resource is defined.
|
|
1360
|
+
|
|
1361
|
+
---
|
|
1362
|
+
|
|
1363
|
+
##### `data`<sup>Required</sup> <a name="data" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.data"></a>
|
|
1364
|
+
|
|
1365
|
+
```typescript
|
|
1366
|
+
public readonly data: string;
|
|
1367
|
+
```
|
|
1368
|
+
|
|
1369
|
+
- *Type:* string
|
|
1370
|
+
|
|
1371
|
+
The rules file used in the namespace.
|
|
1372
|
+
|
|
1373
|
+
---
|
|
1374
|
+
|
|
1375
|
+
##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.name"></a>
|
|
1376
|
+
|
|
1377
|
+
```typescript
|
|
1378
|
+
public readonly name: string;
|
|
1379
|
+
```
|
|
1380
|
+
|
|
1381
|
+
- *Type:* string
|
|
1382
|
+
|
|
1383
|
+
The name of the rule groups namespace.
|
|
1384
|
+
|
|
1385
|
+
---
|
|
1386
|
+
|
|
1387
|
+
##### `ruleGroupsNamespaceArn`<sup>Required</sup> <a name="ruleGroupsNamespaceArn" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.ruleGroupsNamespaceArn"></a>
|
|
1388
|
+
|
|
1389
|
+
```typescript
|
|
1390
|
+
public readonly ruleGroupsNamespaceArn: string;
|
|
1391
|
+
```
|
|
1392
|
+
|
|
1393
|
+
- *Type:* string
|
|
1394
|
+
|
|
1395
|
+
The workspace to add the rule groups namespace.
|
|
1396
|
+
|
|
1397
|
+
---
|
|
1398
|
+
|
|
1399
|
+
##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespace.property.workspace"></a>
|
|
1400
|
+
|
|
1401
|
+
```typescript
|
|
1402
|
+
public readonly workspace: IWorkspace;
|
|
1403
|
+
```
|
|
1404
|
+
|
|
1405
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
|
|
1406
|
+
|
|
1407
|
+
The workspace to add the rule groups namespace.
|
|
1408
|
+
|
|
1409
|
+
---
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
### RuleGroupsNamespaceBase <a name="RuleGroupsNamespaceBase" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase"></a>
|
|
1413
|
+
|
|
1414
|
+
- *Implements:* <a href="#@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace">IRuleGroupsNamespace</a>
|
|
1415
|
+
|
|
1416
|
+
#### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer"></a>
|
|
1417
|
+
|
|
1418
|
+
```typescript
|
|
1419
|
+
import { RuleGroupsNamespaceBase } from '@robhan-cdk-lib/aws_aps'
|
|
1420
|
+
|
|
1421
|
+
new RuleGroupsNamespaceBase(scope: Construct, id: string, props?: ResourceProps)
|
|
1422
|
+
```
|
|
1423
|
+
|
|
1424
|
+
| **Name** | **Type** | **Description** |
|
|
1425
|
+
| --- | --- | --- |
|
|
1426
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
1427
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
1428
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer.parameter.props">props</a></code> | <code>aws-cdk-lib.ResourceProps</code> | *No description.* |
|
|
1429
|
+
|
|
1430
|
+
---
|
|
1431
|
+
|
|
1432
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer.parameter.scope"></a>
|
|
1433
|
+
|
|
1434
|
+
- *Type:* constructs.Construct
|
|
1435
|
+
|
|
1436
|
+
---
|
|
1437
|
+
|
|
1438
|
+
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer.parameter.id"></a>
|
|
1439
|
+
|
|
1440
|
+
- *Type:* string
|
|
1441
|
+
|
|
1442
|
+
---
|
|
1443
|
+
|
|
1444
|
+
##### `props`<sup>Optional</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.Initializer.parameter.props"></a>
|
|
1445
|
+
|
|
1446
|
+
- *Type:* aws-cdk-lib.ResourceProps
|
|
1447
|
+
|
|
1448
|
+
---
|
|
1449
|
+
|
|
1450
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
1451
|
+
|
|
1452
|
+
| **Name** | **Description** |
|
|
1453
|
+
| --- | --- |
|
|
1454
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
1455
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
1456
|
+
|
|
1457
|
+
---
|
|
1458
|
+
|
|
1459
|
+
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.toString"></a>
|
|
1460
|
+
|
|
1461
|
+
```typescript
|
|
1462
|
+
public toString(): string
|
|
1463
|
+
```
|
|
1464
|
+
|
|
1465
|
+
Returns a string representation of this construct.
|
|
1466
|
+
|
|
1467
|
+
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.applyRemovalPolicy"></a>
|
|
1468
|
+
|
|
1469
|
+
```typescript
|
|
1470
|
+
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
1471
|
+
```
|
|
1472
|
+
|
|
1473
|
+
Apply the given removal policy to this resource.
|
|
1474
|
+
|
|
1475
|
+
The Removal Policy controls what happens to this resource when it stops
|
|
1476
|
+
being managed by CloudFormation, either because you've removed it from the
|
|
1477
|
+
CDK application or because you've made a change that requires the resource
|
|
1478
|
+
to be replaced.
|
|
1479
|
+
|
|
1480
|
+
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
1481
|
+
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
1482
|
+
|
|
1483
|
+
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.applyRemovalPolicy.parameter.policy"></a>
|
|
1484
|
+
|
|
1485
|
+
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
1486
|
+
|
|
1487
|
+
---
|
|
1488
|
+
|
|
1489
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
1490
|
+
|
|
1491
|
+
| **Name** | **Description** |
|
|
1492
|
+
| --- | --- |
|
|
1493
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
1494
|
+
| <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. |
|
|
1495
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
1496
|
+
|
|
1497
|
+
---
|
|
1498
|
+
|
|
1499
|
+
##### `isConstruct` <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isConstruct"></a>
|
|
1500
|
+
|
|
1501
|
+
```typescript
|
|
1502
|
+
import { RuleGroupsNamespaceBase } from '@robhan-cdk-lib/aws_aps'
|
|
1503
|
+
|
|
1504
|
+
RuleGroupsNamespaceBase.isConstruct(x: any)
|
|
1505
|
+
```
|
|
1506
|
+
|
|
1507
|
+
Checks if `x` is a construct.
|
|
1508
|
+
|
|
1509
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
1510
|
+
instances, even when the construct library is symlinked.
|
|
1511
|
+
|
|
1512
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
1513
|
+
disk are seen as independent, completely different libraries. As a
|
|
1514
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
1515
|
+
is seen as a different class, and an instance of one class will not test as
|
|
1516
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
1517
|
+
like this, but users may manually symlink construct libraries together or
|
|
1518
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
1519
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
1520
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
1521
|
+
this type-testing method instead.
|
|
1522
|
+
|
|
1523
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isConstruct.parameter.x"></a>
|
|
1524
|
+
|
|
1525
|
+
- *Type:* any
|
|
1526
|
+
|
|
1527
|
+
Any object.
|
|
1528
|
+
|
|
1529
|
+
---
|
|
1530
|
+
|
|
1531
|
+
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isOwnedResource"></a>
|
|
1532
|
+
|
|
1533
|
+
```typescript
|
|
1534
|
+
import { RuleGroupsNamespaceBase } from '@robhan-cdk-lib/aws_aps'
|
|
1535
|
+
|
|
1536
|
+
RuleGroupsNamespaceBase.isOwnedResource(construct: IConstruct)
|
|
1537
|
+
```
|
|
1538
|
+
|
|
1539
|
+
Returns true if the construct was created by CDK, and false otherwise.
|
|
1540
|
+
|
|
1541
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isOwnedResource.parameter.construct"></a>
|
|
1542
|
+
|
|
1543
|
+
- *Type:* constructs.IConstruct
|
|
1544
|
+
|
|
1545
|
+
---
|
|
1546
|
+
|
|
1547
|
+
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isResource"></a>
|
|
1548
|
+
|
|
1549
|
+
```typescript
|
|
1550
|
+
import { RuleGroupsNamespaceBase } from '@robhan-cdk-lib/aws_aps'
|
|
1551
|
+
|
|
1552
|
+
RuleGroupsNamespaceBase.isResource(construct: IConstruct)
|
|
1553
|
+
```
|
|
1554
|
+
|
|
1555
|
+
Check whether the given construct is a Resource.
|
|
1556
|
+
|
|
1557
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.isResource.parameter.construct"></a>
|
|
1558
|
+
|
|
1559
|
+
- *Type:* constructs.IConstruct
|
|
1560
|
+
|
|
1561
|
+
---
|
|
1562
|
+
|
|
1563
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1564
|
+
|
|
1565
|
+
| **Name** | **Type** | **Description** |
|
|
1566
|
+
| --- | --- | --- |
|
|
1567
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
1568
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
1569
|
+
| <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. |
|
|
1570
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.data">data</a></code> | <code>string</code> | The rules file used in the namespace. |
|
|
1571
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.name">name</a></code> | <code>string</code> | The name of the rule groups namespace. |
|
|
1572
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.ruleGroupsNamespaceArn">ruleGroupsNamespaceArn</a></code> | <code>string</code> | The ARN of the rule groups namespace. |
|
|
1573
|
+
| <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. |
|
|
1574
|
+
|
|
1575
|
+
---
|
|
1576
|
+
|
|
1577
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.node"></a>
|
|
1578
|
+
|
|
1579
|
+
```typescript
|
|
1580
|
+
public readonly node: Node;
|
|
1581
|
+
```
|
|
1582
|
+
|
|
1583
|
+
- *Type:* constructs.Node
|
|
1584
|
+
|
|
1585
|
+
The tree node.
|
|
1586
|
+
|
|
1587
|
+
---
|
|
1588
|
+
|
|
1589
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.env"></a>
|
|
1590
|
+
|
|
1591
|
+
```typescript
|
|
1592
|
+
public readonly env: ResourceEnvironment;
|
|
1593
|
+
```
|
|
1594
|
+
|
|
1595
|
+
- *Type:* aws-cdk-lib.interfaces.ResourceEnvironment
|
|
1596
|
+
|
|
1597
|
+
The environment this resource belongs to.
|
|
1598
|
+
|
|
1599
|
+
For resources that are created and managed in a Stack (those created by
|
|
1600
|
+
creating new class instances like `new Role()`, `new Bucket()`, etc.), this
|
|
1601
|
+
is always the same as the environment of the stack they belong to.
|
|
1602
|
+
|
|
1603
|
+
For referenced resources (those obtained from referencing methods like
|
|
1604
|
+
`Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
|
|
1605
|
+
different than the stack they were imported into.
|
|
1606
|
+
|
|
1607
|
+
---
|
|
1608
|
+
|
|
1609
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.stack"></a>
|
|
1610
|
+
|
|
1611
|
+
```typescript
|
|
1612
|
+
public readonly stack: Stack;
|
|
1613
|
+
```
|
|
1614
|
+
|
|
1615
|
+
- *Type:* aws-cdk-lib.Stack
|
|
1616
|
+
|
|
1617
|
+
The stack in which this resource is defined.
|
|
1618
|
+
|
|
1619
|
+
---
|
|
1620
|
+
|
|
1621
|
+
##### `data`<sup>Required</sup> <a name="data" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.data"></a>
|
|
1622
|
+
|
|
1623
|
+
```typescript
|
|
1624
|
+
public readonly data: string;
|
|
1625
|
+
```
|
|
1626
|
+
|
|
1627
|
+
- *Type:* string
|
|
1628
|
+
|
|
1629
|
+
The rules file used in the namespace.
|
|
1630
|
+
|
|
1631
|
+
---
|
|
1632
|
+
|
|
1633
|
+
##### `name`<sup>Required</sup> <a name="name" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.name"></a>
|
|
1634
|
+
|
|
1635
|
+
```typescript
|
|
1636
|
+
public readonly name: string;
|
|
1637
|
+
```
|
|
1638
|
+
|
|
1639
|
+
- *Type:* string
|
|
1640
|
+
|
|
1641
|
+
The name of the rule groups namespace.
|
|
1642
|
+
|
|
1643
|
+
---
|
|
1644
|
+
|
|
1645
|
+
##### `ruleGroupsNamespaceArn`<sup>Required</sup> <a name="ruleGroupsNamespaceArn" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.ruleGroupsNamespaceArn"></a>
|
|
1646
|
+
|
|
1647
|
+
```typescript
|
|
1648
|
+
public readonly ruleGroupsNamespaceArn: string;
|
|
1649
|
+
```
|
|
1650
|
+
|
|
1651
|
+
- *Type:* string
|
|
1652
|
+
|
|
1653
|
+
The ARN of the rule groups namespace.
|
|
1654
|
+
|
|
1655
|
+
---
|
|
1656
|
+
|
|
1657
|
+
##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.RuleGroupsNamespaceBase.property.workspace"></a>
|
|
1658
|
+
|
|
1659
|
+
```typescript
|
|
1660
|
+
public readonly workspace: IWorkspace;
|
|
1661
|
+
```
|
|
1662
|
+
|
|
1663
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
|
|
1664
|
+
|
|
1665
|
+
The workspace to add the rule groups namespace.
|
|
1666
|
+
|
|
1667
|
+
---
|
|
1668
|
+
|
|
1669
|
+
|
|
1670
|
+
### Scraper <a name="Scraper" id="@robhan-cdk-lib/aws_aps.Scraper"></a>
|
|
1671
|
+
|
|
1672
|
+
#### Initializers <a name="Initializers" id="@robhan-cdk-lib/aws_aps.Scraper.Initializer"></a>
|
|
1673
|
+
|
|
1674
|
+
```typescript
|
|
1675
|
+
import { Scraper } from '@robhan-cdk-lib/aws_aps'
|
|
1676
|
+
|
|
1677
|
+
new Scraper(scope: Construct, id: string, props: ScraperProps)
|
|
1678
|
+
```
|
|
1679
|
+
|
|
1680
|
+
| **Name** | **Type** | **Description** |
|
|
1681
|
+
| --- | --- | --- |
|
|
1682
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
|
|
1683
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
|
|
1684
|
+
| <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.* |
|
|
1685
|
+
|
|
1686
|
+
---
|
|
1687
|
+
|
|
1688
|
+
##### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.Scraper.Initializer.parameter.scope"></a>
|
|
1689
|
+
|
|
1690
|
+
- *Type:* constructs.Construct
|
|
1691
|
+
|
|
1692
|
+
---
|
|
1693
|
+
|
|
1694
|
+
##### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.Scraper.Initializer.parameter.id"></a>
|
|
1695
|
+
|
|
1696
|
+
- *Type:* string
|
|
1697
|
+
|
|
1698
|
+
---
|
|
1699
|
+
|
|
1700
|
+
##### `props`<sup>Required</sup> <a name="props" id="@robhan-cdk-lib/aws_aps.Scraper.Initializer.parameter.props"></a>
|
|
1701
|
+
|
|
1702
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.ScraperProps">ScraperProps</a>
|
|
1703
|
+
|
|
1704
|
+
---
|
|
1705
|
+
|
|
1706
|
+
#### Methods <a name="Methods" id="Methods"></a>
|
|
1707
|
+
|
|
1708
|
+
| **Name** | **Description** |
|
|
1709
|
+
| --- | --- |
|
|
1710
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.toString">toString</a></code> | Returns a string representation of this construct. |
|
|
1711
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.applyRemovalPolicy">applyRemovalPolicy</a></code> | Apply the given removal policy to this resource. |
|
|
1712
|
+
|
|
1713
|
+
---
|
|
1714
|
+
|
|
1715
|
+
##### `toString` <a name="toString" id="@robhan-cdk-lib/aws_aps.Scraper.toString"></a>
|
|
1716
|
+
|
|
1717
|
+
```typescript
|
|
1718
|
+
public toString(): string
|
|
1719
|
+
```
|
|
1720
|
+
|
|
1721
|
+
Returns a string representation of this construct.
|
|
1722
|
+
|
|
1723
|
+
##### `applyRemovalPolicy` <a name="applyRemovalPolicy" id="@robhan-cdk-lib/aws_aps.Scraper.applyRemovalPolicy"></a>
|
|
1724
|
+
|
|
1725
|
+
```typescript
|
|
1726
|
+
public applyRemovalPolicy(policy: RemovalPolicy): void
|
|
1727
|
+
```
|
|
1728
|
+
|
|
1729
|
+
Apply the given removal policy to this resource.
|
|
1730
|
+
|
|
1731
|
+
The Removal Policy controls what happens to this resource when it stops
|
|
1732
|
+
being managed by CloudFormation, either because you've removed it from the
|
|
1733
|
+
CDK application or because you've made a change that requires the resource
|
|
1734
|
+
to be replaced.
|
|
1735
|
+
|
|
1736
|
+
The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
|
|
1737
|
+
account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
|
|
1738
|
+
|
|
1739
|
+
###### `policy`<sup>Required</sup> <a name="policy" id="@robhan-cdk-lib/aws_aps.Scraper.applyRemovalPolicy.parameter.policy"></a>
|
|
1740
|
+
|
|
1741
|
+
- *Type:* aws-cdk-lib.RemovalPolicy
|
|
1742
|
+
|
|
1743
|
+
---
|
|
1744
|
+
|
|
1745
|
+
#### Static Functions <a name="Static Functions" id="Static Functions"></a>
|
|
1746
|
+
|
|
1747
|
+
| **Name** | **Description** |
|
|
1748
|
+
| --- | --- |
|
|
1749
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
|
|
1750
|
+
| <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. |
|
|
1751
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.isResource">isResource</a></code> | Check whether the given construct is a Resource. |
|
|
1752
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.fromScraperAttributes">fromScraperAttributes</a></code> | *No description.* |
|
|
1753
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.Scraper.isScraper">isScraper</a></code> | *No description.* |
|
|
1754
|
+
|
|
1755
|
+
---
|
|
1756
|
+
|
|
1757
|
+
##### `isConstruct` <a name="isConstruct" id="@robhan-cdk-lib/aws_aps.Scraper.isConstruct"></a>
|
|
1758
|
+
|
|
1759
|
+
```typescript
|
|
1760
|
+
import { Scraper } from '@robhan-cdk-lib/aws_aps'
|
|
1761
|
+
|
|
1762
|
+
Scraper.isConstruct(x: any)
|
|
1763
|
+
```
|
|
1764
|
+
|
|
1765
|
+
Checks if `x` is a construct.
|
|
1766
|
+
|
|
1767
|
+
Use this method instead of `instanceof` to properly detect `Construct`
|
|
1768
|
+
instances, even when the construct library is symlinked.
|
|
1769
|
+
|
|
1770
|
+
Explanation: in JavaScript, multiple copies of the `constructs` library on
|
|
1771
|
+
disk are seen as independent, completely different libraries. As a
|
|
1772
|
+
consequence, the class `Construct` in each copy of the `constructs` library
|
|
1773
|
+
is seen as a different class, and an instance of one class will not test as
|
|
1774
|
+
`instanceof` the other class. `npm install` will not create installations
|
|
1775
|
+
like this, but users may manually symlink construct libraries together or
|
|
1776
|
+
use a monorepo tool: in those cases, multiple copies of the `constructs`
|
|
1777
|
+
library can be accidentally installed, and `instanceof` will behave
|
|
1778
|
+
unpredictably. It is safest to avoid using `instanceof`, and using
|
|
1779
|
+
this type-testing method instead.
|
|
1780
|
+
|
|
1781
|
+
###### `x`<sup>Required</sup> <a name="x" id="@robhan-cdk-lib/aws_aps.Scraper.isConstruct.parameter.x"></a>
|
|
1782
|
+
|
|
1783
|
+
- *Type:* any
|
|
1784
|
+
|
|
1785
|
+
Any object.
|
|
1786
|
+
|
|
1787
|
+
---
|
|
1788
|
+
|
|
1789
|
+
##### `isOwnedResource` <a name="isOwnedResource" id="@robhan-cdk-lib/aws_aps.Scraper.isOwnedResource"></a>
|
|
1790
|
+
|
|
1791
|
+
```typescript
|
|
1792
|
+
import { Scraper } from '@robhan-cdk-lib/aws_aps'
|
|
1793
|
+
|
|
1794
|
+
Scraper.isOwnedResource(construct: IConstruct)
|
|
1795
|
+
```
|
|
1796
|
+
|
|
1797
|
+
Returns true if the construct was created by CDK, and false otherwise.
|
|
1798
|
+
|
|
1799
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.Scraper.isOwnedResource.parameter.construct"></a>
|
|
1800
|
+
|
|
1801
|
+
- *Type:* constructs.IConstruct
|
|
1802
|
+
|
|
1803
|
+
---
|
|
1804
|
+
|
|
1805
|
+
##### `isResource` <a name="isResource" id="@robhan-cdk-lib/aws_aps.Scraper.isResource"></a>
|
|
1806
|
+
|
|
1807
|
+
```typescript
|
|
1808
|
+
import { Scraper } from '@robhan-cdk-lib/aws_aps'
|
|
1809
|
+
|
|
1810
|
+
Scraper.isResource(construct: IConstruct)
|
|
1811
|
+
```
|
|
1812
|
+
|
|
1813
|
+
Check whether the given construct is a Resource.
|
|
1814
|
+
|
|
1815
|
+
###### `construct`<sup>Required</sup> <a name="construct" id="@robhan-cdk-lib/aws_aps.Scraper.isResource.parameter.construct"></a>
|
|
1816
|
+
|
|
1817
|
+
- *Type:* constructs.IConstruct
|
|
1818
|
+
|
|
1819
|
+
---
|
|
1820
|
+
|
|
1821
|
+
##### `fromScraperAttributes` <a name="fromScraperAttributes" id="@robhan-cdk-lib/aws_aps.Scraper.fromScraperAttributes"></a>
|
|
1822
|
+
|
|
1823
|
+
```typescript
|
|
1824
|
+
import { Scraper } from '@robhan-cdk-lib/aws_aps'
|
|
1825
|
+
|
|
1826
|
+
Scraper.fromScraperAttributes(scope: Construct, id: string, attrs: ScraperAttributes)
|
|
1827
|
+
```
|
|
1828
|
+
|
|
1829
|
+
###### `scope`<sup>Required</sup> <a name="scope" id="@robhan-cdk-lib/aws_aps.Scraper.fromScraperAttributes.parameter.scope"></a>
|
|
1830
|
+
|
|
1831
|
+
- *Type:* constructs.Construct
|
|
1832
|
+
|
|
1833
|
+
---
|
|
1834
|
+
|
|
1835
|
+
###### `id`<sup>Required</sup> <a name="id" id="@robhan-cdk-lib/aws_aps.Scraper.fromScraperAttributes.parameter.id"></a>
|
|
1836
|
+
|
|
1837
|
+
- *Type:* string
|
|
1838
|
+
|
|
1839
|
+
---
|
|
1840
|
+
|
|
1841
|
+
###### `attrs`<sup>Required</sup> <a name="attrs" id="@robhan-cdk-lib/aws_aps.Scraper.fromScraperAttributes.parameter.attrs"></a>
|
|
1842
|
+
|
|
1843
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.ScraperAttributes">ScraperAttributes</a>
|
|
1844
|
+
|
|
1845
|
+
---
|
|
1846
|
+
|
|
1847
|
+
##### `isScraper` <a name="isScraper" id="@robhan-cdk-lib/aws_aps.Scraper.isScraper"></a>
|
|
744
1848
|
|
|
745
1849
|
```typescript
|
|
746
1850
|
import { Scraper } from '@robhan-cdk-lib/aws_aps'
|
|
@@ -1788,133 +2892,271 @@ The stack in which this resource is defined.
|
|
|
1788
2892
|
public readonly workspaceArn: string;
|
|
1789
2893
|
```
|
|
1790
2894
|
|
|
1791
|
-
- *Type:* string
|
|
2895
|
+
- *Type:* string
|
|
2896
|
+
|
|
2897
|
+
The ARN of the workspace.
|
|
2898
|
+
|
|
2899
|
+
---
|
|
2900
|
+
|
|
2901
|
+
##### `workspaceId`<sup>Required</sup> <a name="workspaceId" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.workspaceId"></a>
|
|
2902
|
+
|
|
2903
|
+
```typescript
|
|
2904
|
+
public readonly workspaceId: string;
|
|
2905
|
+
```
|
|
2906
|
+
|
|
2907
|
+
- *Type:* string
|
|
2908
|
+
|
|
2909
|
+
The unique ID for the workspace.
|
|
2910
|
+
|
|
2911
|
+
---
|
|
2912
|
+
|
|
2913
|
+
##### `alertManagerDefinition`<sup>Optional</sup> <a name="alertManagerDefinition" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.alertManagerDefinition"></a>
|
|
2914
|
+
|
|
2915
|
+
```typescript
|
|
2916
|
+
public readonly alertManagerDefinition: string;
|
|
2917
|
+
```
|
|
2918
|
+
|
|
2919
|
+
- *Type:* string
|
|
2920
|
+
|
|
2921
|
+
The alert manager definition, a YAML configuration for the alert manager in your Amazon Managed Service for Prometheus workspace.
|
|
2922
|
+
|
|
2923
|
+
---
|
|
2924
|
+
|
|
2925
|
+
##### `alias`<sup>Optional</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.alias"></a>
|
|
2926
|
+
|
|
2927
|
+
```typescript
|
|
2928
|
+
public readonly alias: string;
|
|
2929
|
+
```
|
|
2930
|
+
|
|
2931
|
+
- *Type:* string
|
|
2932
|
+
|
|
2933
|
+
The alias that is assigned to this workspace to help identify it.
|
|
2934
|
+
|
|
2935
|
+
It does not need to be
|
|
2936
|
+
unique.
|
|
2937
|
+
|
|
2938
|
+
---
|
|
2939
|
+
|
|
2940
|
+
##### `kmsKey`<sup>Optional</sup> <a name="kmsKey" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.kmsKey"></a>
|
|
2941
|
+
|
|
2942
|
+
```typescript
|
|
2943
|
+
public readonly kmsKey: IKey;
|
|
2944
|
+
```
|
|
2945
|
+
|
|
2946
|
+
- *Type:* aws-cdk-lib.aws_kms.IKey
|
|
2947
|
+
|
|
2948
|
+
The customer managed AWS KMS key to use for encrypting data within your workspace.
|
|
2949
|
+
|
|
2950
|
+
---
|
|
2951
|
+
|
|
2952
|
+
##### `loggingConfiguration`<sup>Optional</sup> <a name="loggingConfiguration" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.loggingConfiguration"></a>
|
|
2953
|
+
|
|
2954
|
+
```typescript
|
|
2955
|
+
public readonly loggingConfiguration: LoggingConfiguration;
|
|
2956
|
+
```
|
|
2957
|
+
|
|
2958
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.LoggingConfiguration">LoggingConfiguration</a>
|
|
2959
|
+
|
|
2960
|
+
Contains information about the current rules and alerting logging configuration for the workspace.
|
|
2961
|
+
|
|
2962
|
+
Note: These logging configurations are only for rules and alerting logs.
|
|
2963
|
+
|
|
2964
|
+
---
|
|
2965
|
+
|
|
2966
|
+
##### `queryLoggingConfiguration`<sup>Optional</sup> <a name="queryLoggingConfiguration" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.queryLoggingConfiguration"></a>
|
|
2967
|
+
|
|
2968
|
+
```typescript
|
|
2969
|
+
public readonly queryLoggingConfiguration: QueryLoggingConfiguration;
|
|
2970
|
+
```
|
|
2971
|
+
|
|
2972
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration">QueryLoggingConfiguration</a>
|
|
2973
|
+
|
|
2974
|
+
The definition of logging configuration in an Amazon Managed Service for Prometheus workspace.
|
|
2975
|
+
|
|
2976
|
+
---
|
|
2977
|
+
|
|
2978
|
+
##### `workspaceConfiguration`<sup>Optional</sup> <a name="workspaceConfiguration" id="@robhan-cdk-lib/aws_aps.WorkspaceBase.property.workspaceConfiguration"></a>
|
|
2979
|
+
|
|
2980
|
+
```typescript
|
|
2981
|
+
public readonly workspaceConfiguration: WorkspaceConfiguration;
|
|
2982
|
+
```
|
|
2983
|
+
|
|
2984
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.WorkspaceConfiguration">WorkspaceConfiguration</a>
|
|
2985
|
+
|
|
2986
|
+
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.
|
|
2987
|
+
|
|
2988
|
+
---
|
|
2989
|
+
|
|
2990
|
+
|
|
2991
|
+
## Structs <a name="Structs" id="Structs"></a>
|
|
2992
|
+
|
|
2993
|
+
### AmpConfiguration <a name="AmpConfiguration" id="@robhan-cdk-lib/aws_aps.AmpConfiguration"></a>
|
|
2994
|
+
|
|
2995
|
+
The AmpConfiguration structure defines the Amazon Managed Service for Prometheus instance a scraper should send metrics to.
|
|
2996
|
+
|
|
2997
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.AmpConfiguration.Initializer"></a>
|
|
2998
|
+
|
|
2999
|
+
```typescript
|
|
3000
|
+
import { AmpConfiguration } from '@robhan-cdk-lib/aws_aps'
|
|
3001
|
+
|
|
3002
|
+
const ampConfiguration: AmpConfiguration = { ... }
|
|
3003
|
+
```
|
|
3004
|
+
|
|
3005
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1792
3006
|
|
|
1793
|
-
|
|
3007
|
+
| **Name** | **Type** | **Description** |
|
|
3008
|
+
| --- | --- | --- |
|
|
3009
|
+
| <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. |
|
|
1794
3010
|
|
|
1795
3011
|
---
|
|
1796
3012
|
|
|
1797
|
-
##### `
|
|
3013
|
+
##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.AmpConfiguration.property.workspace"></a>
|
|
1798
3014
|
|
|
1799
3015
|
```typescript
|
|
1800
|
-
public readonly
|
|
3016
|
+
public readonly workspace: IWorkspace;
|
|
1801
3017
|
```
|
|
1802
3018
|
|
|
1803
|
-
- *Type:*
|
|
3019
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
|
|
1804
3020
|
|
|
1805
|
-
The
|
|
3021
|
+
The Amazon Managed Service for Prometheus workspace.
|
|
1806
3022
|
|
|
1807
3023
|
---
|
|
1808
3024
|
|
|
1809
|
-
|
|
3025
|
+
### AnomalyDetectorConfiguration <a name="AnomalyDetectorConfiguration" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorConfiguration"></a>
|
|
3026
|
+
|
|
3027
|
+
The configuration for the anomaly detection algorithm.
|
|
3028
|
+
|
|
3029
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorConfiguration.Initializer"></a>
|
|
1810
3030
|
|
|
1811
3031
|
```typescript
|
|
1812
|
-
|
|
3032
|
+
import { AnomalyDetectorConfiguration } from '@robhan-cdk-lib/aws_aps'
|
|
3033
|
+
|
|
3034
|
+
const anomalyDetectorConfiguration: AnomalyDetectorConfiguration = { ... }
|
|
1813
3035
|
```
|
|
1814
3036
|
|
|
1815
|
-
|
|
3037
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1816
3038
|
|
|
1817
|
-
|
|
3039
|
+
| **Name** | **Type** | **Description** |
|
|
3040
|
+
| --- | --- | --- |
|
|
3041
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorConfiguration.property.randomCutForest">randomCutForest</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration">RandomCutForestConfiguration</a></code> | The Random Cut Forest algorithm configuration for anomaly detection. |
|
|
1818
3042
|
|
|
1819
3043
|
---
|
|
1820
3044
|
|
|
1821
|
-
##### `
|
|
3045
|
+
##### `randomCutForest`<sup>Required</sup> <a name="randomCutForest" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorConfiguration.property.randomCutForest"></a>
|
|
1822
3046
|
|
|
1823
3047
|
```typescript
|
|
1824
|
-
public readonly
|
|
3048
|
+
public readonly randomCutForest: RandomCutForestConfiguration;
|
|
1825
3049
|
```
|
|
1826
3050
|
|
|
1827
|
-
- *Type:*
|
|
1828
|
-
|
|
1829
|
-
The alias that is assigned to this workspace to help identify it.
|
|
3051
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration">RandomCutForestConfiguration</a>
|
|
1830
3052
|
|
|
1831
|
-
|
|
1832
|
-
unique.
|
|
3053
|
+
The Random Cut Forest algorithm configuration for anomaly detection.
|
|
1833
3054
|
|
|
1834
3055
|
---
|
|
1835
3056
|
|
|
1836
|
-
|
|
3057
|
+
### AnomalyDetectorProps <a name="AnomalyDetectorProps" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorProps"></a>
|
|
3058
|
+
|
|
3059
|
+
Properties for creating an Amazon Managed Service for Prometheus Anomaly Detector.
|
|
3060
|
+
|
|
3061
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorProps.Initializer"></a>
|
|
1837
3062
|
|
|
1838
3063
|
```typescript
|
|
1839
|
-
|
|
3064
|
+
import { AnomalyDetectorProps } from '@robhan-cdk-lib/aws_aps'
|
|
3065
|
+
|
|
3066
|
+
const anomalyDetectorProps: AnomalyDetectorProps = { ... }
|
|
1840
3067
|
```
|
|
1841
3068
|
|
|
1842
|
-
|
|
3069
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
1843
3070
|
|
|
1844
|
-
|
|
3071
|
+
| **Name** | **Type** | **Description** |
|
|
3072
|
+
| --- | --- | --- |
|
|
3073
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorProps.property.alias">alias</a></code> | <code>string</code> | The user-friendly name of the anomaly detector. |
|
|
3074
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorProps.property.configuration">configuration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorConfiguration">AnomalyDetectorConfiguration</a></code> | The algorithm configuration of the anomaly detector. |
|
|
3075
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorProps.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics. |
|
|
3076
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorProps.property.evaluationIntervalInSeconds">evaluationIntervalInSeconds</a></code> | <code>number</code> | The frequency, in seconds, at which the anomaly detector evaluates metrics. |
|
|
3077
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorProps.property.labels">labels</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Label">Label</a>[]</code> | The Amazon Managed Service for Prometheus metric labels associated with the anomaly detector. |
|
|
3078
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorProps.property.missingDataAction">missingDataAction</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.MissingDataAction">MissingDataAction</a></code> | The action taken when data is missing during evaluation. |
|
|
1845
3079
|
|
|
1846
3080
|
---
|
|
1847
3081
|
|
|
1848
|
-
##### `
|
|
3082
|
+
##### `alias`<sup>Required</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorProps.property.alias"></a>
|
|
1849
3083
|
|
|
1850
3084
|
```typescript
|
|
1851
|
-
public readonly
|
|
3085
|
+
public readonly alias: string;
|
|
1852
3086
|
```
|
|
1853
3087
|
|
|
1854
|
-
- *Type:*
|
|
3088
|
+
- *Type:* string
|
|
1855
3089
|
|
|
1856
|
-
|
|
3090
|
+
The user-friendly name of the anomaly detector.
|
|
1857
3091
|
|
|
1858
|
-
|
|
3092
|
+
1 to 128 characters length.
|
|
1859
3093
|
|
|
1860
3094
|
---
|
|
1861
3095
|
|
|
1862
|
-
##### `
|
|
3096
|
+
##### `configuration`<sup>Required</sup> <a name="configuration" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorProps.property.configuration"></a>
|
|
1863
3097
|
|
|
1864
3098
|
```typescript
|
|
1865
|
-
public readonly
|
|
3099
|
+
public readonly configuration: AnomalyDetectorConfiguration;
|
|
1866
3100
|
```
|
|
1867
3101
|
|
|
1868
|
-
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.
|
|
3102
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorConfiguration">AnomalyDetectorConfiguration</a>
|
|
1869
3103
|
|
|
1870
|
-
The
|
|
3104
|
+
The algorithm configuration of the anomaly detector.
|
|
1871
3105
|
|
|
1872
3106
|
---
|
|
1873
3107
|
|
|
1874
|
-
##### `
|
|
3108
|
+
##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorProps.property.workspace"></a>
|
|
1875
3109
|
|
|
1876
3110
|
```typescript
|
|
1877
|
-
public readonly
|
|
3111
|
+
public readonly workspace: IWorkspace;
|
|
1878
3112
|
```
|
|
1879
3113
|
|
|
1880
|
-
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.
|
|
3114
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
|
|
1881
3115
|
|
|
1882
|
-
|
|
3116
|
+
An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.
|
|
1883
3117
|
|
|
1884
3118
|
---
|
|
1885
3119
|
|
|
3120
|
+
##### `evaluationIntervalInSeconds`<sup>Optional</sup> <a name="evaluationIntervalInSeconds" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorProps.property.evaluationIntervalInSeconds"></a>
|
|
1886
3121
|
|
|
1887
|
-
|
|
3122
|
+
```typescript
|
|
3123
|
+
public readonly evaluationIntervalInSeconds: number;
|
|
3124
|
+
```
|
|
1888
3125
|
|
|
1889
|
-
|
|
3126
|
+
- *Type:* number
|
|
1890
3127
|
|
|
1891
|
-
The
|
|
3128
|
+
The frequency, in seconds, at which the anomaly detector evaluates metrics.
|
|
1892
3129
|
|
|
1893
|
-
|
|
3130
|
+
Minimum value of 30. Maximum value of 86400.
|
|
1894
3131
|
|
|
1895
|
-
|
|
1896
|
-
import { AmpConfiguration } from '@robhan-cdk-lib/aws_aps'
|
|
3132
|
+
---
|
|
1897
3133
|
|
|
1898
|
-
|
|
3134
|
+
##### `labels`<sup>Optional</sup> <a name="labels" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorProps.property.labels"></a>
|
|
3135
|
+
|
|
3136
|
+
```typescript
|
|
3137
|
+
public readonly labels: Label[];
|
|
1899
3138
|
```
|
|
1900
3139
|
|
|
1901
|
-
|
|
3140
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.Label">Label</a>[]
|
|
1902
3141
|
|
|
1903
|
-
|
|
1904
|
-
|
|
1905
|
-
|
|
3142
|
+
The Amazon Managed Service for Prometheus metric labels associated with the anomaly detector.
|
|
3143
|
+
|
|
3144
|
+
Map Entries: Minimum number of 0 items. Maximum number of 140 items.
|
|
3145
|
+
Key Length Constraints: Minimum length of 1. Maximum length of 7168.
|
|
3146
|
+
Key Pattern: (?!__)[a-zA-Z_][a-zA-Z0-9_]*
|
|
3147
|
+
Value Length Constraints: Minimum length of 1. Maximum length of 7168.
|
|
1906
3148
|
|
|
1907
3149
|
---
|
|
1908
3150
|
|
|
1909
|
-
##### `
|
|
3151
|
+
##### `missingDataAction`<sup>Optional</sup> <a name="missingDataAction" id="@robhan-cdk-lib/aws_aps.AnomalyDetectorProps.property.missingDataAction"></a>
|
|
1910
3152
|
|
|
1911
3153
|
```typescript
|
|
1912
|
-
public readonly
|
|
3154
|
+
public readonly missingDataAction: MissingDataAction;
|
|
1913
3155
|
```
|
|
1914
3156
|
|
|
1915
|
-
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.
|
|
3157
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.MissingDataAction">MissingDataAction</a>
|
|
1916
3158
|
|
|
1917
|
-
The
|
|
3159
|
+
The action taken when data is missing during evaluation.
|
|
1918
3160
|
|
|
1919
3161
|
---
|
|
1920
3162
|
|
|
@@ -2044,6 +3286,51 @@ Min 1, max 5.
|
|
|
2044
3286
|
|
|
2045
3287
|
---
|
|
2046
3288
|
|
|
3289
|
+
### IgnoreNearExpected <a name="IgnoreNearExpected" id="@robhan-cdk-lib/aws_aps.IgnoreNearExpected"></a>
|
|
3290
|
+
|
|
3291
|
+
Configuration for threshold settings that determine when values near expected values should be ignored during anomaly detection.
|
|
3292
|
+
|
|
3293
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.IgnoreNearExpected.Initializer"></a>
|
|
3294
|
+
|
|
3295
|
+
```typescript
|
|
3296
|
+
import { IgnoreNearExpected } from '@robhan-cdk-lib/aws_aps'
|
|
3297
|
+
|
|
3298
|
+
const ignoreNearExpected: IgnoreNearExpected = { ... }
|
|
3299
|
+
```
|
|
3300
|
+
|
|
3301
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
3302
|
+
|
|
3303
|
+
| **Name** | **Type** | **Description** |
|
|
3304
|
+
| --- | --- | --- |
|
|
3305
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IgnoreNearExpected.property.amount">amount</a></code> | <code>number</code> | The absolute amount by which values can differ from expected values before being considered anomalous. |
|
|
3306
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IgnoreNearExpected.property.ratio">ratio</a></code> | <code>number</code> | The ratio by which values can differ from expected values before being considered anomalous. |
|
|
3307
|
+
|
|
3308
|
+
---
|
|
3309
|
+
|
|
3310
|
+
##### `amount`<sup>Optional</sup> <a name="amount" id="@robhan-cdk-lib/aws_aps.IgnoreNearExpected.property.amount"></a>
|
|
3311
|
+
|
|
3312
|
+
```typescript
|
|
3313
|
+
public readonly amount: number;
|
|
3314
|
+
```
|
|
3315
|
+
|
|
3316
|
+
- *Type:* number
|
|
3317
|
+
|
|
3318
|
+
The absolute amount by which values can differ from expected values before being considered anomalous.
|
|
3319
|
+
|
|
3320
|
+
---
|
|
3321
|
+
|
|
3322
|
+
##### `ratio`<sup>Optional</sup> <a name="ratio" id="@robhan-cdk-lib/aws_aps.IgnoreNearExpected.property.ratio"></a>
|
|
3323
|
+
|
|
3324
|
+
```typescript
|
|
3325
|
+
public readonly ratio: number;
|
|
3326
|
+
```
|
|
3327
|
+
|
|
3328
|
+
- *Type:* number
|
|
3329
|
+
|
|
3330
|
+
The ratio by which values can differ from expected values before being considered anomalous.
|
|
3331
|
+
|
|
3332
|
+
---
|
|
3333
|
+
|
|
2047
3334
|
### Label <a name="Label" id="@robhan-cdk-lib/aws_aps.Label"></a>
|
|
2048
3335
|
|
|
2049
3336
|
A label is a name:value pair used to add context to ingested metrics.
|
|
@@ -2222,120 +3509,306 @@ public readonly logGroup: ILogGroup;
|
|
|
2222
3509
|
|
|
2223
3510
|
- *Type:* aws-cdk-lib.aws_logs.ILogGroup
|
|
2224
3511
|
|
|
2225
|
-
The CloudWatch log group to which the vended log data will be published.
|
|
3512
|
+
The CloudWatch log group to which the vended log data will be published.
|
|
3513
|
+
|
|
3514
|
+
---
|
|
3515
|
+
|
|
3516
|
+
### LoggingDestination <a name="LoggingDestination" id="@robhan-cdk-lib/aws_aps.LoggingDestination"></a>
|
|
3517
|
+
|
|
3518
|
+
The logging destination in an Amazon Managed Service for Prometheus workspace.
|
|
3519
|
+
|
|
3520
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.LoggingDestination.Initializer"></a>
|
|
3521
|
+
|
|
3522
|
+
```typescript
|
|
3523
|
+
import { LoggingDestination } from '@robhan-cdk-lib/aws_aps'
|
|
3524
|
+
|
|
3525
|
+
const loggingDestination: LoggingDestination = { ... }
|
|
3526
|
+
```
|
|
3527
|
+
|
|
3528
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
3529
|
+
|
|
3530
|
+
| **Name** | **Type** | **Description** |
|
|
3531
|
+
| --- | --- | --- |
|
|
3532
|
+
| <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. |
|
|
3533
|
+
| <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. |
|
|
3534
|
+
|
|
3535
|
+
---
|
|
3536
|
+
|
|
3537
|
+
##### `cloudWatchLogs`<sup>Required</sup> <a name="cloudWatchLogs" id="@robhan-cdk-lib/aws_aps.LoggingDestination.property.cloudWatchLogs"></a>
|
|
3538
|
+
|
|
3539
|
+
```typescript
|
|
3540
|
+
public readonly cloudWatchLogs: CloudWatchLogDestination;
|
|
3541
|
+
```
|
|
3542
|
+
|
|
3543
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.CloudWatchLogDestination">CloudWatchLogDestination</a>
|
|
3544
|
+
|
|
3545
|
+
Configuration details for logging to CloudWatch Logs.
|
|
3546
|
+
|
|
3547
|
+
---
|
|
3548
|
+
|
|
3549
|
+
##### `filters`<sup>Required</sup> <a name="filters" id="@robhan-cdk-lib/aws_aps.LoggingDestination.property.filters"></a>
|
|
3550
|
+
|
|
3551
|
+
```typescript
|
|
3552
|
+
public readonly filters: LoggingFilter;
|
|
3553
|
+
```
|
|
3554
|
+
|
|
3555
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.LoggingFilter">LoggingFilter</a>
|
|
3556
|
+
|
|
3557
|
+
Filtering criteria that determine which queries are logged.
|
|
3558
|
+
|
|
3559
|
+
---
|
|
3560
|
+
|
|
3561
|
+
### LoggingFilter <a name="LoggingFilter" id="@robhan-cdk-lib/aws_aps.LoggingFilter"></a>
|
|
3562
|
+
|
|
3563
|
+
Filtering criteria that determine which queries are logged.
|
|
3564
|
+
|
|
3565
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.LoggingFilter.Initializer"></a>
|
|
3566
|
+
|
|
3567
|
+
```typescript
|
|
3568
|
+
import { LoggingFilter } from '@robhan-cdk-lib/aws_aps'
|
|
3569
|
+
|
|
3570
|
+
const loggingFilter: LoggingFilter = { ... }
|
|
3571
|
+
```
|
|
3572
|
+
|
|
3573
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
3574
|
+
|
|
3575
|
+
| **Name** | **Type** | **Description** |
|
|
3576
|
+
| --- | --- | --- |
|
|
3577
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.LoggingFilter.property.qspThreshold">qspThreshold</a></code> | <code>number</code> | Integer. |
|
|
3578
|
+
|
|
3579
|
+
---
|
|
3580
|
+
|
|
3581
|
+
##### `qspThreshold`<sup>Required</sup> <a name="qspThreshold" id="@robhan-cdk-lib/aws_aps.LoggingFilter.property.qspThreshold"></a>
|
|
3582
|
+
|
|
3583
|
+
```typescript
|
|
3584
|
+
public readonly qspThreshold: number;
|
|
3585
|
+
```
|
|
3586
|
+
|
|
3587
|
+
- *Type:* number
|
|
3588
|
+
|
|
3589
|
+
Integer.
|
|
3590
|
+
|
|
3591
|
+
Minimum 0
|
|
3592
|
+
|
|
3593
|
+
---
|
|
3594
|
+
|
|
3595
|
+
### MissingDataAction <a name="MissingDataAction" id="@robhan-cdk-lib/aws_aps.MissingDataAction"></a>
|
|
3596
|
+
|
|
3597
|
+
Specifies the action to take when data is missing during anomaly detection evaluation.
|
|
3598
|
+
|
|
3599
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.MissingDataAction.Initializer"></a>
|
|
3600
|
+
|
|
3601
|
+
```typescript
|
|
3602
|
+
import { MissingDataAction } from '@robhan-cdk-lib/aws_aps'
|
|
3603
|
+
|
|
3604
|
+
const missingDataAction: MissingDataAction = { ... }
|
|
3605
|
+
```
|
|
3606
|
+
|
|
3607
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
3608
|
+
|
|
3609
|
+
| **Name** | **Type** | **Description** |
|
|
3610
|
+
| --- | --- | --- |
|
|
3611
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.MissingDataAction.property.markAsAnomaly">markAsAnomaly</a></code> | <code>boolean</code> | Marks missing data points as anomalies. |
|
|
3612
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.MissingDataAction.property.skip">skip</a></code> | <code>boolean</code> | Skips evaluation when data is missing. |
|
|
3613
|
+
|
|
3614
|
+
---
|
|
3615
|
+
|
|
3616
|
+
##### `markAsAnomaly`<sup>Optional</sup> <a name="markAsAnomaly" id="@robhan-cdk-lib/aws_aps.MissingDataAction.property.markAsAnomaly"></a>
|
|
3617
|
+
|
|
3618
|
+
```typescript
|
|
3619
|
+
public readonly markAsAnomaly: boolean;
|
|
3620
|
+
```
|
|
3621
|
+
|
|
3622
|
+
- *Type:* boolean
|
|
3623
|
+
|
|
3624
|
+
Marks missing data points as anomalies.
|
|
3625
|
+
|
|
3626
|
+
---
|
|
3627
|
+
|
|
3628
|
+
##### `skip`<sup>Optional</sup> <a name="skip" id="@robhan-cdk-lib/aws_aps.MissingDataAction.property.skip"></a>
|
|
3629
|
+
|
|
3630
|
+
```typescript
|
|
3631
|
+
public readonly skip: boolean;
|
|
3632
|
+
```
|
|
3633
|
+
|
|
3634
|
+
- *Type:* boolean
|
|
3635
|
+
|
|
3636
|
+
Skips evaluation when data is missing.
|
|
3637
|
+
|
|
3638
|
+
---
|
|
3639
|
+
|
|
3640
|
+
### QueryLoggingConfiguration <a name="QueryLoggingConfiguration" id="@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration"></a>
|
|
3641
|
+
|
|
3642
|
+
The query logging configuration in an Amazon Managed Service for Prometheus workspace.
|
|
3643
|
+
|
|
3644
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration.Initializer"></a>
|
|
3645
|
+
|
|
3646
|
+
```typescript
|
|
3647
|
+
import { QueryLoggingConfiguration } from '@robhan-cdk-lib/aws_aps'
|
|
3648
|
+
|
|
3649
|
+
const queryLoggingConfiguration: QueryLoggingConfiguration = { ... }
|
|
3650
|
+
```
|
|
3651
|
+
|
|
3652
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
3653
|
+
|
|
3654
|
+
| **Name** | **Type** | **Description** |
|
|
3655
|
+
| --- | --- | --- |
|
|
3656
|
+
| <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. |
|
|
3657
|
+
|
|
3658
|
+
---
|
|
3659
|
+
|
|
3660
|
+
##### `destinations`<sup>Required</sup> <a name="destinations" id="@robhan-cdk-lib/aws_aps.QueryLoggingConfiguration.property.destinations"></a>
|
|
3661
|
+
|
|
3662
|
+
```typescript
|
|
3663
|
+
public readonly destinations: LoggingDestination[];
|
|
3664
|
+
```
|
|
3665
|
+
|
|
3666
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.LoggingDestination">LoggingDestination</a>[]
|
|
3667
|
+
|
|
3668
|
+
Defines a destination and its associated filtering criteria for query logging.
|
|
3669
|
+
|
|
3670
|
+
Minimum 1 and maximum 1 item in array.
|
|
2226
3671
|
|
|
2227
3672
|
---
|
|
2228
3673
|
|
|
2229
|
-
###
|
|
3674
|
+
### RandomCutForestConfiguration <a name="RandomCutForestConfiguration" id="@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration"></a>
|
|
2230
3675
|
|
|
2231
|
-
|
|
3676
|
+
Configuration for the Random Cut Forest algorithm used for anomaly detection in time-series data.
|
|
2232
3677
|
|
|
2233
|
-
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.
|
|
3678
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration.Initializer"></a>
|
|
2234
3679
|
|
|
2235
3680
|
```typescript
|
|
2236
|
-
import {
|
|
3681
|
+
import { RandomCutForestConfiguration } from '@robhan-cdk-lib/aws_aps'
|
|
2237
3682
|
|
|
2238
|
-
const
|
|
3683
|
+
const randomCutForestConfiguration: RandomCutForestConfiguration = { ... }
|
|
2239
3684
|
```
|
|
2240
3685
|
|
|
2241
3686
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2242
3687
|
|
|
2243
3688
|
| **Name** | **Type** | **Description** |
|
|
2244
3689
|
| --- | --- | --- |
|
|
2245
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
2246
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
3690
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration.property.query">query</a></code> | <code>string</code> | The Prometheus query used to retrieve the time-series data for anomaly detection. |
|
|
3691
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration.property.ignoreNearExpectedFromAbove">ignoreNearExpectedFromAbove</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IgnoreNearExpected">IgnoreNearExpected</a></code> | Configuration for ignoring values that are near expected values from above during anomaly detection. |
|
|
3692
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration.property.ignoreNearExpectedFromBelow">ignoreNearExpectedFromBelow</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IgnoreNearExpected">IgnoreNearExpected</a></code> | Configuration for ignoring values that are near expected values from below during anomaly detection. |
|
|
3693
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration.property.sampleSize">sampleSize</a></code> | <code>number</code> | The number of data points sampled from the input stream for the Random Cut Forest algorithm. |
|
|
3694
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration.property.shingleSize">shingleSize</a></code> | <code>number</code> | The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm. |
|
|
2247
3695
|
|
|
2248
3696
|
---
|
|
2249
3697
|
|
|
2250
|
-
##### `
|
|
3698
|
+
##### `query`<sup>Required</sup> <a name="query" id="@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration.property.query"></a>
|
|
2251
3699
|
|
|
2252
3700
|
```typescript
|
|
2253
|
-
public readonly
|
|
3701
|
+
public readonly query: string;
|
|
2254
3702
|
```
|
|
2255
3703
|
|
|
2256
|
-
- *Type:*
|
|
3704
|
+
- *Type:* string
|
|
2257
3705
|
|
|
2258
|
-
|
|
3706
|
+
The Prometheus query used to retrieve the time-series data for anomaly detection.
|
|
3707
|
+
|
|
3708
|
+
1 to 8192 characters length.
|
|
2259
3709
|
|
|
2260
3710
|
---
|
|
2261
3711
|
|
|
2262
|
-
##### `
|
|
3712
|
+
##### `ignoreNearExpectedFromAbove`<sup>Optional</sup> <a name="ignoreNearExpectedFromAbove" id="@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration.property.ignoreNearExpectedFromAbove"></a>
|
|
2263
3713
|
|
|
2264
3714
|
```typescript
|
|
2265
|
-
public readonly
|
|
3715
|
+
public readonly ignoreNearExpectedFromAbove: IgnoreNearExpected;
|
|
2266
3716
|
```
|
|
2267
3717
|
|
|
2268
|
-
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.
|
|
3718
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.IgnoreNearExpected">IgnoreNearExpected</a>
|
|
2269
3719
|
|
|
2270
|
-
|
|
3720
|
+
Configuration for ignoring values that are near expected values from above during anomaly detection.
|
|
2271
3721
|
|
|
2272
3722
|
---
|
|
2273
3723
|
|
|
2274
|
-
|
|
3724
|
+
##### `ignoreNearExpectedFromBelow`<sup>Optional</sup> <a name="ignoreNearExpectedFromBelow" id="@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration.property.ignoreNearExpectedFromBelow"></a>
|
|
2275
3725
|
|
|
2276
|
-
|
|
3726
|
+
```typescript
|
|
3727
|
+
public readonly ignoreNearExpectedFromBelow: IgnoreNearExpected;
|
|
3728
|
+
```
|
|
2277
3729
|
|
|
2278
|
-
|
|
3730
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.IgnoreNearExpected">IgnoreNearExpected</a>
|
|
2279
3731
|
|
|
2280
|
-
|
|
2281
|
-
import { LoggingFilter } from '@robhan-cdk-lib/aws_aps'
|
|
3732
|
+
Configuration for ignoring values that are near expected values from below during anomaly detection.
|
|
2282
3733
|
|
|
2283
|
-
|
|
3734
|
+
---
|
|
3735
|
+
|
|
3736
|
+
##### `sampleSize`<sup>Optional</sup> <a name="sampleSize" id="@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration.property.sampleSize"></a>
|
|
3737
|
+
|
|
3738
|
+
```typescript
|
|
3739
|
+
public readonly sampleSize: number;
|
|
2284
3740
|
```
|
|
2285
3741
|
|
|
2286
|
-
|
|
3742
|
+
- *Type:* number
|
|
2287
3743
|
|
|
2288
|
-
|
|
2289
|
-
|
|
2290
|
-
|
|
3744
|
+
The number of data points sampled from the input stream for the Random Cut Forest algorithm.
|
|
3745
|
+
|
|
3746
|
+
The default number is 256 consecutive data points.
|
|
3747
|
+
|
|
3748
|
+
Minimum: 256
|
|
3749
|
+
Maximum: 1024
|
|
2291
3750
|
|
|
2292
3751
|
---
|
|
2293
3752
|
|
|
2294
|
-
##### `
|
|
3753
|
+
##### `shingleSize`<sup>Optional</sup> <a name="shingleSize" id="@robhan-cdk-lib/aws_aps.RandomCutForestConfiguration.property.shingleSize"></a>
|
|
2295
3754
|
|
|
2296
3755
|
```typescript
|
|
2297
|
-
public readonly
|
|
3756
|
+
public readonly shingleSize: number;
|
|
2298
3757
|
```
|
|
2299
3758
|
|
|
2300
3759
|
- *Type:* number
|
|
2301
3760
|
|
|
2302
|
-
|
|
3761
|
+
The number of consecutive data points used to create a shingle for the Random Cut Forest algorithm.
|
|
2303
3762
|
|
|
2304
|
-
|
|
3763
|
+
The default number is 8 consecutive data points.
|
|
3764
|
+
|
|
3765
|
+
Minimum: 2
|
|
3766
|
+
Maximum: 1024
|
|
2305
3767
|
|
|
2306
3768
|
---
|
|
2307
3769
|
|
|
2308
|
-
###
|
|
3770
|
+
### ResourcePolicyProps <a name="ResourcePolicyProps" id="@robhan-cdk-lib/aws_aps.ResourcePolicyProps"></a>
|
|
2309
3771
|
|
|
2310
|
-
|
|
3772
|
+
Properties for creating an Amazon Managed Service for Prometheus Resource Policy.
|
|
2311
3773
|
|
|
2312
|
-
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.
|
|
3774
|
+
#### Initializer <a name="Initializer" id="@robhan-cdk-lib/aws_aps.ResourcePolicyProps.Initializer"></a>
|
|
2313
3775
|
|
|
2314
3776
|
```typescript
|
|
2315
|
-
import {
|
|
3777
|
+
import { ResourcePolicyProps } from '@robhan-cdk-lib/aws_aps'
|
|
2316
3778
|
|
|
2317
|
-
const
|
|
3779
|
+
const resourcePolicyProps: ResourcePolicyProps = { ... }
|
|
2318
3780
|
```
|
|
2319
3781
|
|
|
2320
3782
|
#### Properties <a name="Properties" id="Properties"></a>
|
|
2321
3783
|
|
|
2322
3784
|
| **Name** | **Type** | **Description** |
|
|
2323
3785
|
| --- | --- | --- |
|
|
2324
|
-
| <code><a href="#@robhan-cdk-lib/aws_aps.
|
|
3786
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyProps.property.policyDocument">policyDocument</a></code> | <code>string</code> | The JSON to use as the Resource-based Policy. |
|
|
3787
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyProps.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | The workspace to attach the policy to. |
|
|
2325
3788
|
|
|
2326
3789
|
---
|
|
2327
3790
|
|
|
2328
|
-
##### `
|
|
3791
|
+
##### `policyDocument`<sup>Required</sup> <a name="policyDocument" id="@robhan-cdk-lib/aws_aps.ResourcePolicyProps.property.policyDocument"></a>
|
|
2329
3792
|
|
|
2330
3793
|
```typescript
|
|
2331
|
-
public readonly
|
|
3794
|
+
public readonly policyDocument: string;
|
|
2332
3795
|
```
|
|
2333
3796
|
|
|
2334
|
-
- *Type:*
|
|
3797
|
+
- *Type:* string
|
|
2335
3798
|
|
|
2336
|
-
|
|
3799
|
+
The JSON to use as the Resource-based Policy.
|
|
2337
3800
|
|
|
2338
|
-
|
|
3801
|
+
---
|
|
3802
|
+
|
|
3803
|
+
##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.ResourcePolicyProps.property.workspace"></a>
|
|
3804
|
+
|
|
3805
|
+
```typescript
|
|
3806
|
+
public readonly workspace: IWorkspace;
|
|
3807
|
+
```
|
|
3808
|
+
|
|
3809
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
|
|
3810
|
+
|
|
3811
|
+
The workspace to attach the policy to.
|
|
2339
3812
|
|
|
2340
3813
|
---
|
|
2341
3814
|
|
|
@@ -3041,6 +4514,255 @@ Use this structure to define label sets and the ingestion limits for time series
|
|
|
3041
4514
|
|
|
3042
4515
|
## Protocols <a name="Protocols" id="Protocols"></a>
|
|
3043
4516
|
|
|
4517
|
+
### IAnomalyDetector <a name="IAnomalyDetector" id="@robhan-cdk-lib/aws_aps.IAnomalyDetector"></a>
|
|
4518
|
+
|
|
4519
|
+
- *Extends:* aws-cdk-lib.IResource
|
|
4520
|
+
|
|
4521
|
+
- *Implemented By:* <a href="#@robhan-cdk-lib/aws_aps.AnomalyDetector">AnomalyDetector</a>, <a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorBase">AnomalyDetectorBase</a>, <a href="#@robhan-cdk-lib/aws_aps.IAnomalyDetector">IAnomalyDetector</a>
|
|
4522
|
+
|
|
4523
|
+
|
|
4524
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
4525
|
+
|
|
4526
|
+
| **Name** | **Type** | **Description** |
|
|
4527
|
+
| --- | --- | --- |
|
|
4528
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
4529
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
4530
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
4531
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.alias">alias</a></code> | <code>string</code> | The user-friendly name of the anomaly detector. 1 to 128 characters length. |
|
|
4532
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.anomalyDetectorArn">anomalyDetectorArn</a></code> | <code>string</code> | The Amazon Resource Name (ARN) of the anomaly detector. |
|
|
4533
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.configuration">configuration</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorConfiguration">AnomalyDetectorConfiguration</a></code> | The algorithm configuration of the anomaly detector. |
|
|
4534
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics. |
|
|
4535
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.evaluationIntervalInSeconds">evaluationIntervalInSeconds</a></code> | <code>number</code> | The frequency, in seconds, at which the anomaly detector evaluates metrics. |
|
|
4536
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.labels">labels</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.Label">Label</a>[]</code> | The Amazon Managed Service for Prometheus metric labels associated with the anomaly detector. |
|
|
4537
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.missingDataAction">missingDataAction</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.MissingDataAction">MissingDataAction</a></code> | The action taken when data is missing during evaluation. |
|
|
4538
|
+
|
|
4539
|
+
---
|
|
4540
|
+
|
|
4541
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.node"></a>
|
|
4542
|
+
|
|
4543
|
+
```typescript
|
|
4544
|
+
public readonly node: Node;
|
|
4545
|
+
```
|
|
4546
|
+
|
|
4547
|
+
- *Type:* constructs.Node
|
|
4548
|
+
|
|
4549
|
+
The tree node.
|
|
4550
|
+
|
|
4551
|
+
---
|
|
4552
|
+
|
|
4553
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.env"></a>
|
|
4554
|
+
|
|
4555
|
+
```typescript
|
|
4556
|
+
public readonly env: ResourceEnvironment;
|
|
4557
|
+
```
|
|
4558
|
+
|
|
4559
|
+
- *Type:* aws-cdk-lib.interfaces.ResourceEnvironment
|
|
4560
|
+
|
|
4561
|
+
The environment this resource belongs to.
|
|
4562
|
+
|
|
4563
|
+
For resources that are created and managed in a Stack (those created by
|
|
4564
|
+
creating new class instances like `new Role()`, `new Bucket()`, etc.), this
|
|
4565
|
+
is always the same as the environment of the stack they belong to.
|
|
4566
|
+
|
|
4567
|
+
For referenced resources (those obtained from referencing methods like
|
|
4568
|
+
`Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
|
|
4569
|
+
different than the stack they were imported into.
|
|
4570
|
+
|
|
4571
|
+
---
|
|
4572
|
+
|
|
4573
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.stack"></a>
|
|
4574
|
+
|
|
4575
|
+
```typescript
|
|
4576
|
+
public readonly stack: Stack;
|
|
4577
|
+
```
|
|
4578
|
+
|
|
4579
|
+
- *Type:* aws-cdk-lib.Stack
|
|
4580
|
+
|
|
4581
|
+
The stack in which this resource is defined.
|
|
4582
|
+
|
|
4583
|
+
---
|
|
4584
|
+
|
|
4585
|
+
##### `alias`<sup>Required</sup> <a name="alias" id="@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.alias"></a>
|
|
4586
|
+
|
|
4587
|
+
```typescript
|
|
4588
|
+
public readonly alias: string;
|
|
4589
|
+
```
|
|
4590
|
+
|
|
4591
|
+
- *Type:* string
|
|
4592
|
+
|
|
4593
|
+
The user-friendly name of the anomaly detector. 1 to 128 characters length.
|
|
4594
|
+
|
|
4595
|
+
Minimum length of 1. Maximum length of 64.
|
|
4596
|
+
Pattern: [0-9A-Za-z][-.0-9A-Z_a-z]*
|
|
4597
|
+
|
|
4598
|
+
---
|
|
4599
|
+
|
|
4600
|
+
##### `anomalyDetectorArn`<sup>Required</sup> <a name="anomalyDetectorArn" id="@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.anomalyDetectorArn"></a>
|
|
4601
|
+
|
|
4602
|
+
```typescript
|
|
4603
|
+
public readonly anomalyDetectorArn: string;
|
|
4604
|
+
```
|
|
4605
|
+
|
|
4606
|
+
- *Type:* string
|
|
4607
|
+
|
|
4608
|
+
The Amazon Resource Name (ARN) of the anomaly detector.
|
|
4609
|
+
|
|
4610
|
+
---
|
|
4611
|
+
|
|
4612
|
+
##### `configuration`<sup>Required</sup> <a name="configuration" id="@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.configuration"></a>
|
|
4613
|
+
|
|
4614
|
+
```typescript
|
|
4615
|
+
public readonly configuration: AnomalyDetectorConfiguration;
|
|
4616
|
+
```
|
|
4617
|
+
|
|
4618
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.AnomalyDetectorConfiguration">AnomalyDetectorConfiguration</a>
|
|
4619
|
+
|
|
4620
|
+
The algorithm configuration of the anomaly detector.
|
|
4621
|
+
|
|
4622
|
+
---
|
|
4623
|
+
|
|
4624
|
+
##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.workspace"></a>
|
|
4625
|
+
|
|
4626
|
+
```typescript
|
|
4627
|
+
public readonly workspace: IWorkspace;
|
|
4628
|
+
```
|
|
4629
|
+
|
|
4630
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
|
|
4631
|
+
|
|
4632
|
+
An Amazon Managed Service for Prometheus workspace is a logical and isolated Prometheus server dedicated to ingesting, storing, and querying your Prometheus-compatible metrics.
|
|
4633
|
+
|
|
4634
|
+
---
|
|
4635
|
+
|
|
4636
|
+
##### `evaluationIntervalInSeconds`<sup>Optional</sup> <a name="evaluationIntervalInSeconds" id="@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.evaluationIntervalInSeconds"></a>
|
|
4637
|
+
|
|
4638
|
+
```typescript
|
|
4639
|
+
public readonly evaluationIntervalInSeconds: number;
|
|
4640
|
+
```
|
|
4641
|
+
|
|
4642
|
+
- *Type:* number
|
|
4643
|
+
|
|
4644
|
+
The frequency, in seconds, at which the anomaly detector evaluates metrics.
|
|
4645
|
+
|
|
4646
|
+
Minimum value of 30. Maximum value of 86400.
|
|
4647
|
+
|
|
4648
|
+
---
|
|
4649
|
+
|
|
4650
|
+
##### `labels`<sup>Optional</sup> <a name="labels" id="@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.labels"></a>
|
|
4651
|
+
|
|
4652
|
+
```typescript
|
|
4653
|
+
public readonly labels: Label[];
|
|
4654
|
+
```
|
|
4655
|
+
|
|
4656
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.Label">Label</a>[]
|
|
4657
|
+
|
|
4658
|
+
The Amazon Managed Service for Prometheus metric labels associated with the anomaly detector.
|
|
4659
|
+
|
|
4660
|
+
Map Entries: Minimum number of 0 items. Maximum number of 140 items.
|
|
4661
|
+
Key Length Constraints: Minimum length of 1. Maximum length of 7168.
|
|
4662
|
+
Key Pattern: (?!__)[a-zA-Z_][a-zA-Z0-9_]*
|
|
4663
|
+
Value Length Constraints: Minimum length of 1. Maximum length of 7168.
|
|
4664
|
+
|
|
4665
|
+
---
|
|
4666
|
+
|
|
4667
|
+
##### `missingDataAction`<sup>Optional</sup> <a name="missingDataAction" id="@robhan-cdk-lib/aws_aps.IAnomalyDetector.property.missingDataAction"></a>
|
|
4668
|
+
|
|
4669
|
+
```typescript
|
|
4670
|
+
public readonly missingDataAction: MissingDataAction;
|
|
4671
|
+
```
|
|
4672
|
+
|
|
4673
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.MissingDataAction">MissingDataAction</a>
|
|
4674
|
+
|
|
4675
|
+
The action taken when data is missing during evaluation.
|
|
4676
|
+
|
|
4677
|
+
---
|
|
4678
|
+
|
|
4679
|
+
### IResourcePolicy <a name="IResourcePolicy" id="@robhan-cdk-lib/aws_aps.IResourcePolicy"></a>
|
|
4680
|
+
|
|
4681
|
+
- *Extends:* aws-cdk-lib.IResource
|
|
4682
|
+
|
|
4683
|
+
- *Implemented By:* <a href="#@robhan-cdk-lib/aws_aps.ResourcePolicy">ResourcePolicy</a>, <a href="#@robhan-cdk-lib/aws_aps.ResourcePolicyBase">ResourcePolicyBase</a>, <a href="#@robhan-cdk-lib/aws_aps.IResourcePolicy">IResourcePolicy</a>
|
|
4684
|
+
|
|
4685
|
+
|
|
4686
|
+
#### Properties <a name="Properties" id="Properties"></a>
|
|
4687
|
+
|
|
4688
|
+
| **Name** | **Type** | **Description** |
|
|
4689
|
+
| --- | --- | --- |
|
|
4690
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IResourcePolicy.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
|
|
4691
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IResourcePolicy.property.env">env</a></code> | <code>aws-cdk-lib.interfaces.ResourceEnvironment</code> | The environment this resource belongs to. |
|
|
4692
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IResourcePolicy.property.stack">stack</a></code> | <code>aws-cdk-lib.Stack</code> | The stack in which this resource is defined. |
|
|
4693
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IResourcePolicy.property.policyDocument">policyDocument</a></code> | <code>string</code> | The JSON to use as the Resource-based Policy. |
|
|
4694
|
+
| <code><a href="#@robhan-cdk-lib/aws_aps.IResourcePolicy.property.workspace">workspace</a></code> | <code><a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a></code> | The workspace to attach the policy to. |
|
|
4695
|
+
|
|
4696
|
+
---
|
|
4697
|
+
|
|
4698
|
+
##### `node`<sup>Required</sup> <a name="node" id="@robhan-cdk-lib/aws_aps.IResourcePolicy.property.node"></a>
|
|
4699
|
+
|
|
4700
|
+
```typescript
|
|
4701
|
+
public readonly node: Node;
|
|
4702
|
+
```
|
|
4703
|
+
|
|
4704
|
+
- *Type:* constructs.Node
|
|
4705
|
+
|
|
4706
|
+
The tree node.
|
|
4707
|
+
|
|
4708
|
+
---
|
|
4709
|
+
|
|
4710
|
+
##### `env`<sup>Required</sup> <a name="env" id="@robhan-cdk-lib/aws_aps.IResourcePolicy.property.env"></a>
|
|
4711
|
+
|
|
4712
|
+
```typescript
|
|
4713
|
+
public readonly env: ResourceEnvironment;
|
|
4714
|
+
```
|
|
4715
|
+
|
|
4716
|
+
- *Type:* aws-cdk-lib.interfaces.ResourceEnvironment
|
|
4717
|
+
|
|
4718
|
+
The environment this resource belongs to.
|
|
4719
|
+
|
|
4720
|
+
For resources that are created and managed in a Stack (those created by
|
|
4721
|
+
creating new class instances like `new Role()`, `new Bucket()`, etc.), this
|
|
4722
|
+
is always the same as the environment of the stack they belong to.
|
|
4723
|
+
|
|
4724
|
+
For referenced resources (those obtained from referencing methods like
|
|
4725
|
+
`Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
|
|
4726
|
+
different than the stack they were imported into.
|
|
4727
|
+
|
|
4728
|
+
---
|
|
4729
|
+
|
|
4730
|
+
##### `stack`<sup>Required</sup> <a name="stack" id="@robhan-cdk-lib/aws_aps.IResourcePolicy.property.stack"></a>
|
|
4731
|
+
|
|
4732
|
+
```typescript
|
|
4733
|
+
public readonly stack: Stack;
|
|
4734
|
+
```
|
|
4735
|
+
|
|
4736
|
+
- *Type:* aws-cdk-lib.Stack
|
|
4737
|
+
|
|
4738
|
+
The stack in which this resource is defined.
|
|
4739
|
+
|
|
4740
|
+
---
|
|
4741
|
+
|
|
4742
|
+
##### `policyDocument`<sup>Required</sup> <a name="policyDocument" id="@robhan-cdk-lib/aws_aps.IResourcePolicy.property.policyDocument"></a>
|
|
4743
|
+
|
|
4744
|
+
```typescript
|
|
4745
|
+
public readonly policyDocument: string;
|
|
4746
|
+
```
|
|
4747
|
+
|
|
4748
|
+
- *Type:* string
|
|
4749
|
+
|
|
4750
|
+
The JSON to use as the Resource-based Policy.
|
|
4751
|
+
|
|
4752
|
+
---
|
|
4753
|
+
|
|
4754
|
+
##### `workspace`<sup>Required</sup> <a name="workspace" id="@robhan-cdk-lib/aws_aps.IResourcePolicy.property.workspace"></a>
|
|
4755
|
+
|
|
4756
|
+
```typescript
|
|
4757
|
+
public readonly workspace: IWorkspace;
|
|
4758
|
+
```
|
|
4759
|
+
|
|
4760
|
+
- *Type:* <a href="#@robhan-cdk-lib/aws_aps.IWorkspace">IWorkspace</a>
|
|
4761
|
+
|
|
4762
|
+
The workspace to attach the policy to.
|
|
4763
|
+
|
|
4764
|
+
---
|
|
4765
|
+
|
|
3044
4766
|
### IRuleGroupsNamespace <a name="IRuleGroupsNamespace" id="@robhan-cdk-lib/aws_aps.IRuleGroupsNamespace"></a>
|
|
3045
4767
|
|
|
3046
4768
|
- *Extends:* aws-cdk-lib.IResource
|