cdk-comprehend-s3olap 2.0.514 → 2.0.515

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. package/.jsii +4 -4
  2. package/API.md +2042 -305
  3. package/lib/cdk-comprehend-s3olap.js +2 -2
  4. package/lib/comprehend-lambdas.js +2 -2
  5. package/lib/iam-roles.js +4 -4
  6. package/node_modules/aws-sdk/README.md +1 -1
  7. package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.min.json +247 -161
  8. package/node_modules/aws-sdk/apis/workspaces-2015-04-08.min.json +78 -40
  9. package/node_modules/aws-sdk/clients/iotsitewise.d.ts +169 -72
  10. package/node_modules/aws-sdk/clients/workspaces.d.ts +57 -2
  11. package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +1 -1
  12. package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +3 -3
  13. package/node_modules/aws-sdk/dist/aws-sdk.js +3 -3
  14. package/node_modules/aws-sdk/dist/aws-sdk.min.js +2 -2
  15. package/node_modules/aws-sdk/lib/core.js +1 -1
  16. package/node_modules/aws-sdk/package.json +1 -1
  17. package/package.json +5 -5
package/API.md CHANGED
@@ -1,558 +1,2295 @@
1
- # API Reference
1
+ # API Reference <a name="API Reference" id="api-reference"></a>
2
2
 
3
- **Classes**
3
+ ## Constructs <a name="Constructs" id="Constructs"></a>
4
4
 
5
- Name|Description
6
- ----|-----------
7
- [AccessConrtolLambda](#cdk-comprehend-s3olap-accessconrtollambda)|*No description*
8
- [AdminRole](#cdk-comprehend-s3olap-adminrole)|*No description*
9
- [BillingRole](#cdk-comprehend-s3olap-billingrole)|*No description*
10
- [ComprehendS3olab](#cdk-comprehend-s3olap-comprehends3olab)|Creates the foundation necessary to deploy the S3 Object Lambda Acceess Control Use Case.
11
- [CustSupportRole](#cdk-comprehend-s3olap-custsupportrole)|*No description*
12
- [GeneralRole](#cdk-comprehend-s3olap-generalrole)|The role that you are going to assume (switch role).
13
- [LambdaArnCaptorCustomResource](#cdk-comprehend-s3olap-lambdaarncaptorcustomresource)|*No description*
14
- [RedactionLambda](#cdk-comprehend-s3olap-redactionlambda)|*No description*
5
+ ### AccessConrtolLambda <a name="AccessConrtolLambda" id="cdk-comprehend-s3olap.AccessConrtolLambda"></a>
15
6
 
7
+ #### Initializers <a name="Initializers" id="cdk-comprehend-s3olap.AccessConrtolLambda.Initializer"></a>
16
8
 
17
- **Structs**
9
+ ```typescript
10
+ import { AccessConrtolLambda } from 'cdk-comprehend-s3olap'
18
11
 
19
- Name|Description
20
- ----|-----------
21
- [AccessConrtolLambdaProps](#cdk-comprehend-s3olap-accessconrtollambdaprops)|*No description*
22
- [AdminRoleProps](#cdk-comprehend-s3olap-adminroleprops)|*No description*
23
- [BillingRoleProps](#cdk-comprehend-s3olap-billingroleprops)|*No description*
24
- [ComprehendS3olabProps](#cdk-comprehend-s3olap-comprehends3olabprops)|*No description*
25
- [CustSupportRoleProps](#cdk-comprehend-s3olap-custsupportroleprops)|*No description*
26
- [GeneralRoleProps](#cdk-comprehend-s3olap-generalroleprops)|*No description*
27
- [LambdaArnCaptorResourceProps](#cdk-comprehend-s3olap-lambdaarncaptorresourceprops)|*No description*
28
- [RedactionLambdaProps](#cdk-comprehend-s3olap-redactionlambdaprops)|*No description*
29
- [S3AccessPointNames](#cdk-comprehend-s3olap-s3accesspointnames)|*No description*
12
+ new AccessConrtolLambda(scope: Construct, id: string, props: AccessConrtolLambdaProps)
13
+ ```
30
14
 
15
+ | **Name** | **Type** | **Description** |
16
+ | --- | --- | --- |
17
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambda.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
18
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambda.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
19
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambda.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps">AccessConrtolLambdaProps</a></code> | *No description.* |
31
20
 
32
- **Enums**
21
+ ---
33
22
 
34
- Name|Description
35
- ----|-----------
36
- [IamRoleName](#cdk-comprehend-s3olap-iamrolename)|*No description*
23
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-comprehend-s3olap.AccessConrtolLambda.Initializer.parameter.scope"></a>
37
24
 
25
+ - *Type:* constructs.Construct
38
26
 
27
+ ---
39
28
 
40
- ## class AccessConrtolLambda <a id="cdk-comprehend-s3olap-accessconrtollambda"></a>
29
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-comprehend-s3olap.AccessConrtolLambda.Initializer.parameter.id"></a>
41
30
 
31
+ - *Type:* string
42
32
 
33
+ ---
43
34
 
44
- __Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable)
45
- __Extends__: [Construct](#constructs-construct)
35
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-comprehend-s3olap.AccessConrtolLambda.Initializer.parameter.props"></a>
46
36
 
47
- ### Initializer
37
+ - *Type:* <a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps">AccessConrtolLambdaProps</a>
48
38
 
39
+ ---
49
40
 
41
+ #### Methods <a name="Methods" id="Methods"></a>
50
42
 
43
+ | **Name** | **Description** |
44
+ | --- | --- |
45
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambda.toString">toString</a></code> | Returns a string representation of this construct. |
51
46
 
52
- ```ts
53
- new AccessConrtolLambda(scope: Construct, id: string, props: AccessConrtolLambdaProps)
47
+ ---
48
+
49
+ ##### `toString` <a name="toString" id="cdk-comprehend-s3olap.AccessConrtolLambda.toString"></a>
50
+
51
+ ```typescript
52
+ public toString(): string
53
+ ```
54
+
55
+ Returns a string representation of this construct.
56
+
57
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
58
+
59
+ | **Name** | **Description** |
60
+ | --- | --- |
61
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambda.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
62
+
63
+ ---
64
+
65
+ ##### `isConstruct` <a name="isConstruct" id="cdk-comprehend-s3olap.AccessConrtolLambda.isConstruct"></a>
66
+
67
+ ```typescript
68
+ import { AccessConrtolLambda } from 'cdk-comprehend-s3olap'
69
+
70
+ AccessConrtolLambda.isConstruct(x: any)
54
71
  ```
55
72
 
56
- * **scope** (<code>[Construct](#constructs-construct)</code>) *No description*
57
- * **id** (<code>string</code>) *No description*
58
- * **props** (<code>[AccessConrtolLambdaProps](#cdk-comprehend-s3olap-accessconrtollambdaprops)</code>) *No description*
59
- * **confidenceThreshold** (<code>string</code>) The minimum prediction confidence score above which PII classification and detection would be considered as final answer. __*Default*__: '0.5'
60
- * **containsPiiEntitiesThreadCount** (<code>string</code>) Number of threads to use for calling Comprehend's ContainsPiiEntities API. __*Default*__: '20'
61
- * **defaultLanguageCode** (<code>string</code>) Default language of the text to be processed. __*Default*__: 'en'
62
- * **documentMaxSize** (<code>string</code>) Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size. __*Default*__: '102400'
63
- * **documentMaxSizeContainsPiiEntities** (<code>string</code>) Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API. __*Default*__: '50000'
64
- * **isPartialObjectSupported** (<code>string</code>) Whether to support partial objects or not. __*Default*__: 'false'
65
- * **logLevel** (<code>string</code>) Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc. __*Default*__: 'INFO'
66
- * **maxCharsOverlap** (<code>string</code>) Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit. __*Default*__: '200'
67
- * **piiEntityTypes** (<code>string</code>) List of comma separated PII entity types to be considered for access control. __*Default*__: 'ALL'
68
- * **publishCloudWatchMetrics** (<code>string</code>) True if publish metrics to Cloudwatch, false otherwise. __*Default*__: 'true'
69
- * **semanticVersion** (<code>string</code>) The version of the serverless application. __*Default*__: '1.0.2'
70
- * **subsegmentOverlappingTokens** (<code>string</code>) Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit. __*Default*__: '20'
71
- * **unsupportedFileHandling** (<code>string</code>) Handling logic for Unsupported files. __*Default*__: 'FAIL'
73
+ Checks if `x` is a construct.
74
+
75
+ Use this method instead of `instanceof` to properly detect `Construct`
76
+ instances, even when the construct library is symlinked.
77
+
78
+ Explanation: in JavaScript, multiple copies of the `constructs` library on
79
+ disk are seen as independent, completely different libraries. As a
80
+ consequence, the class `Construct` in each copy of the `constructs` library
81
+ is seen as a different class, and an instance of one class will not test as
82
+ `instanceof` the other class. `npm install` will not create installations
83
+ like this, but users may manually symlink construct libraries together or
84
+ use a monorepo tool: in those cases, multiple copies of the `constructs`
85
+ library can be accidentally installed, and `instanceof` will behave
86
+ unpredictably. It is safest to avoid using `instanceof`, and using
87
+ this type-testing method instead.
88
+
89
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-comprehend-s3olap.AccessConrtolLambda.isConstruct.parameter.x"></a>
72
90
 
91
+ - *Type:* any
73
92
 
93
+ Any object.
74
94
 
75
- ### Properties
95
+ ---
76
96
 
97
+ #### Properties <a name="Properties" id="Properties"></a>
77
98
 
78
- Name | Type | Description
79
- -----|------|-------------
80
- **stackName** | <code>string</code> | The name of the underlying resoure in the serverless application.
99
+ | **Name** | **Type** | **Description** |
100
+ | --- | --- | --- |
101
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambda.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
102
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambda.property.stackName">stackName</a></code> | <code>string</code> | The name of the underlying resoure in the serverless application. |
81
103
 
104
+ ---
82
105
 
106
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-comprehend-s3olap.AccessConrtolLambda.property.node"></a>
83
107
 
84
- ## class AdminRole <a id="cdk-comprehend-s3olap-adminrole"></a>
108
+ ```typescript
109
+ public readonly node: Node;
110
+ ```
111
+
112
+ - *Type:* constructs.Node
113
+
114
+ The tree node.
115
+
116
+ ---
85
117
 
118
+ ##### `stackName`<sup>Required</sup> <a name="stackName" id="cdk-comprehend-s3olap.AccessConrtolLambda.property.stackName"></a>
86
119
 
120
+ ```typescript
121
+ public readonly stackName: string;
122
+ ```
123
+
124
+ - *Type:* string
87
125
 
88
- __Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable)
89
- __Extends__: [Construct](#constructs-construct)
126
+ The name of the underlying resoure in the serverless application.
90
127
 
91
- ### Initializer
128
+ ---
92
129
 
93
130
 
131
+ ### AdminRole <a name="AdminRole" id="cdk-comprehend-s3olap.AdminRole"></a>
94
132
 
133
+ #### Initializers <a name="Initializers" id="cdk-comprehend-s3olap.AdminRole.Initializer"></a>
134
+
135
+ ```typescript
136
+ import { AdminRole } from 'cdk-comprehend-s3olap'
95
137
 
96
- ```ts
97
138
  new AdminRole(scope: Construct, id: string, props?: AdminRoleProps)
98
139
  ```
99
140
 
100
- * **scope** (<code>[Construct](#constructs-construct)</code>) *No description*
101
- * **id** (<code>string</code>) *No description*
102
- * **props** (<code>[AdminRoleProps](#cdk-comprehend-s3olap-adminroleprops)</code>) *No description*
103
- * **iamRoleName** (<code>string</code>) The name of the IAM role. __*Default*__: 'RedactionAdminRole'
104
- * **objectLambdaAccessPointName** (<code>string</code>) The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration. __*Default*__: 'admin-s3olap-call-transcripts-known-pii'
105
- * **policyName** (<code>string</code>) The name of the IAM policy for the IAM role. __*Default*__: 'admin-role-s3olap-policy'
141
+ | **Name** | **Type** | **Description** |
142
+ | --- | --- | --- |
143
+ | <code><a href="#cdk-comprehend-s3olap.AdminRole.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
144
+ | <code><a href="#cdk-comprehend-s3olap.AdminRole.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
145
+ | <code><a href="#cdk-comprehend-s3olap.AdminRole.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-comprehend-s3olap.AdminRoleProps">AdminRoleProps</a></code> | *No description.* |
146
+
147
+ ---
148
+
149
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-comprehend-s3olap.AdminRole.Initializer.parameter.scope"></a>
150
+
151
+ - *Type:* constructs.Construct
152
+
153
+ ---
154
+
155
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-comprehend-s3olap.AdminRole.Initializer.parameter.id"></a>
156
+
157
+ - *Type:* string
158
+
159
+ ---
160
+
161
+ ##### `props`<sup>Optional</sup> <a name="props" id="cdk-comprehend-s3olap.AdminRole.Initializer.parameter.props"></a>
162
+
163
+ - *Type:* <a href="#cdk-comprehend-s3olap.AdminRoleProps">AdminRoleProps</a>
164
+
165
+ ---
166
+
167
+ #### Methods <a name="Methods" id="Methods"></a>
168
+
169
+ | **Name** | **Description** |
170
+ | --- | --- |
171
+ | <code><a href="#cdk-comprehend-s3olap.AdminRole.toString">toString</a></code> | Returns a string representation of this construct. |
172
+
173
+ ---
174
+
175
+ ##### `toString` <a name="toString" id="cdk-comprehend-s3olap.AdminRole.toString"></a>
176
+
177
+ ```typescript
178
+ public toString(): string
179
+ ```
180
+
181
+ Returns a string representation of this construct.
182
+
183
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
184
+
185
+ | **Name** | **Description** |
186
+ | --- | --- |
187
+ | <code><a href="#cdk-comprehend-s3olap.AdminRole.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
188
+
189
+ ---
190
+
191
+ ##### `isConstruct` <a name="isConstruct" id="cdk-comprehend-s3olap.AdminRole.isConstruct"></a>
192
+
193
+ ```typescript
194
+ import { AdminRole } from 'cdk-comprehend-s3olap'
195
+
196
+ AdminRole.isConstruct(x: any)
197
+ ```
198
+
199
+ Checks if `x` is a construct.
200
+
201
+ Use this method instead of `instanceof` to properly detect `Construct`
202
+ instances, even when the construct library is symlinked.
203
+
204
+ Explanation: in JavaScript, multiple copies of the `constructs` library on
205
+ disk are seen as independent, completely different libraries. As a
206
+ consequence, the class `Construct` in each copy of the `constructs` library
207
+ is seen as a different class, and an instance of one class will not test as
208
+ `instanceof` the other class. `npm install` will not create installations
209
+ like this, but users may manually symlink construct libraries together or
210
+ use a monorepo tool: in those cases, multiple copies of the `constructs`
211
+ library can be accidentally installed, and `instanceof` will behave
212
+ unpredictably. It is safest to avoid using `instanceof`, and using
213
+ this type-testing method instead.
214
+
215
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-comprehend-s3olap.AdminRole.isConstruct.parameter.x"></a>
216
+
217
+ - *Type:* any
218
+
219
+ Any object.
220
+
221
+ ---
222
+
223
+ #### Properties <a name="Properties" id="Properties"></a>
224
+
225
+ | **Name** | **Type** | **Description** |
226
+ | --- | --- | --- |
227
+ | <code><a href="#cdk-comprehend-s3olap.AdminRole.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
228
+ | <code><a href="#cdk-comprehend-s3olap.AdminRole.property.roleArn">roleArn</a></code> | <code>string</code> | The ARN of the IAM role. |
229
+ | <code><a href="#cdk-comprehend-s3olap.AdminRole.property.roleId">roleId</a></code> | <code>string</code> | The unique string identifying the role. |
230
+ | <code><a href="#cdk-comprehend-s3olap.AdminRole.property.roleName">roleName</a></code> | <code>string</code> | The name of the IAM role. |
231
+
232
+ ---
233
+
234
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-comprehend-s3olap.AdminRole.property.node"></a>
235
+
236
+ ```typescript
237
+ public readonly node: Node;
238
+ ```
239
+
240
+ - *Type:* constructs.Node
241
+
242
+ The tree node.
243
+
244
+ ---
245
+
246
+ ##### `roleArn`<sup>Required</sup> <a name="roleArn" id="cdk-comprehend-s3olap.AdminRole.property.roleArn"></a>
247
+
248
+ ```typescript
249
+ public readonly roleArn: string;
250
+ ```
251
+
252
+ - *Type:* string
253
+
254
+ The ARN of the IAM role.
106
255
 
256
+ ---
107
257
 
258
+ ##### `roleId`<sup>Required</sup> <a name="roleId" id="cdk-comprehend-s3olap.AdminRole.property.roleId"></a>
108
259
 
109
- ### Properties
260
+ ```typescript
261
+ public readonly roleId: string;
262
+ ```
110
263
 
264
+ - *Type:* string
111
265
 
112
- Name | Type | Description
113
- -----|------|-------------
114
- **roleArn** | <code>string</code> | The ARN of the IAM role.
115
- **roleId** | <code>string</code> | The unique string identifying the role.
116
- **roleName** | <code>string</code> | The name of the IAM role.
266
+ The unique string identifying the role.
117
267
 
268
+ ---
118
269
 
270
+ ##### `roleName`<sup>Required</sup> <a name="roleName" id="cdk-comprehend-s3olap.AdminRole.property.roleName"></a>
119
271
 
120
- ## class BillingRole <a id="cdk-comprehend-s3olap-billingrole"></a>
272
+ ```typescript
273
+ public readonly roleName: string;
274
+ ```
121
275
 
276
+ - *Type:* string
122
277
 
278
+ The name of the IAM role.
123
279
 
124
- __Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable)
125
- __Extends__: [Construct](#constructs-construct)
280
+ ---
126
281
 
127
- ### Initializer
128
282
 
283
+ ### BillingRole <a name="BillingRole" id="cdk-comprehend-s3olap.BillingRole"></a>
129
284
 
285
+ #### Initializers <a name="Initializers" id="cdk-comprehend-s3olap.BillingRole.Initializer"></a>
130
286
 
287
+ ```typescript
288
+ import { BillingRole } from 'cdk-comprehend-s3olap'
131
289
 
132
- ```ts
133
290
  new BillingRole(scope: Construct, id: string, props?: AdminRoleProps)
134
291
  ```
135
292
 
136
- * **scope** (<code>[Construct](#constructs-construct)</code>) *No description*
137
- * **id** (<code>string</code>) *No description*
138
- * **props** (<code>[AdminRoleProps](#cdk-comprehend-s3olap-adminroleprops)</code>) *No description*
139
- * **iamRoleName** (<code>string</code>) The name of the IAM role. __*Default*__: 'RedactionAdminRole'
140
- * **objectLambdaAccessPointName** (<code>string</code>) The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration. __*Default*__: 'admin-s3olap-call-transcripts-known-pii'
141
- * **policyName** (<code>string</code>) The name of the IAM policy for the IAM role. __*Default*__: 'admin-role-s3olap-policy'
293
+ | **Name** | **Type** | **Description** |
294
+ | --- | --- | --- |
295
+ | <code><a href="#cdk-comprehend-s3olap.BillingRole.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
296
+ | <code><a href="#cdk-comprehend-s3olap.BillingRole.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
297
+ | <code><a href="#cdk-comprehend-s3olap.BillingRole.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-comprehend-s3olap.AdminRoleProps">AdminRoleProps</a></code> | *No description.* |
142
298
 
299
+ ---
143
300
 
301
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-comprehend-s3olap.BillingRole.Initializer.parameter.scope"></a>
144
302
 
145
- ### Properties
303
+ - *Type:* constructs.Construct
146
304
 
305
+ ---
147
306
 
148
- Name | Type | Description
149
- -----|------|-------------
150
- **roleArn** | <code>string</code> | The ARN of the IAM role.
151
- **roleId** | <code>string</code> | The unique string identifying the role.
152
- **roleName** | <code>string</code> | The name of the IAM role.
307
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-comprehend-s3olap.BillingRole.Initializer.parameter.id"></a>
153
308
 
309
+ - *Type:* string
154
310
 
311
+ ---
155
312
 
156
- ## class ComprehendS3olab <a id="cdk-comprehend-s3olap-comprehends3olab"></a>
313
+ ##### `props`<sup>Optional</sup> <a name="props" id="cdk-comprehend-s3olap.BillingRole.Initializer.parameter.props"></a>
157
314
 
158
- Creates the foundation necessary to deploy the S3 Object Lambda Acceess Control Use Case.
315
+ - *Type:* <a href="#cdk-comprehend-s3olap.AdminRoleProps">AdminRoleProps</a>
316
+
317
+ ---
318
+
319
+ #### Methods <a name="Methods" id="Methods"></a>
320
+
321
+ | **Name** | **Description** |
322
+ | --- | --- |
323
+ | <code><a href="#cdk-comprehend-s3olap.BillingRole.toString">toString</a></code> | Returns a string representation of this construct. |
324
+
325
+ ---
326
+
327
+ ##### `toString` <a name="toString" id="cdk-comprehend-s3olap.BillingRole.toString"></a>
328
+
329
+ ```typescript
330
+ public toString(): string
331
+ ```
332
+
333
+ Returns a string representation of this construct.
334
+
335
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
336
+
337
+ | **Name** | **Description** |
338
+ | --- | --- |
339
+ | <code><a href="#cdk-comprehend-s3olap.BillingRole.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
340
+
341
+ ---
342
+
343
+ ##### `isConstruct` <a name="isConstruct" id="cdk-comprehend-s3olap.BillingRole.isConstruct"></a>
344
+
345
+ ```typescript
346
+ import { BillingRole } from 'cdk-comprehend-s3olap'
347
+
348
+ BillingRole.isConstruct(x: any)
349
+ ```
350
+
351
+ Checks if `x` is a construct.
352
+
353
+ Use this method instead of `instanceof` to properly detect `Construct`
354
+ instances, even when the construct library is symlinked.
355
+
356
+ Explanation: in JavaScript, multiple copies of the `constructs` library on
357
+ disk are seen as independent, completely different libraries. As a
358
+ consequence, the class `Construct` in each copy of the `constructs` library
359
+ is seen as a different class, and an instance of one class will not test as
360
+ `instanceof` the other class. `npm install` will not create installations
361
+ like this, but users may manually symlink construct libraries together or
362
+ use a monorepo tool: in those cases, multiple copies of the `constructs`
363
+ library can be accidentally installed, and `instanceof` will behave
364
+ unpredictably. It is safest to avoid using `instanceof`, and using
365
+ this type-testing method instead.
366
+
367
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-comprehend-s3olap.BillingRole.isConstruct.parameter.x"></a>
368
+
369
+ - *Type:* any
370
+
371
+ Any object.
372
+
373
+ ---
374
+
375
+ #### Properties <a name="Properties" id="Properties"></a>
376
+
377
+ | **Name** | **Type** | **Description** |
378
+ | --- | --- | --- |
379
+ | <code><a href="#cdk-comprehend-s3olap.BillingRole.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
380
+ | <code><a href="#cdk-comprehend-s3olap.BillingRole.property.roleArn">roleArn</a></code> | <code>string</code> | The ARN of the IAM role. |
381
+ | <code><a href="#cdk-comprehend-s3olap.BillingRole.property.roleId">roleId</a></code> | <code>string</code> | The unique string identifying the role. |
382
+ | <code><a href="#cdk-comprehend-s3olap.BillingRole.property.roleName">roleName</a></code> | <code>string</code> | The name of the IAM role. |
383
+
384
+ ---
159
385
 
160
- __Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable)
161
- __Extends__: [Construct](#constructs-construct)
386
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-comprehend-s3olap.BillingRole.property.node"></a>
162
387
 
163
- ### Initializer
388
+ ```typescript
389
+ public readonly node: Node;
390
+ ```
391
+
392
+ - *Type:* constructs.Node
393
+
394
+ The tree node.
395
+
396
+ ---
397
+
398
+ ##### `roleArn`<sup>Required</sup> <a name="roleArn" id="cdk-comprehend-s3olap.BillingRole.property.roleArn"></a>
399
+
400
+ ```typescript
401
+ public readonly roleArn: string;
402
+ ```
403
+
404
+ - *Type:* string
405
+
406
+ The ARN of the IAM role.
407
+
408
+ ---
409
+
410
+ ##### `roleId`<sup>Required</sup> <a name="roleId" id="cdk-comprehend-s3olap.BillingRole.property.roleId"></a>
411
+
412
+ ```typescript
413
+ public readonly roleId: string;
414
+ ```
415
+
416
+ - *Type:* string
417
+
418
+ The unique string identifying the role.
419
+
420
+ ---
164
421
 
422
+ ##### `roleName`<sup>Required</sup> <a name="roleName" id="cdk-comprehend-s3olap.BillingRole.property.roleName"></a>
165
423
 
424
+ ```typescript
425
+ public readonly roleName: string;
426
+ ```
427
+
428
+ - *Type:* string
429
+
430
+ The name of the IAM role.
431
+
432
+ ---
433
+
434
+
435
+ ### ComprehendS3olab <a name="ComprehendS3olab" id="cdk-comprehend-s3olap.ComprehendS3olab"></a>
436
+
437
+ Creates the foundation necessary to deploy the S3 Object Lambda Acceess Control Use Case.
166
438
 
439
+ #### Initializers <a name="Initializers" id="cdk-comprehend-s3olap.ComprehendS3olab.Initializer"></a>
440
+
441
+ ```typescript
442
+ import { ComprehendS3olab } from 'cdk-comprehend-s3olap'
167
443
 
168
- ```ts
169
444
  new ComprehendS3olab(scope: Construct, id: string, props: ComprehendS3olabProps)
170
445
  ```
171
446
 
172
- * **scope** (<code>[Construct](#constructs-construct)</code>) *No description*
173
- * **id** (<code>string</code>) *No description*
174
- * **props** (<code>[ComprehendS3olabProps](#cdk-comprehend-s3olap-comprehends3olabprops)</code>) *No description*
175
- * **accessControlLambdaConfig** (<code>[AccessConrtolLambdaProps](#cdk-comprehend-s3olap-accessconrtollambdaprops)</code>) The parameters needed for the `ComprehendPiiAccessControlS3ObjectLambda` function. __*Optional*__
176
- * **adminRedactionLambdaConfig** (<code>[RedactionLambdaProps](#cdk-comprehend-s3olap-redactionlambdaprops)</code>) The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `AdminRole`. __*Optional*__
177
- * **adminRoleConfig** (<code>[AdminRoleProps](#cdk-comprehend-s3olap-adminroleprops)</code>) The manageable properties for the administrator IAM role in the redaction case. __*Optional*__
178
- * **billingRedactionLambdaConfig** (<code>[RedactionLambdaProps](#cdk-comprehend-s3olap-redactionlambdaprops)</code>) The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `BillingRole`. __*Optional*__
179
- * **billingRoleConfig** (<code>[BillingRoleProps](#cdk-comprehend-s3olap-billingroleprops)</code>) The manageable properties for the billing IAM role in the redaction case. __*Optional*__
180
- * **cusrtSupportRedactionLambdaConfig** (<code>[RedactionLambdaProps](#cdk-comprehend-s3olap-redactionlambdaprops)</code>) The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `CustSupportRole`. __*Optional*__
181
- * **custSupportRoleConfig** (<code>[CustSupportRoleProps](#cdk-comprehend-s3olap-custsupportroleprops)</code>) The manageable properties for the customer support IAM role in the redaction case. __*Optional*__
182
- * **exampleFileDir** (<code>string</code>) The directory path where `files/access_control/*.txt` and `files/redaction/*.txt` will be put. __*Default*__: __dirname
183
- * **generalRoleConfig** (<code>[GeneralRoleProps](#cdk-comprehend-s3olap-generalroleprops)</code>) The manageable properties for the IAM role used to access the `survey-results.txt` data. __*Optional*__
184
- * **generateRandomCharacters** (<code>boolean</code>) For distinguish test and normal deployment. __*Default*__: true
185
- * **s3AccessPointNames** (<code>[S3AccessPointNames](#cdk-comprehend-s3olap-s3accesspointnames)</code>) The names of the S3 access points for the access control case and redaction case. __*Optional*__
186
- * **surveyBucketPrefix** (<code>string</code>) The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the access control case. __*Default*__: 6 random words
187
- * **transcriptsBucketPrefix** (<code>string</code>) The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the redaction case. __*Default*__: 6 random words
447
+ | **Name** | **Type** | **Description** |
448
+ | --- | --- | --- |
449
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
450
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
451
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps">ComprehendS3olabProps</a></code> | *No description.* |
452
+
453
+ ---
454
+
455
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-comprehend-s3olap.ComprehendS3olab.Initializer.parameter.scope"></a>
456
+
457
+ - *Type:* constructs.Construct
458
+
459
+ ---
460
+
461
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-comprehend-s3olap.ComprehendS3olab.Initializer.parameter.id"></a>
462
+
463
+ - *Type:* string
464
+
465
+ ---
466
+
467
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-comprehend-s3olap.ComprehendS3olab.Initializer.parameter.props"></a>
468
+
469
+ - *Type:* <a href="#cdk-comprehend-s3olap.ComprehendS3olabProps">ComprehendS3olabProps</a>
470
+
471
+ ---
472
+
473
+ #### Methods <a name="Methods" id="Methods"></a>
474
+
475
+ | **Name** | **Description** |
476
+ | --- | --- |
477
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.toString">toString</a></code> | Returns a string representation of this construct. |
478
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.generateS3Prefix">generateS3Prefix</a></code> | *No description.* |
479
+
480
+ ---
481
+
482
+ ##### `toString` <a name="toString" id="cdk-comprehend-s3olap.ComprehendS3olab.toString"></a>
483
+
484
+ ```typescript
485
+ public toString(): string
486
+ ```
487
+
488
+ Returns a string representation of this construct.
489
+
490
+ ##### `generateS3Prefix` <a name="generateS3Prefix" id="cdk-comprehend-s3olap.ComprehendS3olab.generateS3Prefix"></a>
491
+
492
+ ```typescript
493
+ public generateS3Prefix(length: number): string
494
+ ```
495
+
496
+ ###### `length`<sup>Required</sup> <a name="length" id="cdk-comprehend-s3olap.ComprehendS3olab.generateS3Prefix.parameter.length"></a>
497
+
498
+ - *Type:* number
499
+
500
+ ---
501
+
502
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
503
+
504
+ | **Name** | **Description** |
505
+ | --- | --- |
506
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
507
+
508
+ ---
509
+
510
+ ##### `isConstruct` <a name="isConstruct" id="cdk-comprehend-s3olap.ComprehendS3olab.isConstruct"></a>
511
+
512
+ ```typescript
513
+ import { ComprehendS3olab } from 'cdk-comprehend-s3olap'
514
+
515
+ ComprehendS3olab.isConstruct(x: any)
516
+ ```
517
+
518
+ Checks if `x` is a construct.
519
+
520
+ Use this method instead of `instanceof` to properly detect `Construct`
521
+ instances, even when the construct library is symlinked.
522
+
523
+ Explanation: in JavaScript, multiple copies of the `constructs` library on
524
+ disk are seen as independent, completely different libraries. As a
525
+ consequence, the class `Construct` in each copy of the `constructs` library
526
+ is seen as a different class, and an instance of one class will not test as
527
+ `instanceof` the other class. `npm install` will not create installations
528
+ like this, but users may manually symlink construct libraries together or
529
+ use a monorepo tool: in those cases, multiple copies of the `constructs`
530
+ library can be accidentally installed, and `instanceof` will behave
531
+ unpredictably. It is safest to avoid using `instanceof`, and using
532
+ this type-testing method instead.
533
+
534
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-comprehend-s3olap.ComprehendS3olab.isConstruct.parameter.x"></a>
535
+
536
+ - *Type:* any
537
+
538
+ Any object.
539
+
540
+ ---
541
+
542
+ #### Properties <a name="Properties" id="Properties"></a>
543
+
544
+ | **Name** | **Type** | **Description** |
545
+ | --- | --- | --- |
546
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
547
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.property.adminLambdaArn">adminLambdaArn</a></code> | <code>string</code> | The ARN of the Lambda function combined with Amazon Comprehend for thie administrator role in the redaction case. |
548
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.property.billingLambdaArn">billingLambdaArn</a></code> | <code>string</code> | The ARN of the Lambda function combined with Amazon Comprehend for thie billing role in the redaction case. |
549
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.property.customerSupportLambdaArn">customerSupportLambdaArn</a></code> | <code>string</code> | The ARN of the Lambda function combined with Amazon Comprehend for thie customer support role in the redaction case. |
550
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.property.piiAccessConrtolLambdaArn">piiAccessConrtolLambdaArn</a></code> | <code>string</code> | The ARN of the Lambda function combined with Amazon Comprehend for the general case. |
551
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.property.s3objectLambdaAccessControlArn">s3objectLambdaAccessControlArn</a></code> | <code>string</code> | The ARN of the S3 Object Lambda for access control. |
552
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.property.s3objectLambdaAdminArn">s3objectLambdaAdminArn</a></code> | <code>string</code> | The ARN of the S3 Object Lambda for the admin role in the redaction case. |
553
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.property.s3objectLambdaBillingArn">s3objectLambdaBillingArn</a></code> | <code>string</code> | The ARN of the S3 Object Lambda for the billing role in the redaction case. |
554
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olab.property.s3objectLambdaCustomerSupportArn">s3objectLambdaCustomerSupportArn</a></code> | <code>string</code> | The ARN of the S3 Object Lambda for the customer support role in the redaction case. |
555
+
556
+ ---
557
+
558
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-comprehend-s3olap.ComprehendS3olab.property.node"></a>
559
+
560
+ ```typescript
561
+ public readonly node: Node;
562
+ ```
563
+
564
+ - *Type:* constructs.Node
565
+
566
+ The tree node.
567
+
568
+ ---
569
+
570
+ ##### `adminLambdaArn`<sup>Required</sup> <a name="adminLambdaArn" id="cdk-comprehend-s3olap.ComprehendS3olab.property.adminLambdaArn"></a>
571
+
572
+ ```typescript
573
+ public readonly adminLambdaArn: string;
574
+ ```
575
+
576
+ - *Type:* string
577
+
578
+ The ARN of the Lambda function combined with Amazon Comprehend for thie administrator role in the redaction case.
579
+
580
+ ---
581
+
582
+ ##### `billingLambdaArn`<sup>Required</sup> <a name="billingLambdaArn" id="cdk-comprehend-s3olap.ComprehendS3olab.property.billingLambdaArn"></a>
583
+
584
+ ```typescript
585
+ public readonly billingLambdaArn: string;
586
+ ```
587
+
588
+ - *Type:* string
589
+
590
+ The ARN of the Lambda function combined with Amazon Comprehend for thie billing role in the redaction case.
591
+
592
+ ---
593
+
594
+ ##### `customerSupportLambdaArn`<sup>Required</sup> <a name="customerSupportLambdaArn" id="cdk-comprehend-s3olap.ComprehendS3olab.property.customerSupportLambdaArn"></a>
595
+
596
+ ```typescript
597
+ public readonly customerSupportLambdaArn: string;
598
+ ```
599
+
600
+ - *Type:* string
601
+
602
+ The ARN of the Lambda function combined with Amazon Comprehend for thie customer support role in the redaction case.
603
+
604
+ ---
605
+
606
+ ##### `piiAccessConrtolLambdaArn`<sup>Required</sup> <a name="piiAccessConrtolLambdaArn" id="cdk-comprehend-s3olap.ComprehendS3olab.property.piiAccessConrtolLambdaArn"></a>
607
+
608
+ ```typescript
609
+ public readonly piiAccessConrtolLambdaArn: string;
610
+ ```
611
+
612
+ - *Type:* string
613
+
614
+ The ARN of the Lambda function combined with Amazon Comprehend for the general case.
615
+
616
+ ---
617
+
618
+ ##### `s3objectLambdaAccessControlArn`<sup>Required</sup> <a name="s3objectLambdaAccessControlArn" id="cdk-comprehend-s3olap.ComprehendS3olab.property.s3objectLambdaAccessControlArn"></a>
188
619
 
620
+ ```typescript
621
+ public readonly s3objectLambdaAccessControlArn: string;
622
+ ```
189
623
 
624
+ - *Type:* string
190
625
 
191
- ### Properties
626
+ The ARN of the S3 Object Lambda for access control.
192
627
 
628
+ ---
193
629
 
194
- Name | Type | Description
195
- -----|------|-------------
196
- **adminLambdaArn** | <code>string</code> | The ARN of the Lambda function combined with Amazon Comprehend for thie administrator role in the redaction case.
197
- **billingLambdaArn** | <code>string</code> | The ARN of the Lambda function combined with Amazon Comprehend for thie billing role in the redaction case.
198
- **customerSupportLambdaArn** | <code>string</code> | The ARN of the Lambda function combined with Amazon Comprehend for thie customer support role in the redaction case.
199
- **piiAccessConrtolLambdaArn** | <code>string</code> | The ARN of the Lambda function combined with Amazon Comprehend for the general case.
200
- **s3objectLambdaAccessControlArn** | <code>string</code> | The ARN of the S3 Object Lambda for access control.
201
- **s3objectLambdaAdminArn** | <code>string</code> | The ARN of the S3 Object Lambda for the admin role in the redaction case.
202
- **s3objectLambdaBillingArn** | <code>string</code> | The ARN of the S3 Object Lambda for the billing role in the redaction case.
203
- **s3objectLambdaCustomerSupportArn** | <code>string</code> | The ARN of the S3 Object Lambda for the customer support role in the redaction case.
630
+ ##### `s3objectLambdaAdminArn`<sup>Required</sup> <a name="s3objectLambdaAdminArn" id="cdk-comprehend-s3olap.ComprehendS3olab.property.s3objectLambdaAdminArn"></a>
204
631
 
205
- ### Methods
632
+ ```typescript
633
+ public readonly s3objectLambdaAdminArn: string;
634
+ ```
206
635
 
636
+ - *Type:* string
207
637
 
208
- #### generateS3Prefix(length) <a id="cdk-comprehend-s3olap-comprehends3olab-generates3prefix"></a>
638
+ The ARN of the S3 Object Lambda for the admin role in the redaction case.
209
639
 
640
+ ---
210
641
 
642
+ ##### `s3objectLambdaBillingArn`<sup>Required</sup> <a name="s3objectLambdaBillingArn" id="cdk-comprehend-s3olap.ComprehendS3olab.property.s3objectLambdaBillingArn"></a>
211
643
 
212
- ```ts
213
- generateS3Prefix(length: number): string
644
+ ```typescript
645
+ public readonly s3objectLambdaBillingArn: string;
214
646
  ```
215
647
 
216
- * **length** (<code>number</code>) *No description*
648
+ - *Type:* string
217
649
 
218
- __Returns__:
219
- * <code>string</code>
650
+ The ARN of the S3 Object Lambda for the billing role in the redaction case.
220
651
 
652
+ ---
221
653
 
654
+ ##### `s3objectLambdaCustomerSupportArn`<sup>Required</sup> <a name="s3objectLambdaCustomerSupportArn" id="cdk-comprehend-s3olap.ComprehendS3olab.property.s3objectLambdaCustomerSupportArn"></a>
222
655
 
223
- ## class CustSupportRole <a id="cdk-comprehend-s3olap-custsupportrole"></a>
656
+ ```typescript
657
+ public readonly s3objectLambdaCustomerSupportArn: string;
658
+ ```
224
659
 
660
+ - *Type:* string
225
661
 
662
+ The ARN of the S3 Object Lambda for the customer support role in the redaction case.
226
663
 
227
- __Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable)
228
- __Extends__: [Construct](#constructs-construct)
664
+ ---
229
665
 
230
- ### Initializer
231
666
 
667
+ ### CustSupportRole <a name="CustSupportRole" id="cdk-comprehend-s3olap.CustSupportRole"></a>
232
668
 
669
+ #### Initializers <a name="Initializers" id="cdk-comprehend-s3olap.CustSupportRole.Initializer"></a>
233
670
 
671
+ ```typescript
672
+ import { CustSupportRole } from 'cdk-comprehend-s3olap'
234
673
 
235
- ```ts
236
674
  new CustSupportRole(scope: Construct, id: string, props?: AdminRoleProps)
237
675
  ```
238
676
 
239
- * **scope** (<code>[Construct](#constructs-construct)</code>) *No description*
240
- * **id** (<code>string</code>) *No description*
241
- * **props** (<code>[AdminRoleProps](#cdk-comprehend-s3olap-adminroleprops)</code>) *No description*
242
- * **iamRoleName** (<code>string</code>) The name of the IAM role. __*Default*__: 'RedactionAdminRole'
243
- * **objectLambdaAccessPointName** (<code>string</code>) The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration. __*Default*__: 'admin-s3olap-call-transcripts-known-pii'
244
- * **policyName** (<code>string</code>) The name of the IAM policy for the IAM role. __*Default*__: 'admin-role-s3olap-policy'
677
+ | **Name** | **Type** | **Description** |
678
+ | --- | --- | --- |
679
+ | <code><a href="#cdk-comprehend-s3olap.CustSupportRole.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
680
+ | <code><a href="#cdk-comprehend-s3olap.CustSupportRole.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
681
+ | <code><a href="#cdk-comprehend-s3olap.CustSupportRole.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-comprehend-s3olap.AdminRoleProps">AdminRoleProps</a></code> | *No description.* |
245
682
 
683
+ ---
246
684
 
685
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-comprehend-s3olap.CustSupportRole.Initializer.parameter.scope"></a>
247
686
 
248
- ### Properties
687
+ - *Type:* constructs.Construct
249
688
 
689
+ ---
250
690
 
251
- Name | Type | Description
252
- -----|------|-------------
253
- **roleArn** | <code>string</code> | The ARN of the IAM role.
254
- **roleId** | <code>string</code> | The unique string identifying the role.
255
- **roleName** | <code>string</code> | The name of the IAM role.
691
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-comprehend-s3olap.CustSupportRole.Initializer.parameter.id"></a>
256
692
 
693
+ - *Type:* string
257
694
 
695
+ ---
258
696
 
259
- ## class GeneralRole <a id="cdk-comprehend-s3olap-generalrole"></a>
697
+ ##### `props`<sup>Optional</sup> <a name="props" id="cdk-comprehend-s3olap.CustSupportRole.Initializer.parameter.props"></a>
260
698
 
261
- The role that you are going to assume (switch role).
699
+ - *Type:* <a href="#cdk-comprehend-s3olap.AdminRoleProps">AdminRoleProps</a>
262
700
 
263
- Explores how the S3 Object Lambda works.
701
+ ---
702
+
703
+ #### Methods <a name="Methods" id="Methods"></a>
264
704
 
265
- __Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable)
266
- __Extends__: [Construct](#constructs-construct)
705
+ | **Name** | **Description** |
706
+ | --- | --- |
707
+ | <code><a href="#cdk-comprehend-s3olap.CustSupportRole.toString">toString</a></code> | Returns a string representation of this construct. |
267
708
 
268
- ### Initializer
709
+ ---
269
710
 
711
+ ##### `toString` <a name="toString" id="cdk-comprehend-s3olap.CustSupportRole.toString"></a>
270
712
 
713
+ ```typescript
714
+ public toString(): string
715
+ ```
271
716
 
717
+ Returns a string representation of this construct.
272
718
 
273
- ```ts
274
- new GeneralRole(scope: Construct, id: string, props: GeneralRoleProps)
719
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
720
+
721
+ | **Name** | **Description** |
722
+ | --- | --- |
723
+ | <code><a href="#cdk-comprehend-s3olap.CustSupportRole.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
724
+
725
+ ---
726
+
727
+ ##### `isConstruct` <a name="isConstruct" id="cdk-comprehend-s3olap.CustSupportRole.isConstruct"></a>
728
+
729
+ ```typescript
730
+ import { CustSupportRole } from 'cdk-comprehend-s3olap'
731
+
732
+ CustSupportRole.isConstruct(x: any)
275
733
  ```
276
734
 
277
- * **scope** (<code>[Construct](#constructs-construct)</code>) *No description*
278
- * **id** (<code>string</code>) *No description*
279
- * **props** (<code>[GeneralRoleProps](#cdk-comprehend-s3olap-generalroleprops)</code>) *No description*
280
- * **iamRoleName** (<code>string</code>) The name of the IAM role. __*Default*__: 'GeneralRole'
281
- * **objectLambdaAccessPointName** (<code>string</code>) The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration. __*Default*__: 'accessctl-s3olap-survey-results-unknown-pii'
282
- * **policyName** (<code>string</code>) The name of the IAM policy for the IAM role. __*Default*__: 'general-role-s3olap-policy'
735
+ Checks if `x` is a construct.
283
736
 
737
+ Use this method instead of `instanceof` to properly detect `Construct`
738
+ instances, even when the construct library is symlinked.
284
739
 
740
+ Explanation: in JavaScript, multiple copies of the `constructs` library on
741
+ disk are seen as independent, completely different libraries. As a
742
+ consequence, the class `Construct` in each copy of the `constructs` library
743
+ is seen as a different class, and an instance of one class will not test as
744
+ `instanceof` the other class. `npm install` will not create installations
745
+ like this, but users may manually symlink construct libraries together or
746
+ use a monorepo tool: in those cases, multiple copies of the `constructs`
747
+ library can be accidentally installed, and `instanceof` will behave
748
+ unpredictably. It is safest to avoid using `instanceof`, and using
749
+ this type-testing method instead.
285
750
 
286
- ### Properties
751
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-comprehend-s3olap.CustSupportRole.isConstruct.parameter.x"></a>
287
752
 
753
+ - *Type:* any
288
754
 
289
- Name | Type | Description
290
- -----|------|-------------
291
- **roleArn** | <code>string</code> | The ARN of the IAM role.
292
- **roleId** | <code>string</code> | The unique string identifying the role.
293
- **roleName** | <code>string</code> | The name of the IAM role.
755
+ Any object.
294
756
 
757
+ ---
295
758
 
759
+ #### Properties <a name="Properties" id="Properties"></a>
296
760
 
297
- ## class LambdaArnCaptorCustomResource <a id="cdk-comprehend-s3olap-lambdaarncaptorcustomresource"></a>
761
+ | **Name** | **Type** | **Description** |
762
+ | --- | --- | --- |
763
+ | <code><a href="#cdk-comprehend-s3olap.CustSupportRole.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
764
+ | <code><a href="#cdk-comprehend-s3olap.CustSupportRole.property.roleArn">roleArn</a></code> | <code>string</code> | The ARN of the IAM role. |
765
+ | <code><a href="#cdk-comprehend-s3olap.CustSupportRole.property.roleId">roleId</a></code> | <code>string</code> | The unique string identifying the role. |
766
+ | <code><a href="#cdk-comprehend-s3olap.CustSupportRole.property.roleName">roleName</a></code> | <code>string</code> | The name of the IAM role. |
298
767
 
768
+ ---
299
769
 
770
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-comprehend-s3olap.CustSupportRole.property.node"></a>
300
771
 
301
- __Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable)
302
- __Extends__: [Construct](#constructs-construct)
772
+ ```typescript
773
+ public readonly node: Node;
774
+ ```
303
775
 
304
- ### Initializer
776
+ - *Type:* constructs.Node
305
777
 
778
+ The tree node.
306
779
 
780
+ ---
307
781
 
782
+ ##### `roleArn`<sup>Required</sup> <a name="roleArn" id="cdk-comprehend-s3olap.CustSupportRole.property.roleArn"></a>
308
783
 
309
- ```ts
310
- new LambdaArnCaptorCustomResource(scope: Construct, id: string, props: LambdaArnCaptorResourceProps)
784
+ ```typescript
785
+ public readonly roleArn: string;
786
+ ```
787
+
788
+ - *Type:* string
789
+
790
+ The ARN of the IAM role.
791
+
792
+ ---
793
+
794
+ ##### `roleId`<sup>Required</sup> <a name="roleId" id="cdk-comprehend-s3olap.CustSupportRole.property.roleId"></a>
795
+
796
+ ```typescript
797
+ public readonly roleId: string;
798
+ ```
799
+
800
+ - *Type:* string
801
+
802
+ The unique string identifying the role.
803
+
804
+ ---
805
+
806
+ ##### `roleName`<sup>Required</sup> <a name="roleName" id="cdk-comprehend-s3olap.CustSupportRole.property.roleName"></a>
807
+
808
+ ```typescript
809
+ public readonly roleName: string;
311
810
  ```
312
811
 
313
- * **scope** (<code>[Construct](#constructs-construct)</code>) *No description*
314
- * **id** (<code>string</code>) *No description*
315
- * **props** (<code>[LambdaArnCaptorResourceProps](#cdk-comprehend-s3olap-lambdaarncaptorresourceprops)</code>) *No description*
316
- * **partialLambdaName** (<code>string</code>) The partial fixed name of the gemeral Lambda function created from the serverless application.
317
- * **roleName** (<code>string</code>) the name of the corresponding IAM role.
812
+ - *Type:* string
318
813
 
814
+ The name of the IAM role.
319
815
 
816
+ ---
320
817
 
321
- ### Properties
322
818
 
819
+ ### GeneralRole <a name="GeneralRole" id="cdk-comprehend-s3olap.GeneralRole"></a>
323
820
 
324
- Name | Type | Description
325
- -----|------|-------------
326
- **lambdaArn** | <code>string</code> | The ARN of the general Lambda function created from the serverless application.
821
+ The role that you are going to assume (switch role).
327
822
 
823
+ Explores how the S3 Object Lambda works.
328
824
 
825
+ #### Initializers <a name="Initializers" id="cdk-comprehend-s3olap.GeneralRole.Initializer"></a>
329
826
 
330
- ## class RedactionLambda <a id="cdk-comprehend-s3olap-redactionlambda"></a>
827
+ ```typescript
828
+ import { GeneralRole } from 'cdk-comprehend-s3olap'
331
829
 
830
+ new GeneralRole(scope: Construct, id: string, props: GeneralRoleProps)
831
+ ```
332
832
 
833
+ | **Name** | **Type** | **Description** |
834
+ | --- | --- | --- |
835
+ | <code><a href="#cdk-comprehend-s3olap.GeneralRole.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
836
+ | <code><a href="#cdk-comprehend-s3olap.GeneralRole.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
837
+ | <code><a href="#cdk-comprehend-s3olap.GeneralRole.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-comprehend-s3olap.GeneralRoleProps">GeneralRoleProps</a></code> | *No description.* |
333
838
 
334
- __Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable)
335
- __Extends__: [Construct](#constructs-construct)
839
+ ---
336
840
 
337
- ### Initializer
841
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-comprehend-s3olap.GeneralRole.Initializer.parameter.scope"></a>
338
842
 
843
+ - *Type:* constructs.Construct
339
844
 
845
+ ---
340
846
 
847
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-comprehend-s3olap.GeneralRole.Initializer.parameter.id"></a>
341
848
 
342
- ```ts
343
- new RedactionLambda(scope: Construct, id: string, props?: RedactionLambdaProps)
849
+ - *Type:* string
850
+
851
+ ---
852
+
853
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-comprehend-s3olap.GeneralRole.Initializer.parameter.props"></a>
854
+
855
+ - *Type:* <a href="#cdk-comprehend-s3olap.GeneralRoleProps">GeneralRoleProps</a>
856
+
857
+ ---
858
+
859
+ #### Methods <a name="Methods" id="Methods"></a>
860
+
861
+ | **Name** | **Description** |
862
+ | --- | --- |
863
+ | <code><a href="#cdk-comprehend-s3olap.GeneralRole.toString">toString</a></code> | Returns a string representation of this construct. |
864
+
865
+ ---
866
+
867
+ ##### `toString` <a name="toString" id="cdk-comprehend-s3olap.GeneralRole.toString"></a>
868
+
869
+ ```typescript
870
+ public toString(): string
871
+ ```
872
+
873
+ Returns a string representation of this construct.
874
+
875
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
876
+
877
+ | **Name** | **Description** |
878
+ | --- | --- |
879
+ | <code><a href="#cdk-comprehend-s3olap.GeneralRole.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
880
+
881
+ ---
882
+
883
+ ##### `isConstruct` <a name="isConstruct" id="cdk-comprehend-s3olap.GeneralRole.isConstruct"></a>
884
+
885
+ ```typescript
886
+ import { GeneralRole } from 'cdk-comprehend-s3olap'
887
+
888
+ GeneralRole.isConstruct(x: any)
344
889
  ```
345
890
 
346
- * **scope** (<code>[Construct](#constructs-construct)</code>) *No description*
347
- * **id** (<code>string</code>) *No description*
348
- * **props** (<code>[RedactionLambdaProps](#cdk-comprehend-s3olap-redactionlambdaprops)</code>) *No description*
349
- * **confidenceThreshold** (<code>string</code>) The minimum prediction confidence score above which PII classification and detection would be considered as final answer. __*Default*__: '0.5'
350
- * **containsPiiEntitiesThreadCount** (<code>string</code>) Number of threads to use for calling Comprehend's ContainsPiiEntities API. __*Default*__: '20'
351
- * **defaultLanguageCode** (<code>string</code>) Default language of the text to be processed. __*Default*__: 'en'
352
- * **detectPiiEntitiesThreadCount** (<code>string</code>) Number of threads to use for calling Comprehend's DetectPiiEntities API. __*Default*__: '8'
353
- * **documentMaxSize** (<code>string</code>) Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size. __*Default*__: '102400'
354
- * **documentMaxSizeContainsPiiEntities** (<code>string</code>) Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API. __*Default*__: '50000'
355
- * **documentMaxSizeDetectPiiEntities** (<code>string</code>) Maximum document size (in bytes) to be used for making calls to Comprehend's DetectPiiEntities API. __*Default*__: '5000'
356
- * **isPartialObjectSupported** (<code>string</code>) Whether to support partial objects or not. __*Default*__: 'false'
357
- * **logLevel** (<code>string</code>) Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc. __*Default*__: 'INFO'
358
- * **maskCharacter** (<code>string</code>) A character that replaces each character in the redacted PII entity. __*Default*__: '*'
359
- * **maskMode** (<code>string</code>) Specifies whether the PII entity is redacted with the mask character or the entity type. __*Optional*__
360
- * **maxCharsOverlap** (<code>string</code>) Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit. __*Default*__: '200'
361
- * **piiEntityTypes** (<code>string</code>) List of comma separated PII entity types to be considered for redaction. __*Default*__: 'ALL'
362
- * **publishCloudWatchMetrics** (<code>string</code>) True if publish metrics to Cloudwatch, false otherwise. __*Default*__: 'true'
363
- * **semanticVersion** (<code>string</code>) The version of the serverless application. __*Default*__: '1.0.2'
364
- * **subsegmentOverlappingTokens** (<code>string</code>) Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit. __*Default*__: '20'
365
- * **unsupportedFileHandling** (<code>string</code>) Handling logic for Unsupported files. __*Default*__: 'FAIL'
891
+ Checks if `x` is a construct.
892
+
893
+ Use this method instead of `instanceof` to properly detect `Construct`
894
+ instances, even when the construct library is symlinked.
895
+
896
+ Explanation: in JavaScript, multiple copies of the `constructs` library on
897
+ disk are seen as independent, completely different libraries. As a
898
+ consequence, the class `Construct` in each copy of the `constructs` library
899
+ is seen as a different class, and an instance of one class will not test as
900
+ `instanceof` the other class. `npm install` will not create installations
901
+ like this, but users may manually symlink construct libraries together or
902
+ use a monorepo tool: in those cases, multiple copies of the `constructs`
903
+ library can be accidentally installed, and `instanceof` will behave
904
+ unpredictably. It is safest to avoid using `instanceof`, and using
905
+ this type-testing method instead.
906
+
907
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-comprehend-s3olap.GeneralRole.isConstruct.parameter.x"></a>
366
908
 
909
+ - *Type:* any
367
910
 
911
+ Any object.
368
912
 
369
- ### Properties
913
+ ---
370
914
 
915
+ #### Properties <a name="Properties" id="Properties"></a>
371
916
 
372
- Name | Type | Description
373
- -----|------|-------------
374
- **stackName** | <code>string</code> | The name of the underlying resoure in the serverless application.
917
+ | **Name** | **Type** | **Description** |
918
+ | --- | --- | --- |
919
+ | <code><a href="#cdk-comprehend-s3olap.GeneralRole.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
920
+ | <code><a href="#cdk-comprehend-s3olap.GeneralRole.property.roleArn">roleArn</a></code> | <code>string</code> | The ARN of the IAM role. |
921
+ | <code><a href="#cdk-comprehend-s3olap.GeneralRole.property.roleId">roleId</a></code> | <code>string</code> | The unique string identifying the role. |
922
+ | <code><a href="#cdk-comprehend-s3olap.GeneralRole.property.roleName">roleName</a></code> | <code>string</code> | The name of the IAM role. |
375
923
 
924
+ ---
376
925
 
926
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-comprehend-s3olap.GeneralRole.property.node"></a>
377
927
 
378
- ## struct AccessConrtolLambdaProps <a id="cdk-comprehend-s3olap-accessconrtollambdaprops"></a>
928
+ ```typescript
929
+ public readonly node: Node;
930
+ ```
931
+
932
+ - *Type:* constructs.Node
379
933
 
934
+ The tree node.
380
935
 
936
+ ---
381
937
 
938
+ ##### `roleArn`<sup>Required</sup> <a name="roleArn" id="cdk-comprehend-s3olap.GeneralRole.property.roleArn"></a>
939
+
940
+ ```typescript
941
+ public readonly roleArn: string;
942
+ ```
382
943
 
944
+ - *Type:* string
383
945
 
946
+ The ARN of the IAM role.
384
947
 
385
- Name | Type | Description
386
- -----|------|-------------
387
- **confidenceThreshold**? | <code>string</code> | The minimum prediction confidence score above which PII classification and detection would be considered as final answer.<br/>__*Default*__: '0.5'
388
- **containsPiiEntitiesThreadCount**? | <code>string</code> | Number of threads to use for calling Comprehend's ContainsPiiEntities API.<br/>__*Default*__: '20'
389
- **defaultLanguageCode**? | <code>string</code> | Default language of the text to be processed.<br/>__*Default*__: 'en'
390
- **documentMaxSize**? | <code>string</code> | Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size.<br/>__*Default*__: '102400'
391
- **documentMaxSizeContainsPiiEntities**? | <code>string</code> | Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API.<br/>__*Default*__: '50000'
392
- **isPartialObjectSupported**? | <code>string</code> | Whether to support partial objects or not.<br/>__*Default*__: 'false'
393
- **logLevel**? | <code>string</code> | Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc.<br/>__*Default*__: 'INFO'
394
- **maxCharsOverlap**? | <code>string</code> | Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit.<br/>__*Default*__: '200'
395
- **piiEntityTypes**? | <code>string</code> | List of comma separated PII entity types to be considered for access control.<br/>__*Default*__: 'ALL'
396
- **publishCloudWatchMetrics**? | <code>string</code> | True if publish metrics to Cloudwatch, false otherwise.<br/>__*Default*__: 'true'
397
- **semanticVersion**? | <code>string</code> | The version of the serverless application.<br/>__*Default*__: '1.0.2'
398
- **subsegmentOverlappingTokens**? | <code>string</code> | Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit.<br/>__*Default*__: '20'
399
- **unsupportedFileHandling**? | <code>string</code> | Handling logic for Unsupported files.<br/>__*Default*__: 'FAIL'
948
+ ---
400
949
 
950
+ ##### `roleId`<sup>Required</sup> <a name="roleId" id="cdk-comprehend-s3olap.GeneralRole.property.roleId"></a>
401
951
 
952
+ ```typescript
953
+ public readonly roleId: string;
954
+ ```
402
955
 
403
- ## struct AdminRoleProps <a id="cdk-comprehend-s3olap-adminroleprops"></a>
956
+ - *Type:* string
404
957
 
958
+ The unique string identifying the role.
405
959
 
960
+ ---
406
961
 
962
+ ##### `roleName`<sup>Required</sup> <a name="roleName" id="cdk-comprehend-s3olap.GeneralRole.property.roleName"></a>
407
963
 
964
+ ```typescript
965
+ public readonly roleName: string;
966
+ ```
408
967
 
968
+ - *Type:* string
409
969
 
410
- Name | Type | Description
411
- -----|------|-------------
412
- **iamRoleName**? | <code>string</code> | The name of the IAM role.<br/>__*Default*__: 'RedactionAdminRole'
413
- **objectLambdaAccessPointName**? | <code>string</code> | The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration.<br/>__*Default*__: 'admin-s3olap-call-transcripts-known-pii'
414
- **policyName**? | <code>string</code> | The name of the IAM policy for the IAM role.<br/>__*Default*__: 'admin-role-s3olap-policy'
970
+ The name of the IAM role.
415
971
 
972
+ ---
416
973
 
417
974
 
418
- ## struct BillingRoleProps <a id="cdk-comprehend-s3olap-billingroleprops"></a>
975
+ ### LambdaArnCaptorCustomResource <a name="LambdaArnCaptorCustomResource" id="cdk-comprehend-s3olap.LambdaArnCaptorCustomResource"></a>
419
976
 
977
+ #### Initializers <a name="Initializers" id="cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.Initializer"></a>
420
978
 
979
+ ```typescript
980
+ import { LambdaArnCaptorCustomResource } from 'cdk-comprehend-s3olap'
421
981
 
982
+ new LambdaArnCaptorCustomResource(scope: Construct, id: string, props: LambdaArnCaptorResourceProps)
983
+ ```
422
984
 
985
+ | **Name** | **Type** | **Description** |
986
+ | --- | --- | --- |
987
+ | <code><a href="#cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
988
+ | <code><a href="#cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
989
+ | <code><a href="#cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-comprehend-s3olap.LambdaArnCaptorResourceProps">LambdaArnCaptorResourceProps</a></code> | *No description.* |
423
990
 
991
+ ---
424
992
 
425
- Name | Type | Description
426
- -----|------|-------------
427
- **iamRoleName**? | <code>string</code> | The name of the IAM role.<br/>__*Default*__: 'RedactionBillingRole'
428
- **objectLambdaAccessPointName**? | <code>string</code> | The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration.<br/>__*Default*__: 'billing-s3olap-call-transcripts-known-pii'
429
- **policyName**? | <code>string</code> | The name of the IAM policy for the IAM role.<br/>__*Default*__: 'billing-role-s3olap-policy'
993
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.Initializer.parameter.scope"></a>
430
994
 
995
+ - *Type:* constructs.Construct
431
996
 
997
+ ---
432
998
 
433
- ## struct ComprehendS3olabProps <a id="cdk-comprehend-s3olap-comprehends3olabprops"></a>
999
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.Initializer.parameter.id"></a>
434
1000
 
1001
+ - *Type:* string
435
1002
 
1003
+ ---
436
1004
 
1005
+ ##### `props`<sup>Required</sup> <a name="props" id="cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.Initializer.parameter.props"></a>
437
1006
 
1007
+ - *Type:* <a href="#cdk-comprehend-s3olap.LambdaArnCaptorResourceProps">LambdaArnCaptorResourceProps</a>
438
1008
 
1009
+ ---
439
1010
 
440
- Name | Type | Description
441
- -----|------|-------------
442
- **accessControlLambdaConfig**? | <code>[AccessConrtolLambdaProps](#cdk-comprehend-s3olap-accessconrtollambdaprops)</code> | The parameters needed for the `ComprehendPiiAccessControlS3ObjectLambda` function.<br/>__*Optional*__
443
- **adminRedactionLambdaConfig**? | <code>[RedactionLambdaProps](#cdk-comprehend-s3olap-redactionlambdaprops)</code> | The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `AdminRole`.<br/>__*Optional*__
444
- **adminRoleConfig**? | <code>[AdminRoleProps](#cdk-comprehend-s3olap-adminroleprops)</code> | The manageable properties for the administrator IAM role in the redaction case.<br/>__*Optional*__
445
- **billingRedactionLambdaConfig**? | <code>[RedactionLambdaProps](#cdk-comprehend-s3olap-redactionlambdaprops)</code> | The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `BillingRole`.<br/>__*Optional*__
446
- **billingRoleConfig**? | <code>[BillingRoleProps](#cdk-comprehend-s3olap-billingroleprops)</code> | The manageable properties for the billing IAM role in the redaction case.<br/>__*Optional*__
447
- **cusrtSupportRedactionLambdaConfig**? | <code>[RedactionLambdaProps](#cdk-comprehend-s3olap-redactionlambdaprops)</code> | The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `CustSupportRole`.<br/>__*Optional*__
448
- **custSupportRoleConfig**? | <code>[CustSupportRoleProps](#cdk-comprehend-s3olap-custsupportroleprops)</code> | The manageable properties for the customer support IAM role in the redaction case.<br/>__*Optional*__
449
- **exampleFileDir**? | <code>string</code> | The directory path where `files/access_control/*.txt` and `files/redaction/*.txt` will be put.<br/>__*Default*__: __dirname
450
- **generalRoleConfig**? | <code>[GeneralRoleProps](#cdk-comprehend-s3olap-generalroleprops)</code> | The manageable properties for the IAM role used to access the `survey-results.txt` data.<br/>__*Optional*__
451
- **generateRandomCharacters**? | <code>boolean</code> | For distinguish test and normal deployment.<br/>__*Default*__: true
452
- **s3AccessPointNames**? | <code>[S3AccessPointNames](#cdk-comprehend-s3olap-s3accesspointnames)</code> | The names of the S3 access points for the access control case and redaction case.<br/>__*Optional*__
453
- **surveyBucketPrefix**? | <code>string</code> | The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the access control case.<br/>__*Default*__: 6 random words
454
- **transcriptsBucketPrefix**? | <code>string</code> | The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the redaction case.<br/>__*Default*__: 6 random words
1011
+ #### Methods <a name="Methods" id="Methods"></a>
455
1012
 
1013
+ | **Name** | **Description** |
1014
+ | --- | --- |
1015
+ | <code><a href="#cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.toString">toString</a></code> | Returns a string representation of this construct. |
456
1016
 
1017
+ ---
457
1018
 
458
- ## struct CustSupportRoleProps <a id="cdk-comprehend-s3olap-custsupportroleprops"></a>
1019
+ ##### `toString` <a name="toString" id="cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.toString"></a>
459
1020
 
1021
+ ```typescript
1022
+ public toString(): string
1023
+ ```
460
1024
 
1025
+ Returns a string representation of this construct.
461
1026
 
1027
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
462
1028
 
1029
+ | **Name** | **Description** |
1030
+ | --- | --- |
1031
+ | <code><a href="#cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
463
1032
 
1033
+ ---
464
1034
 
465
- Name | Type | Description
466
- -----|------|-------------
467
- **iamRoleName**? | <code>string</code> | The name of the IAM role.<br/>__*Default*__: 'RedactionCustSupportRole'
468
- **objectLambdaAccessPointName**? | <code>string</code> | The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration.<br/>__*Default*__: 'custsupport-s3olap-call-transcripts-known-pii'
469
- **policyName**? | <code>string</code> | The name of the IAM policy for the IAM role.<br/>__*Default*__: 'customersupport-role-s3olap-policy'
1035
+ ##### `isConstruct` <a name="isConstruct" id="cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.isConstruct"></a>
470
1036
 
1037
+ ```typescript
1038
+ import { LambdaArnCaptorCustomResource } from 'cdk-comprehend-s3olap'
471
1039
 
1040
+ LambdaArnCaptorCustomResource.isConstruct(x: any)
1041
+ ```
472
1042
 
473
- ## struct GeneralRoleProps <a id="cdk-comprehend-s3olap-generalroleprops"></a>
1043
+ Checks if `x` is a construct.
474
1044
 
1045
+ Use this method instead of `instanceof` to properly detect `Construct`
1046
+ instances, even when the construct library is symlinked.
475
1047
 
1048
+ Explanation: in JavaScript, multiple copies of the `constructs` library on
1049
+ disk are seen as independent, completely different libraries. As a
1050
+ consequence, the class `Construct` in each copy of the `constructs` library
1051
+ is seen as a different class, and an instance of one class will not test as
1052
+ `instanceof` the other class. `npm install` will not create installations
1053
+ like this, but users may manually symlink construct libraries together or
1054
+ use a monorepo tool: in those cases, multiple copies of the `constructs`
1055
+ library can be accidentally installed, and `instanceof` will behave
1056
+ unpredictably. It is safest to avoid using `instanceof`, and using
1057
+ this type-testing method instead.
476
1058
 
1059
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.isConstruct.parameter.x"></a>
477
1060
 
1061
+ - *Type:* any
478
1062
 
1063
+ Any object.
479
1064
 
480
- Name | Type | Description
481
- -----|------|-------------
482
- **iamRoleName**? | <code>string</code> | The name of the IAM role.<br/>__*Default*__: 'GeneralRole'
483
- **objectLambdaAccessPointName**? | <code>string</code> | The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration.<br/>__*Default*__: 'accessctl-s3olap-survey-results-unknown-pii'
484
- **policyName**? | <code>string</code> | The name of the IAM policy for the IAM role.<br/>__*Default*__: 'general-role-s3olap-policy'
1065
+ ---
485
1066
 
1067
+ #### Properties <a name="Properties" id="Properties"></a>
486
1068
 
1069
+ | **Name** | **Type** | **Description** |
1070
+ | --- | --- | --- |
1071
+ | <code><a href="#cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
1072
+ | <code><a href="#cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.property.lambdaArn">lambdaArn</a></code> | <code>string</code> | The ARN of the general Lambda function created from the serverless application. |
487
1073
 
488
- ## struct LambdaArnCaptorResourceProps <a id="cdk-comprehend-s3olap-lambdaarncaptorresourceprops"></a>
1074
+ ---
489
1075
 
1076
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.property.node"></a>
490
1077
 
1078
+ ```typescript
1079
+ public readonly node: Node;
1080
+ ```
491
1081
 
1082
+ - *Type:* constructs.Node
492
1083
 
1084
+ The tree node.
493
1085
 
1086
+ ---
494
1087
 
495
- Name | Type | Description
496
- -----|------|-------------
497
- **partialLambdaName** | <code>string</code> | The partial fixed name of the gemeral Lambda function created from the serverless application.
498
- **roleName** | <code>string</code> | the name of the corresponding IAM role.
1088
+ ##### `lambdaArn`<sup>Required</sup> <a name="lambdaArn" id="cdk-comprehend-s3olap.LambdaArnCaptorCustomResource.property.lambdaArn"></a>
499
1089
 
1090
+ ```typescript
1091
+ public readonly lambdaArn: string;
1092
+ ```
500
1093
 
1094
+ - *Type:* string
501
1095
 
502
- ## struct RedactionLambdaProps <a id="cdk-comprehend-s3olap-redactionlambdaprops"></a>
1096
+ The ARN of the general Lambda function created from the serverless application.
503
1097
 
1098
+ > [https://github.com/aws/aws-cdk/issues/8760](https://github.com/aws/aws-cdk/issues/8760)
1099
+
1100
+ ---
1101
+
1102
+
1103
+ ### RedactionLambda <a name="RedactionLambda" id="cdk-comprehend-s3olap.RedactionLambda"></a>
1104
+
1105
+ #### Initializers <a name="Initializers" id="cdk-comprehend-s3olap.RedactionLambda.Initializer"></a>
1106
+
1107
+ ```typescript
1108
+ import { RedactionLambda } from 'cdk-comprehend-s3olap'
1109
+
1110
+ new RedactionLambda(scope: Construct, id: string, props?: RedactionLambdaProps)
1111
+ ```
1112
+
1113
+ | **Name** | **Type** | **Description** |
1114
+ | --- | --- | --- |
1115
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambda.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
1116
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambda.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
1117
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambda.Initializer.parameter.props">props</a></code> | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps">RedactionLambdaProps</a></code> | *No description.* |
1118
+
1119
+ ---
1120
+
1121
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk-comprehend-s3olap.RedactionLambda.Initializer.parameter.scope"></a>
1122
+
1123
+ - *Type:* constructs.Construct
1124
+
1125
+ ---
1126
+
1127
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk-comprehend-s3olap.RedactionLambda.Initializer.parameter.id"></a>
1128
+
1129
+ - *Type:* string
1130
+
1131
+ ---
1132
+
1133
+ ##### `props`<sup>Optional</sup> <a name="props" id="cdk-comprehend-s3olap.RedactionLambda.Initializer.parameter.props"></a>
1134
+
1135
+ - *Type:* <a href="#cdk-comprehend-s3olap.RedactionLambdaProps">RedactionLambdaProps</a>
1136
+
1137
+ ---
1138
+
1139
+ #### Methods <a name="Methods" id="Methods"></a>
1140
+
1141
+ | **Name** | **Description** |
1142
+ | --- | --- |
1143
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambda.toString">toString</a></code> | Returns a string representation of this construct. |
1144
+
1145
+ ---
1146
+
1147
+ ##### `toString` <a name="toString" id="cdk-comprehend-s3olap.RedactionLambda.toString"></a>
1148
+
1149
+ ```typescript
1150
+ public toString(): string
1151
+ ```
1152
+
1153
+ Returns a string representation of this construct.
1154
+
1155
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
1156
+
1157
+ | **Name** | **Description** |
1158
+ | --- | --- |
1159
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambda.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
1160
+
1161
+ ---
1162
+
1163
+ ##### `isConstruct` <a name="isConstruct" id="cdk-comprehend-s3olap.RedactionLambda.isConstruct"></a>
1164
+
1165
+ ```typescript
1166
+ import { RedactionLambda } from 'cdk-comprehend-s3olap'
1167
+
1168
+ RedactionLambda.isConstruct(x: any)
1169
+ ```
1170
+
1171
+ Checks if `x` is a construct.
1172
+
1173
+ Use this method instead of `instanceof` to properly detect `Construct`
1174
+ instances, even when the construct library is symlinked.
1175
+
1176
+ Explanation: in JavaScript, multiple copies of the `constructs` library on
1177
+ disk are seen as independent, completely different libraries. As a
1178
+ consequence, the class `Construct` in each copy of the `constructs` library
1179
+ is seen as a different class, and an instance of one class will not test as
1180
+ `instanceof` the other class. `npm install` will not create installations
1181
+ like this, but users may manually symlink construct libraries together or
1182
+ use a monorepo tool: in those cases, multiple copies of the `constructs`
1183
+ library can be accidentally installed, and `instanceof` will behave
1184
+ unpredictably. It is safest to avoid using `instanceof`, and using
1185
+ this type-testing method instead.
1186
+
1187
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk-comprehend-s3olap.RedactionLambda.isConstruct.parameter.x"></a>
1188
+
1189
+ - *Type:* any
1190
+
1191
+ Any object.
1192
+
1193
+ ---
1194
+
1195
+ #### Properties <a name="Properties" id="Properties"></a>
1196
+
1197
+ | **Name** | **Type** | **Description** |
1198
+ | --- | --- | --- |
1199
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambda.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
1200
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambda.property.stackName">stackName</a></code> | <code>string</code> | The name of the underlying resoure in the serverless application. |
1201
+
1202
+ ---
1203
+
1204
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk-comprehend-s3olap.RedactionLambda.property.node"></a>
1205
+
1206
+ ```typescript
1207
+ public readonly node: Node;
1208
+ ```
1209
+
1210
+ - *Type:* constructs.Node
1211
+
1212
+ The tree node.
1213
+
1214
+ ---
1215
+
1216
+ ##### `stackName`<sup>Required</sup> <a name="stackName" id="cdk-comprehend-s3olap.RedactionLambda.property.stackName"></a>
1217
+
1218
+ ```typescript
1219
+ public readonly stackName: string;
1220
+ ```
1221
+
1222
+ - *Type:* string
1223
+
1224
+ The name of the underlying resoure in the serverless application.
1225
+
1226
+ ---
1227
+
1228
+
1229
+ ## Structs <a name="Structs" id="Structs"></a>
1230
+
1231
+ ### AccessConrtolLambdaProps <a name="AccessConrtolLambdaProps" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps"></a>
1232
+
1233
+ #### Initializer <a name="Initializer" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.Initializer"></a>
1234
+
1235
+ ```typescript
1236
+ import { AccessConrtolLambdaProps } from 'cdk-comprehend-s3olap'
1237
+
1238
+ const accessConrtolLambdaProps: AccessConrtolLambdaProps = { ... }
1239
+ ```
1240
+
1241
+ #### Properties <a name="Properties" id="Properties"></a>
1242
+
1243
+ | **Name** | **Type** | **Description** |
1244
+ | --- | --- | --- |
1245
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.confidenceThreshold">confidenceThreshold</a></code> | <code>string</code> | The minimum prediction confidence score above which PII classification and detection would be considered as final answer. |
1246
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.containsPiiEntitiesThreadCount">containsPiiEntitiesThreadCount</a></code> | <code>string</code> | Number of threads to use for calling Comprehend's ContainsPiiEntities API. |
1247
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.defaultLanguageCode">defaultLanguageCode</a></code> | <code>string</code> | Default language of the text to be processed. |
1248
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.documentMaxSize">documentMaxSize</a></code> | <code>string</code> | Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size. |
1249
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.documentMaxSizeContainsPiiEntities">documentMaxSizeContainsPiiEntities</a></code> | <code>string</code> | Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API. |
1250
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.isPartialObjectSupported">isPartialObjectSupported</a></code> | <code>string</code> | Whether to support partial objects or not. |
1251
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.logLevel">logLevel</a></code> | <code>string</code> | Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc. |
1252
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.maxCharsOverlap">maxCharsOverlap</a></code> | <code>string</code> | Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit. |
1253
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.piiEntityTypes">piiEntityTypes</a></code> | <code>string</code> | List of comma separated PII entity types to be considered for access control. |
1254
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.publishCloudWatchMetrics">publishCloudWatchMetrics</a></code> | <code>string</code> | True if publish metrics to Cloudwatch, false otherwise. |
1255
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.semanticVersion">semanticVersion</a></code> | <code>string</code> | The version of the serverless application. |
1256
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.subsegmentOverlappingTokens">subsegmentOverlappingTokens</a></code> | <code>string</code> | Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit. |
1257
+ | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.unsupportedFileHandling">unsupportedFileHandling</a></code> | <code>string</code> | Handling logic for Unsupported files. |
1258
+
1259
+ ---
1260
+
1261
+ ##### `confidenceThreshold`<sup>Optional</sup> <a name="confidenceThreshold" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.confidenceThreshold"></a>
1262
+
1263
+ ```typescript
1264
+ public readonly confidenceThreshold: string;
1265
+ ```
1266
+
1267
+ - *Type:* string
1268
+ - *Default:* '0.5'
1269
+
1270
+ The minimum prediction confidence score above which PII classification and detection would be considered as final answer.
1271
+
1272
+ Valid range (0.5 to 1.0).
1273
+
1274
+ ---
1275
+
1276
+ ##### `containsPiiEntitiesThreadCount`<sup>Optional</sup> <a name="containsPiiEntitiesThreadCount" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.containsPiiEntitiesThreadCount"></a>
1277
+
1278
+ ```typescript
1279
+ public readonly containsPiiEntitiesThreadCount: string;
1280
+ ```
1281
+
1282
+ - *Type:* string
1283
+ - *Default:* '20'
1284
+
1285
+ Number of threads to use for calling Comprehend's ContainsPiiEntities API.
1286
+
1287
+ This controls the number of simultaneous calls that will be made from this Lambda.
1288
+
1289
+ ---
1290
+
1291
+ ##### `defaultLanguageCode`<sup>Optional</sup> <a name="defaultLanguageCode" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.defaultLanguageCode"></a>
1292
+
1293
+ ```typescript
1294
+ public readonly defaultLanguageCode: string;
1295
+ ```
1296
+
1297
+ - *Type:* string
1298
+ - *Default:* 'en'
1299
+
1300
+ Default language of the text to be processed.
1301
+
1302
+ This code will be used for interacting with Comprehend.
1303
+
1304
+ ---
1305
+
1306
+ ##### `documentMaxSize`<sup>Optional</sup> <a name="documentMaxSize" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.documentMaxSize"></a>
1307
+
1308
+ ```typescript
1309
+ public readonly documentMaxSize: string;
1310
+ ```
1311
+
1312
+ - *Type:* string
1313
+ - *Default:* '102400'
1314
+
1315
+ Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size.
1316
+
1317
+ ---
1318
+
1319
+ ##### `documentMaxSizeContainsPiiEntities`<sup>Optional</sup> <a name="documentMaxSizeContainsPiiEntities" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.documentMaxSizeContainsPiiEntities"></a>
1320
+
1321
+ ```typescript
1322
+ public readonly documentMaxSizeContainsPiiEntities: string;
1323
+ ```
1324
+
1325
+ - *Type:* string
1326
+ - *Default:* '50000'
1327
+
1328
+ Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API.
1329
+
1330
+ ---
1331
+
1332
+ ##### `isPartialObjectSupported`<sup>Optional</sup> <a name="isPartialObjectSupported" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.isPartialObjectSupported"></a>
1333
+
1334
+ ```typescript
1335
+ public readonly isPartialObjectSupported: string;
1336
+ ```
1337
+
1338
+ - *Type:* string
1339
+ - *Default:* 'false'
1340
+
1341
+ Whether to support partial objects or not.
1342
+
1343
+ Accessing partial object through http headers such byte-range can corrupt the object and/or affect PII detection accuracy.
1344
+
1345
+ ---
1346
+
1347
+ ##### `logLevel`<sup>Optional</sup> <a name="logLevel" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.logLevel"></a>
1348
+
1349
+ ```typescript
1350
+ public readonly logLevel: string;
1351
+ ```
1352
+
1353
+ - *Type:* string
1354
+ - *Default:* 'INFO'
1355
+
1356
+ Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc.
1357
+
1358
+ ---
1359
+
1360
+ ##### `maxCharsOverlap`<sup>Optional</sup> <a name="maxCharsOverlap" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.maxCharsOverlap"></a>
1361
+
1362
+ ```typescript
1363
+ public readonly maxCharsOverlap: string;
1364
+ ```
1365
+
1366
+ - *Type:* string
1367
+ - *Default:* '200'
1368
+
1369
+ Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit.
1370
+
1371
+ ---
1372
+
1373
+ ##### `piiEntityTypes`<sup>Optional</sup> <a name="piiEntityTypes" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.piiEntityTypes"></a>
1374
+
1375
+ ```typescript
1376
+ public readonly piiEntityTypes: string;
1377
+ ```
1378
+
1379
+ - *Type:* string
1380
+ - *Default:* 'ALL'
1381
+
1382
+ List of comma separated PII entity types to be considered for access control.
1383
+
1384
+ Refer Comprehend's documentation page for list of supported PII entity types.
1385
+
1386
+ ---
1387
+
1388
+ ##### `publishCloudWatchMetrics`<sup>Optional</sup> <a name="publishCloudWatchMetrics" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.publishCloudWatchMetrics"></a>
1389
+
1390
+ ```typescript
1391
+ public readonly publishCloudWatchMetrics: string;
1392
+ ```
1393
+
1394
+ - *Type:* string
1395
+ - *Default:* 'true'
1396
+
1397
+ True if publish metrics to Cloudwatch, false otherwise.
1398
+
1399
+ See README.md for details on CloudWatch metrics.
1400
+
1401
+ ---
1402
+
1403
+ ##### `semanticVersion`<sup>Optional</sup> <a name="semanticVersion" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.semanticVersion"></a>
1404
+
1405
+ ```typescript
1406
+ public readonly semanticVersion: string;
1407
+ ```
1408
+
1409
+ - *Type:* string
1410
+ - *Default:* '1.0.2'
1411
+
1412
+ The version of the serverless application.
1413
+
1414
+ ---
1415
+
1416
+ ##### `subsegmentOverlappingTokens`<sup>Optional</sup> <a name="subsegmentOverlappingTokens" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.subsegmentOverlappingTokens"></a>
1417
+
1418
+ ```typescript
1419
+ public readonly subsegmentOverlappingTokens: string;
1420
+ ```
1421
+
1422
+ - *Type:* string
1423
+ - *Default:* '20'
1424
+
1425
+ Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit.
1426
+
1427
+ ---
1428
+
1429
+ ##### `unsupportedFileHandling`<sup>Optional</sup> <a name="unsupportedFileHandling" id="cdk-comprehend-s3olap.AccessConrtolLambdaProps.property.unsupportedFileHandling"></a>
1430
+
1431
+ ```typescript
1432
+ public readonly unsupportedFileHandling: string;
1433
+ ```
1434
+
1435
+ - *Type:* string
1436
+ - *Default:* 'FAIL'
1437
+
1438
+ Handling logic for Unsupported files.
1439
+
1440
+ Valid values are PASS and FAIL.
1441
+
1442
+ ---
1443
+
1444
+ ### AdminRoleProps <a name="AdminRoleProps" id="cdk-comprehend-s3olap.AdminRoleProps"></a>
1445
+
1446
+ #### Initializer <a name="Initializer" id="cdk-comprehend-s3olap.AdminRoleProps.Initializer"></a>
1447
+
1448
+ ```typescript
1449
+ import { AdminRoleProps } from 'cdk-comprehend-s3olap'
1450
+
1451
+ const adminRoleProps: AdminRoleProps = { ... }
1452
+ ```
1453
+
1454
+ #### Properties <a name="Properties" id="Properties"></a>
1455
+
1456
+ | **Name** | **Type** | **Description** |
1457
+ | --- | --- | --- |
1458
+ | <code><a href="#cdk-comprehend-s3olap.AdminRoleProps.property.iamRoleName">iamRoleName</a></code> | <code>string</code> | The name of the IAM role. |
1459
+ | <code><a href="#cdk-comprehend-s3olap.AdminRoleProps.property.objectLambdaAccessPointName">objectLambdaAccessPointName</a></code> | <code>string</code> | The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration. |
1460
+ | <code><a href="#cdk-comprehend-s3olap.AdminRoleProps.property.policyName">policyName</a></code> | <code>string</code> | The name of the IAM policy for the IAM role. |
1461
+
1462
+ ---
1463
+
1464
+ ##### `iamRoleName`<sup>Optional</sup> <a name="iamRoleName" id="cdk-comprehend-s3olap.AdminRoleProps.property.iamRoleName"></a>
1465
+
1466
+ ```typescript
1467
+ public readonly iamRoleName: string;
1468
+ ```
1469
+
1470
+ - *Type:* string
1471
+ - *Default:* 'RedactionAdminRole'
1472
+
1473
+ The name of the IAM role.
1474
+
1475
+ ---
1476
+
1477
+ ##### `objectLambdaAccessPointName`<sup>Optional</sup> <a name="objectLambdaAccessPointName" id="cdk-comprehend-s3olap.AdminRoleProps.property.objectLambdaAccessPointName"></a>
1478
+
1479
+ ```typescript
1480
+ public readonly objectLambdaAccessPointName: string;
1481
+ ```
1482
+
1483
+ - *Type:* string
1484
+ - *Default:* 'admin-s3olap-call-transcripts-known-pii'
1485
+
1486
+ The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration.
1487
+
1488
+ ---
1489
+
1490
+ ##### `policyName`<sup>Optional</sup> <a name="policyName" id="cdk-comprehend-s3olap.AdminRoleProps.property.policyName"></a>
1491
+
1492
+ ```typescript
1493
+ public readonly policyName: string;
1494
+ ```
1495
+
1496
+ - *Type:* string
1497
+ - *Default:* 'admin-role-s3olap-policy'
1498
+
1499
+ The name of the IAM policy for the IAM role.
1500
+
1501
+ ---
1502
+
1503
+ ### BillingRoleProps <a name="BillingRoleProps" id="cdk-comprehend-s3olap.BillingRoleProps"></a>
1504
+
1505
+ #### Initializer <a name="Initializer" id="cdk-comprehend-s3olap.BillingRoleProps.Initializer"></a>
1506
+
1507
+ ```typescript
1508
+ import { BillingRoleProps } from 'cdk-comprehend-s3olap'
1509
+
1510
+ const billingRoleProps: BillingRoleProps = { ... }
1511
+ ```
1512
+
1513
+ #### Properties <a name="Properties" id="Properties"></a>
1514
+
1515
+ | **Name** | **Type** | **Description** |
1516
+ | --- | --- | --- |
1517
+ | <code><a href="#cdk-comprehend-s3olap.BillingRoleProps.property.iamRoleName">iamRoleName</a></code> | <code>string</code> | The name of the IAM role. |
1518
+ | <code><a href="#cdk-comprehend-s3olap.BillingRoleProps.property.objectLambdaAccessPointName">objectLambdaAccessPointName</a></code> | <code>string</code> | The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration. |
1519
+ | <code><a href="#cdk-comprehend-s3olap.BillingRoleProps.property.policyName">policyName</a></code> | <code>string</code> | The name of the IAM policy for the IAM role. |
1520
+
1521
+ ---
1522
+
1523
+ ##### `iamRoleName`<sup>Optional</sup> <a name="iamRoleName" id="cdk-comprehend-s3olap.BillingRoleProps.property.iamRoleName"></a>
1524
+
1525
+ ```typescript
1526
+ public readonly iamRoleName: string;
1527
+ ```
1528
+
1529
+ - *Type:* string
1530
+ - *Default:* 'RedactionBillingRole'
1531
+
1532
+ The name of the IAM role.
1533
+
1534
+ ---
1535
+
1536
+ ##### `objectLambdaAccessPointName`<sup>Optional</sup> <a name="objectLambdaAccessPointName" id="cdk-comprehend-s3olap.BillingRoleProps.property.objectLambdaAccessPointName"></a>
1537
+
1538
+ ```typescript
1539
+ public readonly objectLambdaAccessPointName: string;
1540
+ ```
1541
+
1542
+ - *Type:* string
1543
+ - *Default:* 'billing-s3olap-call-transcripts-known-pii'
1544
+
1545
+ The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration.
1546
+
1547
+ ---
1548
+
1549
+ ##### `policyName`<sup>Optional</sup> <a name="policyName" id="cdk-comprehend-s3olap.BillingRoleProps.property.policyName"></a>
1550
+
1551
+ ```typescript
1552
+ public readonly policyName: string;
1553
+ ```
1554
+
1555
+ - *Type:* string
1556
+ - *Default:* 'billing-role-s3olap-policy'
1557
+
1558
+ The name of the IAM policy for the IAM role.
1559
+
1560
+ ---
1561
+
1562
+ ### ComprehendS3olabProps <a name="ComprehendS3olabProps" id="cdk-comprehend-s3olap.ComprehendS3olabProps"></a>
1563
+
1564
+ #### Initializer <a name="Initializer" id="cdk-comprehend-s3olap.ComprehendS3olabProps.Initializer"></a>
1565
+
1566
+ ```typescript
1567
+ import { ComprehendS3olabProps } from 'cdk-comprehend-s3olap'
1568
+
1569
+ const comprehendS3olabProps: ComprehendS3olabProps = { ... }
1570
+ ```
1571
+
1572
+ #### Properties <a name="Properties" id="Properties"></a>
1573
+
1574
+ | **Name** | **Type** | **Description** |
1575
+ | --- | --- | --- |
1576
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps.property.accessControlLambdaConfig">accessControlLambdaConfig</a></code> | <code><a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps">AccessConrtolLambdaProps</a></code> | The parameters needed for the `ComprehendPiiAccessControlS3ObjectLambda` function. |
1577
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps.property.adminRedactionLambdaConfig">adminRedactionLambdaConfig</a></code> | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps">RedactionLambdaProps</a></code> | The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `AdminRole`. |
1578
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps.property.adminRoleConfig">adminRoleConfig</a></code> | <code><a href="#cdk-comprehend-s3olap.AdminRoleProps">AdminRoleProps</a></code> | The manageable properties for the administrator IAM role in the redaction case. |
1579
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps.property.billingRedactionLambdaConfig">billingRedactionLambdaConfig</a></code> | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps">RedactionLambdaProps</a></code> | The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `BillingRole`. |
1580
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps.property.billingRoleConfig">billingRoleConfig</a></code> | <code><a href="#cdk-comprehend-s3olap.BillingRoleProps">BillingRoleProps</a></code> | The manageable properties for the billing IAM role in the redaction case. |
1581
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps.property.cusrtSupportRedactionLambdaConfig">cusrtSupportRedactionLambdaConfig</a></code> | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps">RedactionLambdaProps</a></code> | The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `CustSupportRole`. |
1582
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps.property.custSupportRoleConfig">custSupportRoleConfig</a></code> | <code><a href="#cdk-comprehend-s3olap.CustSupportRoleProps">CustSupportRoleProps</a></code> | The manageable properties for the customer support IAM role in the redaction case. |
1583
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps.property.exampleFileDir">exampleFileDir</a></code> | <code>string</code> | The directory path where `files/access_control/*.txt` and `files/redaction/*.txt` will be put. |
1584
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps.property.generalRoleConfig">generalRoleConfig</a></code> | <code><a href="#cdk-comprehend-s3olap.GeneralRoleProps">GeneralRoleProps</a></code> | The manageable properties for the IAM role used to access the `survey-results.txt` data. |
1585
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps.property.generateRandomCharacters">generateRandomCharacters</a></code> | <code>boolean</code> | For distinguish test and normal deployment. |
1586
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps.property.s3AccessPointNames">s3AccessPointNames</a></code> | <code><a href="#cdk-comprehend-s3olap.S3AccessPointNames">S3AccessPointNames</a></code> | The names of the S3 access points for the access control case and redaction case. |
1587
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps.property.surveyBucketPrefix">surveyBucketPrefix</a></code> | <code>string</code> | The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the access control case. |
1588
+ | <code><a href="#cdk-comprehend-s3olap.ComprehendS3olabProps.property.transcriptsBucketPrefix">transcriptsBucketPrefix</a></code> | <code>string</code> | The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the redaction case. |
1589
+
1590
+ ---
1591
+
1592
+ ##### `accessControlLambdaConfig`<sup>Optional</sup> <a name="accessControlLambdaConfig" id="cdk-comprehend-s3olap.ComprehendS3olabProps.property.accessControlLambdaConfig"></a>
1593
+
1594
+ ```typescript
1595
+ public readonly accessControlLambdaConfig: AccessConrtolLambdaProps;
1596
+ ```
1597
+
1598
+ - *Type:* <a href="#cdk-comprehend-s3olap.AccessConrtolLambdaProps">AccessConrtolLambdaProps</a>
1599
+
1600
+ The parameters needed for the `ComprehendPiiAccessControlS3ObjectLambda` function.
1601
+
1602
+ ---
1603
+
1604
+ ##### `adminRedactionLambdaConfig`<sup>Optional</sup> <a name="adminRedactionLambdaConfig" id="cdk-comprehend-s3olap.ComprehendS3olabProps.property.adminRedactionLambdaConfig"></a>
1605
+
1606
+ ```typescript
1607
+ public readonly adminRedactionLambdaConfig: RedactionLambdaProps;
1608
+ ```
1609
+
1610
+ - *Type:* <a href="#cdk-comprehend-s3olap.RedactionLambdaProps">RedactionLambdaProps</a>
1611
+
1612
+ The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `AdminRole`.
1613
+
1614
+ ---
1615
+
1616
+ ##### `adminRoleConfig`<sup>Optional</sup> <a name="adminRoleConfig" id="cdk-comprehend-s3olap.ComprehendS3olabProps.property.adminRoleConfig"></a>
1617
+
1618
+ ```typescript
1619
+ public readonly adminRoleConfig: AdminRoleProps;
1620
+ ```
1621
+
1622
+ - *Type:* <a href="#cdk-comprehend-s3olap.AdminRoleProps">AdminRoleProps</a>
1623
+
1624
+ The manageable properties for the administrator IAM role in the redaction case.
1625
+
1626
+ ---
1627
+
1628
+ ##### `billingRedactionLambdaConfig`<sup>Optional</sup> <a name="billingRedactionLambdaConfig" id="cdk-comprehend-s3olap.ComprehendS3olabProps.property.billingRedactionLambdaConfig"></a>
1629
+
1630
+ ```typescript
1631
+ public readonly billingRedactionLambdaConfig: RedactionLambdaProps;
1632
+ ```
1633
+
1634
+ - *Type:* <a href="#cdk-comprehend-s3olap.RedactionLambdaProps">RedactionLambdaProps</a>
1635
+
1636
+ The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `BillingRole`.
1637
+
1638
+ ---
1639
+
1640
+ ##### `billingRoleConfig`<sup>Optional</sup> <a name="billingRoleConfig" id="cdk-comprehend-s3olap.ComprehendS3olabProps.property.billingRoleConfig"></a>
1641
+
1642
+ ```typescript
1643
+ public readonly billingRoleConfig: BillingRoleProps;
1644
+ ```
1645
+
1646
+ - *Type:* <a href="#cdk-comprehend-s3olap.BillingRoleProps">BillingRoleProps</a>
1647
+
1648
+ The manageable properties for the billing IAM role in the redaction case.
1649
+
1650
+ ---
1651
+
1652
+ ##### `cusrtSupportRedactionLambdaConfig`<sup>Optional</sup> <a name="cusrtSupportRedactionLambdaConfig" id="cdk-comprehend-s3olap.ComprehendS3olabProps.property.cusrtSupportRedactionLambdaConfig"></a>
1653
+
1654
+ ```typescript
1655
+ public readonly cusrtSupportRedactionLambdaConfig: RedactionLambdaProps;
1656
+ ```
1657
+
1658
+ - *Type:* <a href="#cdk-comprehend-s3olap.RedactionLambdaProps">RedactionLambdaProps</a>
1659
+
1660
+ The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `CustSupportRole`.
1661
+
1662
+ ---
1663
+
1664
+ ##### `custSupportRoleConfig`<sup>Optional</sup> <a name="custSupportRoleConfig" id="cdk-comprehend-s3olap.ComprehendS3olabProps.property.custSupportRoleConfig"></a>
1665
+
1666
+ ```typescript
1667
+ public readonly custSupportRoleConfig: CustSupportRoleProps;
1668
+ ```
1669
+
1670
+ - *Type:* <a href="#cdk-comprehend-s3olap.CustSupportRoleProps">CustSupportRoleProps</a>
1671
+
1672
+ The manageable properties for the customer support IAM role in the redaction case.
1673
+
1674
+ ---
1675
+
1676
+ ##### `exampleFileDir`<sup>Optional</sup> <a name="exampleFileDir" id="cdk-comprehend-s3olap.ComprehendS3olabProps.property.exampleFileDir"></a>
1677
+
1678
+ ```typescript
1679
+ public readonly exampleFileDir: string;
1680
+ ```
1681
+
1682
+ - *Type:* string
1683
+ - *Default:* __dirname
1684
+
1685
+ The directory path where `files/access_control/*.txt` and `files/redaction/*.txt` will be put.
1686
+
1687
+ DO NOT INCLUDE `/` in the end.
1688
+
1689
+ ---
1690
+
1691
+ ##### `generalRoleConfig`<sup>Optional</sup> <a name="generalRoleConfig" id="cdk-comprehend-s3olap.ComprehendS3olabProps.property.generalRoleConfig"></a>
1692
+
1693
+ ```typescript
1694
+ public readonly generalRoleConfig: GeneralRoleProps;
1695
+ ```
1696
+
1697
+ - *Type:* <a href="#cdk-comprehend-s3olap.GeneralRoleProps">GeneralRoleProps</a>
1698
+
1699
+ The manageable properties for the IAM role used to access the `survey-results.txt` data.
1700
+
1701
+ ---
1702
+
1703
+ ##### `generateRandomCharacters`<sup>Optional</sup> <a name="generateRandomCharacters" id="cdk-comprehend-s3olap.ComprehendS3olabProps.property.generateRandomCharacters"></a>
1704
+
1705
+ ```typescript
1706
+ public readonly generateRandomCharacters: boolean;
1707
+ ```
1708
+
1709
+ - *Type:* boolean
1710
+ - *Default:* true
1711
+
1712
+ For distinguish test and normal deployment.
1713
+
1714
+ ---
1715
+
1716
+ ##### `s3AccessPointNames`<sup>Optional</sup> <a name="s3AccessPointNames" id="cdk-comprehend-s3olap.ComprehendS3olabProps.property.s3AccessPointNames"></a>
1717
+
1718
+ ```typescript
1719
+ public readonly s3AccessPointNames: S3AccessPointNames;
1720
+ ```
1721
+
1722
+ - *Type:* <a href="#cdk-comprehend-s3olap.S3AccessPointNames">S3AccessPointNames</a>
1723
+
1724
+ The names of the S3 access points for the access control case and redaction case.
1725
+
1726
+ ---
1727
+
1728
+ ##### `surveyBucketPrefix`<sup>Optional</sup> <a name="surveyBucketPrefix" id="cdk-comprehend-s3olap.ComprehendS3olabProps.property.surveyBucketPrefix"></a>
1729
+
1730
+ ```typescript
1731
+ public readonly surveyBucketPrefix: string;
1732
+ ```
1733
+
1734
+ - *Type:* string
1735
+ - *Default:* 6 random words
1736
+
1737
+ The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the access control case.
1738
+
1739
+ ---
1740
+
1741
+ ##### `transcriptsBucketPrefix`<sup>Optional</sup> <a name="transcriptsBucketPrefix" id="cdk-comprehend-s3olap.ComprehendS3olabProps.property.transcriptsBucketPrefix"></a>
1742
+
1743
+ ```typescript
1744
+ public readonly transcriptsBucketPrefix: string;
1745
+ ```
1746
+
1747
+ - *Type:* string
1748
+ - *Default:* 6 random words
1749
+
1750
+ The prefix attached to the name of the S3 bucket where you are going to explore the S3 Object Lambda pertaining to the redaction case.
1751
+
1752
+ ---
1753
+
1754
+ ### CustSupportRoleProps <a name="CustSupportRoleProps" id="cdk-comprehend-s3olap.CustSupportRoleProps"></a>
1755
+
1756
+ #### Initializer <a name="Initializer" id="cdk-comprehend-s3olap.CustSupportRoleProps.Initializer"></a>
1757
+
1758
+ ```typescript
1759
+ import { CustSupportRoleProps } from 'cdk-comprehend-s3olap'
1760
+
1761
+ const custSupportRoleProps: CustSupportRoleProps = { ... }
1762
+ ```
1763
+
1764
+ #### Properties <a name="Properties" id="Properties"></a>
1765
+
1766
+ | **Name** | **Type** | **Description** |
1767
+ | --- | --- | --- |
1768
+ | <code><a href="#cdk-comprehend-s3olap.CustSupportRoleProps.property.iamRoleName">iamRoleName</a></code> | <code>string</code> | The name of the IAM role. |
1769
+ | <code><a href="#cdk-comprehend-s3olap.CustSupportRoleProps.property.objectLambdaAccessPointName">objectLambdaAccessPointName</a></code> | <code>string</code> | The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration. |
1770
+ | <code><a href="#cdk-comprehend-s3olap.CustSupportRoleProps.property.policyName">policyName</a></code> | <code>string</code> | The name of the IAM policy for the IAM role. |
1771
+
1772
+ ---
1773
+
1774
+ ##### `iamRoleName`<sup>Optional</sup> <a name="iamRoleName" id="cdk-comprehend-s3olap.CustSupportRoleProps.property.iamRoleName"></a>
1775
+
1776
+ ```typescript
1777
+ public readonly iamRoleName: string;
1778
+ ```
1779
+
1780
+ - *Type:* string
1781
+ - *Default:* 'RedactionCustSupportRole'
1782
+
1783
+ The name of the IAM role.
1784
+
1785
+ ---
1786
+
1787
+ ##### `objectLambdaAccessPointName`<sup>Optional</sup> <a name="objectLambdaAccessPointName" id="cdk-comprehend-s3olap.CustSupportRoleProps.property.objectLambdaAccessPointName"></a>
1788
+
1789
+ ```typescript
1790
+ public readonly objectLambdaAccessPointName: string;
1791
+ ```
1792
+
1793
+ - *Type:* string
1794
+ - *Default:* 'custsupport-s3olap-call-transcripts-known-pii'
1795
+
1796
+ The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration.
1797
+
1798
+ ---
1799
+
1800
+ ##### `policyName`<sup>Optional</sup> <a name="policyName" id="cdk-comprehend-s3olap.CustSupportRoleProps.property.policyName"></a>
1801
+
1802
+ ```typescript
1803
+ public readonly policyName: string;
1804
+ ```
1805
+
1806
+ - *Type:* string
1807
+ - *Default:* 'customersupport-role-s3olap-policy'
1808
+
1809
+ The name of the IAM policy for the IAM role.
1810
+
1811
+ ---
1812
+
1813
+ ### GeneralRoleProps <a name="GeneralRoleProps" id="cdk-comprehend-s3olap.GeneralRoleProps"></a>
1814
+
1815
+ #### Initializer <a name="Initializer" id="cdk-comprehend-s3olap.GeneralRoleProps.Initializer"></a>
1816
+
1817
+ ```typescript
1818
+ import { GeneralRoleProps } from 'cdk-comprehend-s3olap'
1819
+
1820
+ const generalRoleProps: GeneralRoleProps = { ... }
1821
+ ```
1822
+
1823
+ #### Properties <a name="Properties" id="Properties"></a>
1824
+
1825
+ | **Name** | **Type** | **Description** |
1826
+ | --- | --- | --- |
1827
+ | <code><a href="#cdk-comprehend-s3olap.GeneralRoleProps.property.iamRoleName">iamRoleName</a></code> | <code>string</code> | The name of the IAM role. |
1828
+ | <code><a href="#cdk-comprehend-s3olap.GeneralRoleProps.property.objectLambdaAccessPointName">objectLambdaAccessPointName</a></code> | <code>string</code> | The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration. |
1829
+ | <code><a href="#cdk-comprehend-s3olap.GeneralRoleProps.property.policyName">policyName</a></code> | <code>string</code> | The name of the IAM policy for the IAM role. |
1830
+
1831
+ ---
1832
+
1833
+ ##### `iamRoleName`<sup>Optional</sup> <a name="iamRoleName" id="cdk-comprehend-s3olap.GeneralRoleProps.property.iamRoleName"></a>
1834
+
1835
+ ```typescript
1836
+ public readonly iamRoleName: string;
1837
+ ```
1838
+
1839
+ - *Type:* string
1840
+ - *Default:* 'GeneralRole'
1841
+
1842
+ The name of the IAM role.
1843
+
1844
+ ---
1845
+
1846
+ ##### `objectLambdaAccessPointName`<sup>Optional</sup> <a name="objectLambdaAccessPointName" id="cdk-comprehend-s3olap.GeneralRoleProps.property.objectLambdaAccessPointName"></a>
1847
+
1848
+ ```typescript
1849
+ public readonly objectLambdaAccessPointName: string;
1850
+ ```
1851
+
1852
+ - *Type:* string
1853
+ - *Default:* 'accessctl-s3olap-survey-results-unknown-pii'
1854
+
1855
+ The name of the object Lambda access point, which will be the same as the S3 acceess point for the S3 bucket in the demostration.
1856
+
1857
+ ---
1858
+
1859
+ ##### `policyName`<sup>Optional</sup> <a name="policyName" id="cdk-comprehend-s3olap.GeneralRoleProps.property.policyName"></a>
1860
+
1861
+ ```typescript
1862
+ public readonly policyName: string;
1863
+ ```
1864
+
1865
+ - *Type:* string
1866
+ - *Default:* 'general-role-s3olap-policy'
1867
+
1868
+ The name of the IAM policy for the IAM role.
1869
+
1870
+ ---
1871
+
1872
+ ### LambdaArnCaptorResourceProps <a name="LambdaArnCaptorResourceProps" id="cdk-comprehend-s3olap.LambdaArnCaptorResourceProps"></a>
1873
+
1874
+ #### Initializer <a name="Initializer" id="cdk-comprehend-s3olap.LambdaArnCaptorResourceProps.Initializer"></a>
1875
+
1876
+ ```typescript
1877
+ import { LambdaArnCaptorResourceProps } from 'cdk-comprehend-s3olap'
1878
+
1879
+ const lambdaArnCaptorResourceProps: LambdaArnCaptorResourceProps = { ... }
1880
+ ```
1881
+
1882
+ #### Properties <a name="Properties" id="Properties"></a>
1883
+
1884
+ | **Name** | **Type** | **Description** |
1885
+ | --- | --- | --- |
1886
+ | <code><a href="#cdk-comprehend-s3olap.LambdaArnCaptorResourceProps.property.partialLambdaName">partialLambdaName</a></code> | <code>string</code> | The partial fixed name of the gemeral Lambda function created from the serverless application. |
1887
+ | <code><a href="#cdk-comprehend-s3olap.LambdaArnCaptorResourceProps.property.roleName">roleName</a></code> | <code>string</code> | the name of the corresponding IAM role. |
1888
+
1889
+ ---
1890
+
1891
+ ##### `partialLambdaName`<sup>Required</sup> <a name="partialLambdaName" id="cdk-comprehend-s3olap.LambdaArnCaptorResourceProps.property.partialLambdaName"></a>
1892
+
1893
+ ```typescript
1894
+ public readonly partialLambdaName: string;
1895
+ ```
1896
+
1897
+ - *Type:* string
1898
+
1899
+ The partial fixed name of the gemeral Lambda function created from the serverless application.
1900
+
1901
+ ---
1902
+
1903
+ ##### `roleName`<sup>Required</sup> <a name="roleName" id="cdk-comprehend-s3olap.LambdaArnCaptorResourceProps.property.roleName"></a>
1904
+
1905
+ ```typescript
1906
+ public readonly roleName: string;
1907
+ ```
1908
+
1909
+ - *Type:* string
1910
+
1911
+ the name of the corresponding IAM role.
1912
+
1913
+ ---
1914
+
1915
+ ### RedactionLambdaProps <a name="RedactionLambdaProps" id="cdk-comprehend-s3olap.RedactionLambdaProps"></a>
1916
+
1917
+ #### Initializer <a name="Initializer" id="cdk-comprehend-s3olap.RedactionLambdaProps.Initializer"></a>
1918
+
1919
+ ```typescript
1920
+ import { RedactionLambdaProps } from 'cdk-comprehend-s3olap'
1921
+
1922
+ const redactionLambdaProps: RedactionLambdaProps = { ... }
1923
+ ```
1924
+
1925
+ #### Properties <a name="Properties" id="Properties"></a>
1926
+
1927
+ | **Name** | **Type** | **Description** |
1928
+ | --- | --- | --- |
1929
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.confidenceThreshold">confidenceThreshold</a></code> | <code>string</code> | The minimum prediction confidence score above which PII classification and detection would be considered as final answer. |
1930
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.containsPiiEntitiesThreadCount">containsPiiEntitiesThreadCount</a></code> | <code>string</code> | Number of threads to use for calling Comprehend's ContainsPiiEntities API. |
1931
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.defaultLanguageCode">defaultLanguageCode</a></code> | <code>string</code> | Default language of the text to be processed. |
1932
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.detectPiiEntitiesThreadCount">detectPiiEntitiesThreadCount</a></code> | <code>string</code> | Number of threads to use for calling Comprehend's DetectPiiEntities API. |
1933
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.documentMaxSize">documentMaxSize</a></code> | <code>string</code> | Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size. |
1934
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.documentMaxSizeContainsPiiEntities">documentMaxSizeContainsPiiEntities</a></code> | <code>string</code> | Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API. |
1935
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.documentMaxSizeDetectPiiEntities">documentMaxSizeDetectPiiEntities</a></code> | <code>string</code> | Maximum document size (in bytes) to be used for making calls to Comprehend's DetectPiiEntities API. |
1936
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.isPartialObjectSupported">isPartialObjectSupported</a></code> | <code>string</code> | Whether to support partial objects or not. |
1937
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.logLevel">logLevel</a></code> | <code>string</code> | Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc. |
1938
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.maskCharacter">maskCharacter</a></code> | <code>string</code> | A character that replaces each character in the redacted PII entity. |
1939
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.maskMode">maskMode</a></code> | <code>string</code> | Specifies whether the PII entity is redacted with the mask character or the entity type. |
1940
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.maxCharsOverlap">maxCharsOverlap</a></code> | <code>string</code> | Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit. |
1941
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.piiEntityTypes">piiEntityTypes</a></code> | <code>string</code> | List of comma separated PII entity types to be considered for redaction. |
1942
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.publishCloudWatchMetrics">publishCloudWatchMetrics</a></code> | <code>string</code> | True if publish metrics to Cloudwatch, false otherwise. |
1943
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.semanticVersion">semanticVersion</a></code> | <code>string</code> | The version of the serverless application. |
1944
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.subsegmentOverlappingTokens">subsegmentOverlappingTokens</a></code> | <code>string</code> | Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit. |
1945
+ | <code><a href="#cdk-comprehend-s3olap.RedactionLambdaProps.property.unsupportedFileHandling">unsupportedFileHandling</a></code> | <code>string</code> | Handling logic for Unsupported files. |
1946
+
1947
+ ---
1948
+
1949
+ ##### `confidenceThreshold`<sup>Optional</sup> <a name="confidenceThreshold" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.confidenceThreshold"></a>
1950
+
1951
+ ```typescript
1952
+ public readonly confidenceThreshold: string;
1953
+ ```
1954
+
1955
+ - *Type:* string
1956
+ - *Default:* '0.5'
1957
+
1958
+ The minimum prediction confidence score above which PII classification and detection would be considered as final answer.
1959
+
1960
+ Valid range (0.5 to 1.0).
1961
+
1962
+ ---
1963
+
1964
+ ##### `containsPiiEntitiesThreadCount`<sup>Optional</sup> <a name="containsPiiEntitiesThreadCount" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.containsPiiEntitiesThreadCount"></a>
1965
+
1966
+ ```typescript
1967
+ public readonly containsPiiEntitiesThreadCount: string;
1968
+ ```
1969
+
1970
+ - *Type:* string
1971
+ - *Default:* '20'
1972
+
1973
+ Number of threads to use for calling Comprehend's ContainsPiiEntities API.
1974
+
1975
+ This controls the number of simultaneous calls that will be made from this Lambda.
1976
+
1977
+ ---
1978
+
1979
+ ##### `defaultLanguageCode`<sup>Optional</sup> <a name="defaultLanguageCode" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.defaultLanguageCode"></a>
1980
+
1981
+ ```typescript
1982
+ public readonly defaultLanguageCode: string;
1983
+ ```
1984
+
1985
+ - *Type:* string
1986
+ - *Default:* 'en'
1987
+
1988
+ Default language of the text to be processed.
1989
+
1990
+ This code will be used for interacting with Comprehend.
1991
+
1992
+ ---
1993
+
1994
+ ##### `detectPiiEntitiesThreadCount`<sup>Optional</sup> <a name="detectPiiEntitiesThreadCount" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.detectPiiEntitiesThreadCount"></a>
1995
+
1996
+ ```typescript
1997
+ public readonly detectPiiEntitiesThreadCount: string;
1998
+ ```
1999
+
2000
+ - *Type:* string
2001
+ - *Default:* '8'
2002
+
2003
+ Number of threads to use for calling Comprehend's DetectPiiEntities API.
2004
+
2005
+ This controls the number of simultaneous calls that will be made from this Lambda.
2006
+
2007
+ ---
2008
+
2009
+ ##### `documentMaxSize`<sup>Optional</sup> <a name="documentMaxSize" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.documentMaxSize"></a>
2010
+
2011
+ ```typescript
2012
+ public readonly documentMaxSize: string;
2013
+ ```
2014
+
2015
+ - *Type:* string
2016
+ - *Default:* '102400'
2017
+
2018
+ Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size.
2019
+
2020
+ ---
2021
+
2022
+ ##### `documentMaxSizeContainsPiiEntities`<sup>Optional</sup> <a name="documentMaxSizeContainsPiiEntities" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.documentMaxSizeContainsPiiEntities"></a>
2023
+
2024
+ ```typescript
2025
+ public readonly documentMaxSizeContainsPiiEntities: string;
2026
+ ```
2027
+
2028
+ - *Type:* string
2029
+ - *Default:* '50000'
2030
+
2031
+ Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API.
2032
+
2033
+ ---
2034
+
2035
+ ##### `documentMaxSizeDetectPiiEntities`<sup>Optional</sup> <a name="documentMaxSizeDetectPiiEntities" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.documentMaxSizeDetectPiiEntities"></a>
2036
+
2037
+ ```typescript
2038
+ public readonly documentMaxSizeDetectPiiEntities: string;
2039
+ ```
2040
+
2041
+ - *Type:* string
2042
+ - *Default:* '5000'
2043
+
2044
+ Maximum document size (in bytes) to be used for making calls to Comprehend's DetectPiiEntities API.
2045
+
2046
+ ---
2047
+
2048
+ ##### `isPartialObjectSupported`<sup>Optional</sup> <a name="isPartialObjectSupported" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.isPartialObjectSupported"></a>
2049
+
2050
+ ```typescript
2051
+ public readonly isPartialObjectSupported: string;
2052
+ ```
2053
+
2054
+ - *Type:* string
2055
+ - *Default:* 'false'
2056
+
2057
+ Whether to support partial objects or not.
2058
+
2059
+ Accessing partial object through http headers such byte-range can corrupt the object and/or affect PII detection accuracy.
2060
+
2061
+ ---
2062
+
2063
+ ##### `logLevel`<sup>Optional</sup> <a name="logLevel" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.logLevel"></a>
2064
+
2065
+ ```typescript
2066
+ public readonly logLevel: string;
2067
+ ```
2068
+
2069
+ - *Type:* string
2070
+ - *Default:* 'INFO'
2071
+
2072
+ Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc.
2073
+
2074
+ ---
2075
+
2076
+ ##### `maskCharacter`<sup>Optional</sup> <a name="maskCharacter" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.maskCharacter"></a>
2077
+
2078
+ ```typescript
2079
+ public readonly maskCharacter: string;
2080
+ ```
2081
+
2082
+ - *Type:* string
2083
+ - *Default:* '*'
2084
+
2085
+ A character that replaces each character in the redacted PII entity.
2086
+
2087
+ ---
2088
+
2089
+ ##### `maskMode`<sup>Optional</sup> <a name="maskMode" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.maskMode"></a>
2090
+
2091
+ ```typescript
2092
+ public readonly maskMode: string;
2093
+ ```
2094
+
2095
+ - *Type:* string
2096
+
2097
+ Specifies whether the PII entity is redacted with the mask character or the entity type.
2098
+
2099
+ Valid values - REPLACE_WITH_PII_ENTITY_TYPE and MASK.
2100
+
2101
+ ---
2102
+
2103
+ ##### `maxCharsOverlap`<sup>Optional</sup> <a name="maxCharsOverlap" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.maxCharsOverlap"></a>
2104
+
2105
+ ```typescript
2106
+ public readonly maxCharsOverlap: string;
2107
+ ```
2108
+
2109
+ - *Type:* string
2110
+ - *Default:* '200'
2111
+
2112
+ Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit.
2113
+
2114
+ ---
2115
+
2116
+ ##### `piiEntityTypes`<sup>Optional</sup> <a name="piiEntityTypes" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.piiEntityTypes"></a>
2117
+
2118
+ ```typescript
2119
+ public readonly piiEntityTypes: string;
2120
+ ```
2121
+
2122
+ - *Type:* string
2123
+ - *Default:* 'ALL'
2124
+
2125
+ List of comma separated PII entity types to be considered for redaction.
2126
+
2127
+ Refer Comprehend's documentation page for list of supported PII entity types.
2128
+
2129
+ ---
2130
+
2131
+ ##### `publishCloudWatchMetrics`<sup>Optional</sup> <a name="publishCloudWatchMetrics" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.publishCloudWatchMetrics"></a>
2132
+
2133
+ ```typescript
2134
+ public readonly publishCloudWatchMetrics: string;
2135
+ ```
2136
+
2137
+ - *Type:* string
2138
+ - *Default:* 'true'
2139
+
2140
+ True if publish metrics to Cloudwatch, false otherwise.
2141
+
2142
+ See README.md for details on CloudWatch metrics.
2143
+
2144
+ ---
2145
+
2146
+ ##### `semanticVersion`<sup>Optional</sup> <a name="semanticVersion" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.semanticVersion"></a>
2147
+
2148
+ ```typescript
2149
+ public readonly semanticVersion: string;
2150
+ ```
2151
+
2152
+ - *Type:* string
2153
+ - *Default:* '1.0.2'
2154
+
2155
+ The version of the serverless application.
2156
+
2157
+ ---
2158
+
2159
+ ##### `subsegmentOverlappingTokens`<sup>Optional</sup> <a name="subsegmentOverlappingTokens" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.subsegmentOverlappingTokens"></a>
2160
+
2161
+ ```typescript
2162
+ public readonly subsegmentOverlappingTokens: string;
2163
+ ```
2164
+
2165
+ - *Type:* string
2166
+ - *Default:* '20'
2167
+
2168
+ Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit.
2169
+
2170
+ ---
2171
+
2172
+ ##### `unsupportedFileHandling`<sup>Optional</sup> <a name="unsupportedFileHandling" id="cdk-comprehend-s3olap.RedactionLambdaProps.property.unsupportedFileHandling"></a>
2173
+
2174
+ ```typescript
2175
+ public readonly unsupportedFileHandling: string;
2176
+ ```
2177
+
2178
+ - *Type:* string
2179
+ - *Default:* 'FAIL'
2180
+
2181
+ Handling logic for Unsupported files.
2182
+
2183
+ Valid values are PASS and FAIL.
2184
+
2185
+ ---
2186
+
2187
+ ### S3AccessPointNames <a name="S3AccessPointNames" id="cdk-comprehend-s3olap.S3AccessPointNames"></a>
2188
+
2189
+ #### Initializer <a name="Initializer" id="cdk-comprehend-s3olap.S3AccessPointNames.Initializer"></a>
2190
+
2191
+ ```typescript
2192
+ import { S3AccessPointNames } from 'cdk-comprehend-s3olap'
2193
+
2194
+ const s3AccessPointNames: S3AccessPointNames = { ... }
2195
+ ```
2196
+
2197
+ #### Properties <a name="Properties" id="Properties"></a>
2198
+
2199
+ | **Name** | **Type** | **Description** |
2200
+ | --- | --- | --- |
2201
+ | <code><a href="#cdk-comprehend-s3olap.S3AccessPointNames.property.admin">admin</a></code> | <code>string</code> | The name of the S3 aceess point for the admin role in the redaction case. |
2202
+ | <code><a href="#cdk-comprehend-s3olap.S3AccessPointNames.property.billing">billing</a></code> | <code>string</code> | The name of the S3 aceess point for the billing role in the redaction case. |
2203
+ | <code><a href="#cdk-comprehend-s3olap.S3AccessPointNames.property.customerSupport">customerSupport</a></code> | <code>string</code> | The name of the S3 aceess point for the customer support role in the redaction case. |
2204
+ | <code><a href="#cdk-comprehend-s3olap.S3AccessPointNames.property.general">general</a></code> | <code>string</code> | The name of the S3 aceess point for the general role in the access control case. |
2205
+
2206
+ ---
2207
+
2208
+ ##### `admin`<sup>Required</sup> <a name="admin" id="cdk-comprehend-s3olap.S3AccessPointNames.property.admin"></a>
2209
+
2210
+ ```typescript
2211
+ public readonly admin: string;
2212
+ ```
2213
+
2214
+ - *Type:* string
2215
+ - *Default:* 'admin-s3-access-point-call-transcripts-known-pii'
2216
+
2217
+ The name of the S3 aceess point for the admin role in the redaction case.
2218
+
2219
+ ---
2220
+
2221
+ ##### `billing`<sup>Required</sup> <a name="billing" id="cdk-comprehend-s3olap.S3AccessPointNames.property.billing"></a>
2222
+
2223
+ ```typescript
2224
+ public readonly billing: string;
2225
+ ```
2226
+
2227
+ - *Type:* string
2228
+ - *Default:* 'bill-s3-access-point-call-transcripts-known-pii'
2229
+
2230
+ The name of the S3 aceess point for the billing role in the redaction case.
2231
+
2232
+ ---
2233
+
2234
+ ##### `customerSupport`<sup>Required</sup> <a name="customerSupport" id="cdk-comprehend-s3olap.S3AccessPointNames.property.customerSupport"></a>
2235
+
2236
+ ```typescript
2237
+ public readonly customerSupport: string;
2238
+ ```
2239
+
2240
+ - *Type:* string
2241
+ - *Default:* 'cs-s3-access-point-call-transcripts-known-pii'
2242
+
2243
+ The name of the S3 aceess point for the customer support role in the redaction case.
2244
+
2245
+ ---
2246
+
2247
+ ##### `general`<sup>Required</sup> <a name="general" id="cdk-comprehend-s3olap.S3AccessPointNames.property.general"></a>
2248
+
2249
+ ```typescript
2250
+ public readonly general: string;
2251
+ ```
504
2252
 
2253
+ - *Type:* string
2254
+ - *Default:* 'accessctl-s3-ap-survey-results-unknown-pii'
505
2255
 
2256
+ The name of the S3 aceess point for the general role in the access control case.
506
2257
 
2258
+ ---
507
2259
 
508
2260
 
509
- Name | Type | Description
510
- -----|------|-------------
511
- **confidenceThreshold**? | <code>string</code> | The minimum prediction confidence score above which PII classification and detection would be considered as final answer.<br/>__*Default*__: '0.5'
512
- **containsPiiEntitiesThreadCount**? | <code>string</code> | Number of threads to use for calling Comprehend's ContainsPiiEntities API.<br/>__*Default*__: '20'
513
- **defaultLanguageCode**? | <code>string</code> | Default language of the text to be processed.<br/>__*Default*__: 'en'
514
- **detectPiiEntitiesThreadCount**? | <code>string</code> | Number of threads to use for calling Comprehend's DetectPiiEntities API.<br/>__*Default*__: '8'
515
- **documentMaxSize**? | <code>string</code> | Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size.<br/>__*Default*__: '102400'
516
- **documentMaxSizeContainsPiiEntities**? | <code>string</code> | Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API.<br/>__*Default*__: '50000'
517
- **documentMaxSizeDetectPiiEntities**? | <code>string</code> | Maximum document size (in bytes) to be used for making calls to Comprehend's DetectPiiEntities API.<br/>__*Default*__: '5000'
518
- **isPartialObjectSupported**? | <code>string</code> | Whether to support partial objects or not.<br/>__*Default*__: 'false'
519
- **logLevel**? | <code>string</code> | Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc.<br/>__*Default*__: 'INFO'
520
- **maskCharacter**? | <code>string</code> | A character that replaces each character in the redacted PII entity.<br/>__*Default*__: '*'
521
- **maskMode**? | <code>string</code> | Specifies whether the PII entity is redacted with the mask character or the entity type.<br/>__*Optional*__
522
- **maxCharsOverlap**? | <code>string</code> | Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit.<br/>__*Default*__: '200'
523
- **piiEntityTypes**? | <code>string</code> | List of comma separated PII entity types to be considered for redaction.<br/>__*Default*__: 'ALL'
524
- **publishCloudWatchMetrics**? | <code>string</code> | True if publish metrics to Cloudwatch, false otherwise.<br/>__*Default*__: 'true'
525
- **semanticVersion**? | <code>string</code> | The version of the serverless application.<br/>__*Default*__: '1.0.2'
526
- **subsegmentOverlappingTokens**? | <code>string</code> | Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit.<br/>__*Default*__: '20'
527
- **unsupportedFileHandling**? | <code>string</code> | Handling logic for Unsupported files.<br/>__*Default*__: 'FAIL'
528
2261
 
2262
+ ## Enums <a name="Enums" id="Enums"></a>
529
2263
 
2264
+ ### IamRoleName <a name="IamRoleName" id="cdk-comprehend-s3olap.IamRoleName"></a>
530
2265
 
531
- ## struct S3AccessPointNames <a id="cdk-comprehend-s3olap-s3accesspointnames"></a>
2266
+ #### Members <a name="Members" id="Members"></a>
532
2267
 
2268
+ | **Name** | **Description** |
2269
+ | --- | --- |
2270
+ | <code><a href="#cdk-comprehend-s3olap.IamRoleName.GENERAL">GENERAL</a></code> | *No description.* |
2271
+ | <code><a href="#cdk-comprehend-s3olap.IamRoleName.ADMIN">ADMIN</a></code> | *No description.* |
2272
+ | <code><a href="#cdk-comprehend-s3olap.IamRoleName.BILLING">BILLING</a></code> | *No description.* |
2273
+ | <code><a href="#cdk-comprehend-s3olap.IamRoleName.CUST_SUPPORT">CUST_SUPPORT</a></code> | *No description.* |
533
2274
 
2275
+ ---
534
2276
 
2277
+ ##### `GENERAL` <a name="GENERAL" id="cdk-comprehend-s3olap.IamRoleName.GENERAL"></a>
535
2278
 
2279
+ ---
536
2280
 
537
2281
 
538
- Name | Type | Description
539
- -----|------|-------------
540
- **admin** | <code>string</code> | The name of the S3 aceess point for the admin role in the redaction case.
541
- **billing** | <code>string</code> | The name of the S3 aceess point for the billing role in the redaction case.
542
- **customerSupport** | <code>string</code> | The name of the S3 aceess point for the customer support role in the redaction case.
543
- **general** | <code>string</code> | The name of the S3 aceess point for the general role in the access control case.
2282
+ ##### `ADMIN` <a name="ADMIN" id="cdk-comprehend-s3olap.IamRoleName.ADMIN"></a>
544
2283
 
2284
+ ---
545
2285
 
546
2286
 
547
- ## enum IamRoleName <a id="cdk-comprehend-s3olap-iamrolename"></a>
2287
+ ##### `BILLING` <a name="BILLING" id="cdk-comprehend-s3olap.IamRoleName.BILLING"></a>
548
2288
 
2289
+ ---
549
2290
 
550
2291
 
551
- Name | Description
552
- -----|-----
553
- **GENERAL** |
554
- **ADMIN** |
555
- **BILLING** |
556
- **CUST_SUPPORT** |
2292
+ ##### `CUST_SUPPORT` <a name="CUST_SUPPORT" id="cdk-comprehend-s3olap.IamRoleName.CUST_SUPPORT"></a>
557
2293
 
2294
+ ---
558
2295