Skip to content

Commit cbfc18c

Browse files
authored
feat(dashboard): add Aoss monitoring dashboard (#686)
* chore(aoss): save current work on dashboard * feat(dashboard): add aoss monitoring dashboard * chore(test): update tests and add stack id to name * chore(dahsboard): revert stack id addition
1 parent 4af4990 commit cbfc18c

20 files changed

+1388
-1
lines changed

Diff for: .gitignore

+9
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: .npmignore

+2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: .projen/tasks.json

+69
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: apidocs/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121

2222
## Classes
2323

24+
- [AossCwDashboard](classes/AossCwDashboard.md)
2425
- [BaseClass](classes/BaseClass.md)
2526
- [BedrockCwDashboard](classes/BedrockCwDashboard.md)
2627
- [ContainerImage](classes/ContainerImage.md)
@@ -41,9 +42,11 @@
4142

4243
## Interfaces
4344

45+
- [AossCwDashboardProps](interfaces/AossCwDashboardProps.md)
4446
- [AsyncInferenceConfig](interfaces/AsyncInferenceConfig.md)
4547
- [BaseClassProps](interfaces/BaseClassProps.md)
4648
- [BedrockCwDashboardProps](interfaces/BedrockCwDashboardProps.md)
49+
- [CollectionMonitoringProps](interfaces/CollectionMonitoringProps.md)
4750
- [ContainerImageConfig](interfaces/ContainerImageConfig.md)
4851
- [ContentGenerationAppSyncLambdaProps](interfaces/ContentGenerationAppSyncLambdaProps.md)
4952
- [CrawlerTarget](interfaces/CrawlerTarget.md)
@@ -53,6 +56,7 @@
5356
- [IInstanceAliase](interfaces/IInstanceAliase.md)
5457
- [IInstanceValiant](interfaces/IInstanceValiant.md)
5558
- [IJumpStartModelSpec](interfaces/IJumpStartModelSpec.md)
59+
- [IndexMonitoringProps](interfaces/IndexMonitoringProps.md)
5660
- [JumpStartSageMakerEndpointProps](interfaces/JumpStartSageMakerEndpointProps.md)
5761
- [LangchainLayerProps](interfaces/LangchainLayerProps.md)
5862
- [LangchainProps](interfaces/LangchainProps.md)

Diff for: apidocs/classes/AossCwDashboard.md

+177
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)**Docs**
2+
3+
***
4+
5+
[@cdklabs/generative-ai-cdk-constructs](../README.md) / AossCwDashboard
6+
7+
# Class: AossCwDashboard
8+
9+
The BedrockCwDashboard class.
10+
11+
## Extends
12+
13+
- `Construct`
14+
15+
## Constructors
16+
17+
### new AossCwDashboard()
18+
19+
> **new AossCwDashboard**(`scope`, `id`, `props`): [`AossCwDashboard`](AossCwDashboard.md)
20+
21+
Constructs a new instance of the AossCwDashboard class.
22+
23+
#### Parameters
24+
25+
**scope**: `Construct`
26+
27+
represents the scope for all the resources.
28+
29+
**id**: `string`
30+
31+
this is a a scope-unique id.
32+
33+
**props**: [`AossCwDashboardProps`](../interfaces/AossCwDashboardProps.md)
34+
35+
user provided props for the construct.
36+
37+
#### Returns
38+
39+
[`AossCwDashboard`](AossCwDashboard.md)
40+
41+
#### Since
42+
43+
0.0.0
44+
45+
#### Overrides
46+
47+
`Construct.constructor`
48+
49+
## Properties
50+
51+
### dashboard
52+
53+
> `readonly` **dashboard**: `Dashboard`
54+
55+
Returns the instance of CloudWatch dashboard used by the construct
56+
57+
***
58+
59+
### node
60+
61+
> `readonly` **node**: `Node`
62+
63+
The tree node.
64+
65+
#### Inherited from
66+
67+
`Construct.node`
68+
69+
## Methods
70+
71+
### addCollectionMonitoringByCollection()
72+
73+
> **addCollectionMonitoringByCollection**(`collection`, `props`): `void`
74+
75+
#### Parameters
76+
77+
**collection**: `CfnCollection`
78+
79+
**props**: [`CollectionMonitoringProps`](../interfaces/CollectionMonitoringProps.md)
80+
81+
#### Returns
82+
83+
`void`
84+
85+
***
86+
87+
### addCollectionMonitoringbyAttributes()
88+
89+
> **addCollectionMonitoringbyAttributes**(`collectionName`, `collectionId`, `props`): `void`
90+
91+
#### Parameters
92+
93+
**collectionName**: `string`
94+
95+
**collectionId**: `string`
96+
97+
**props**: [`CollectionMonitoringProps`](../interfaces/CollectionMonitoringProps.md)
98+
99+
#### Returns
100+
101+
`void`
102+
103+
***
104+
105+
### addIndexMonitoringByAtributes()
106+
107+
> **addIndexMonitoringByAtributes**(`collectionName`, `collectionId`, `IndexName`, `IndexId`, `props`): `void`
108+
109+
#### Parameters
110+
111+
**collectionName**: `string`
112+
113+
**collectionId**: `string`
114+
115+
**IndexName**: `string`
116+
117+
**IndexId**: `string`
118+
119+
**props**: [`IndexMonitoringProps`](../interfaces/IndexMonitoringProps.md)
120+
121+
#### Returns
122+
123+
`void`
124+
125+
***
126+
127+
### toString()
128+
129+
> **toString**(): `string`
130+
131+
Returns a string representation of this construct.
132+
133+
#### Returns
134+
135+
`string`
136+
137+
#### Inherited from
138+
139+
`Construct.toString`
140+
141+
***
142+
143+
### isConstruct()
144+
145+
> `static` **isConstruct**(`x`): `x is Construct`
146+
147+
Checks if `x` is a construct.
148+
149+
Use this method instead of `instanceof` to properly detect `Construct`
150+
instances, even when the construct library is symlinked.
151+
152+
Explanation: in JavaScript, multiple copies of the `constructs` library on
153+
disk are seen as independent, completely different libraries. As a
154+
consequence, the class `Construct` in each copy of the `constructs` library
155+
is seen as a different class, and an instance of one class will not test as
156+
`instanceof` the other class. `npm install` will not create installations
157+
like this, but users may manually symlink construct libraries together or
158+
use a monorepo tool: in those cases, multiple copies of the `constructs`
159+
library can be accidentally installed, and `instanceof` will behave
160+
unpredictably. It is safest to avoid using `instanceof`, and using
161+
this type-testing method instead.
162+
163+
#### Parameters
164+
165+
**x**: `any`
166+
167+
Any object
168+
169+
#### Returns
170+
171+
`x is Construct`
172+
173+
true if `x` is an object created from a class which extends `Construct`.
174+
175+
#### Inherited from
176+
177+
`Construct.isConstruct`

Diff for: apidocs/interfaces/AossCwDashboardProps.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)**Docs**
2+
3+
***
4+
5+
[@cdklabs/generative-ai-cdk-constructs](../README.md) / AossCwDashboardProps
6+
7+
# Interface: AossCwDashboardProps
8+
9+
The properties for the BedrockCwDashboardProps class.
10+
11+
## Properties
12+
13+
### dashboardName?
14+
15+
> `readonly` `optional` **dashboardName**: `string`
16+
17+
Optional A name for the dashboard which will be created.
18+
If existingDashboard is defined, this value will be ignored.
19+
If not provided, the construct will create a new dashboard named 'BedrockMetricsDashboard'
20+
21+
#### Default
22+
23+
```ts
24+
- none
25+
```
26+
27+
***
28+
29+
### existingDashboard?
30+
31+
> `readonly` `optional` **existingDashboard**: `Dashboard`
32+
33+
Optional An existing dashboard where metrics will be added to.
34+
If not provided, the construct will create a new dashboard
35+
36+
#### Default
37+
38+
```ts
39+
- none
40+
```

Diff for: apidocs/interfaces/CollectionMonitoringProps.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)**Docs**
2+
3+
***
4+
5+
[@cdklabs/generative-ai-cdk-constructs](../README.md) / CollectionMonitoringProps
6+
7+
# Interface: CollectionMonitoringProps
8+
9+
The properties for the CollectionMonitoringProps class.
10+
11+
## Properties
12+
13+
### clientId?
14+
15+
> `readonly` `optional` **clientId**: `string`
16+
17+
***
18+
19+
### period?
20+
21+
> `readonly` `optional` **period**: `Duration`

0 commit comments

Comments
 (0)