Skip to content

Commit ca2c70c

Browse files
author
github-actions
committed
chore: self mutation
Signed-off-by: github-actions <[email protected]>
1 parent 20f818e commit ca2c70c

File tree

186 files changed

+1626
-666
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

186 files changed

+1626
-666
lines changed

apidocs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
**@cdklabs/generative-ai-cdk-constructs****Docs**
1+
**@cdklabs/generative-ai-cdk-constructs**
22

33
***
44

apidocs/classes/AossCwDashboard.md

Lines changed: 43 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)**Docs**
1+
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)
22

33
***
44

@@ -22,15 +22,21 @@ Constructs a new instance of the AossCwDashboard class.
2222

2323
#### Parameters
2424

25-
**scope**: `Construct`
25+
##### scope
26+
27+
`Construct`
2628

2729
represents the scope for all the resources.
2830

29-
**id**: `string`
31+
##### id
32+
33+
`string`
3034

3135
this is a a scope-unique id.
3236

33-
**props**: [`AossCwDashboardProps`](../interfaces/AossCwDashboardProps.md)
37+
##### props
38+
39+
[`AossCwDashboardProps`](../interfaces/AossCwDashboardProps.md)
3440

3541
user provided props for the construct.
3642

@@ -74,11 +80,17 @@ The tree node.
7480
7581
#### Parameters
7682

77-
**collectionName**: `string`
83+
##### collectionName
7884

79-
**collectionId**: `string`
85+
`string`
8086

81-
**props**: [`CollectionMonitoringProps`](../interfaces/CollectionMonitoringProps.md)
87+
##### collectionId
88+
89+
`string`
90+
91+
##### props
92+
93+
[`CollectionMonitoringProps`](../interfaces/CollectionMonitoringProps.md)
8294

8395
#### Returns
8496

@@ -92,9 +104,13 @@ The tree node.
92104
93105
#### Parameters
94106

95-
**collection**: `CfnCollection`
107+
##### collection
108+
109+
`CfnCollection`
110+
111+
##### props
96112

97-
**props**: [`CollectionMonitoringProps`](../interfaces/CollectionMonitoringProps.md)
113+
[`CollectionMonitoringProps`](../interfaces/CollectionMonitoringProps.md)
98114

99115
#### Returns
100116

@@ -108,15 +124,25 @@ The tree node.
108124
109125
#### Parameters
110126

111-
**collectionName**: `string`
127+
##### collectionName
112128

113-
**collectionId**: `string`
129+
`string`
130+
131+
##### collectionId
132+
133+
`string`
134+
135+
##### IndexName
114136

115-
**IndexName**: `string`
137+
`string`
138+
139+
##### IndexId
116140

117-
**IndexId**: `string`
141+
`string`
118142

119-
**props**: [`IndexMonitoringProps`](../interfaces/IndexMonitoringProps.md)
143+
##### props
144+
145+
[`IndexMonitoringProps`](../interfaces/IndexMonitoringProps.md)
120146

121147
#### Returns
122148

@@ -162,7 +188,9 @@ this type-testing method instead.
162188

163189
#### Parameters
164190

165-
**x**: `any`
191+
##### x
192+
193+
`any`
166194

167195
Any object
168196

apidocs/classes/BaseClass.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)**Docs**
1+
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)
22

33
***
44

@@ -28,9 +28,13 @@
2828
2929
#### Parameters
3030

31-
**scope**: `Construct`
31+
##### scope
3232

33-
**id**: `string`
33+
`Construct`
34+
35+
##### id
36+
37+
`string`
3438

3539
#### Returns
3640

@@ -134,7 +138,9 @@ Record<string, number> , maps construct name with number of deployments
134138
135139
#### Parameters
136140

137-
**props**: [`BaseClassProps`](../interfaces/BaseClassProps.md)
141+
##### props
142+
143+
[`BaseClassProps`](../interfaces/BaseClassProps.md)
138144

139145
#### Returns
140146

@@ -164,11 +170,17 @@ Returns a string representation of this construct.
164170
165171
#### Parameters
166172

167-
**props**: [`BaseClassProps`](../interfaces/BaseClassProps.md)
173+
##### props
174+
175+
[`BaseClassProps`](../interfaces/BaseClassProps.md)
168176

169-
**scope**: `Construct`
177+
##### scope
170178

171-
**lambdaFunctions**: `DockerImageFunction`[]
179+
`Construct`
180+
181+
##### lambdaFunctions
182+
183+
`DockerImageFunction`[]
172184

173185
#### Returns
174186

@@ -182,7 +194,9 @@ Returns a string representation of this construct.
182194
183195
#### Parameters
184196

185-
**props**: [`BaseClassProps`](../interfaces/BaseClassProps.md)
197+
##### props
198+
199+
[`BaseClassProps`](../interfaces/BaseClassProps.md)
186200

187201
#### Returns
188202

@@ -212,7 +226,9 @@ this type-testing method instead.
212226

213227
#### Parameters
214228

215-
**x**: `any`
229+
##### x
230+
231+
`any`
216232

217233
Any object
218234

apidocs/classes/BedrockCwDashboard.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)**Docs**
1+
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)
22

33
***
44

@@ -22,15 +22,21 @@ Constructs a new instance of the BedrockCwDashboard class.
2222

2323
#### Parameters
2424

25-
**scope**: `Construct`
25+
##### scope
26+
27+
`Construct`
2628

2729
represents the scope for all the resources.
2830

29-
**id**: `string`
31+
##### id
32+
33+
`string`
3034

3135
this is a a scope-unique id.
3236

33-
**props**: [`BedrockCwDashboardProps`](../interfaces/BedrockCwDashboardProps.md) = `{}`
37+
##### props
38+
39+
[`BedrockCwDashboardProps`](../interfaces/BedrockCwDashboardProps.md) = `{}`
3440

3541
user provided props for the construct.
3642

@@ -74,7 +80,9 @@ The tree node.
7480
7581
#### Parameters
7682

77-
**props**: [`ModelMonitoringProps`](../interfaces/ModelMonitoringProps.md) = `{}`
83+
##### props
84+
85+
[`ModelMonitoringProps`](../interfaces/ModelMonitoringProps.md) = `{}`
7886

7987
#### Returns
8088

@@ -88,11 +96,17 @@ The tree node.
8896
8997
#### Parameters
9098

91-
**modelName**: `string`
99+
##### modelName
92100

93-
**modelId**: `string`
101+
`string`
94102

95-
**props**: [`ModelMonitoringProps`](../interfaces/ModelMonitoringProps.md) = `{}`
103+
##### modelId
104+
105+
`string`
106+
107+
##### props
108+
109+
[`ModelMonitoringProps`](../interfaces/ModelMonitoringProps.md) = `{}`
96110

97111
#### Returns
98112

@@ -138,7 +152,9 @@ this type-testing method instead.
138152

139153
#### Parameters
140154

141-
**x**: `any`
155+
##### x
156+
157+
`any`
142158

143159
Any object
144160

apidocs/classes/ContainerImage.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)**Docs**
1+
[**@cdklabs/generative-ai-cdk-constructs**](../README.md)
22

33
***
44

@@ -30,9 +30,13 @@ https://github.com/aws/deep-learning-containers/blob/master/available_images.md
3030
3131
#### Parameters
3232

33-
**scope**: `Construct`
33+
##### scope
3434

35-
**grantable**: `IGrantable`
35+
`Construct`
36+
37+
##### grantable
38+
39+
`IGrantable`
3640

3741
#### Returns
3842

@@ -46,9 +50,13 @@ https://github.com/aws/deep-learning-containers/blob/master/available_images.md
4650
4751
#### Parameters
4852

49-
**directory**: `string`
53+
##### directory
54+
55+
`string`
5056

51-
**options**: `DockerImageAssetOptions` = `{}`
57+
##### options
58+
59+
`DockerImageAssetOptions` = `{}`
5260

5361
#### Returns
5462

@@ -62,9 +70,13 @@ https://github.com/aws/deep-learning-containers/blob/master/available_images.md
6270
6371
#### Parameters
6472

65-
**repository**: `IRepository`
73+
##### repository
74+
75+
`IRepository`
76+
77+
##### tag
6678

67-
**tag**: `string` = `'latest'`
79+
`string` = `'latest'`
6880

6981
#### Returns
7082

0 commit comments

Comments
 (0)