# API Reference
## Constructs
### AccessConrtolLambda
#### Initializers
```typescript
import { AccessConrtolLambda } from 'cdk-comprehend-s3olap'
new AccessConrtolLambda(scope: Construct, id: string, props: AccessConrtolLambdaProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | AccessConrtolLambdaProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* AccessConrtolLambdaProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { AccessConrtolLambda } from 'cdk-comprehend-s3olap'
AccessConrtolLambda.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| stackName | string | The name of the underlying resoure in the serverless application. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `stackName`Required
```typescript
public readonly stackName: string;
```
- *Type:* string
The name of the underlying resoure in the serverless application.
---
### AdminRole
#### Initializers
```typescript
import { AdminRole } from 'cdk-comprehend-s3olap'
new AdminRole(scope: Construct, id: string, props?: AdminRoleProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | AdminRoleProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Optional
- *Type:* AdminRoleProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { AdminRole } from 'cdk-comprehend-s3olap'
AdminRole.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| roleArn | string | The ARN of the IAM role. |
| roleId | string | The unique string identifying the role. |
| roleName | string | The name of the IAM role. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `roleArn`Required
```typescript
public readonly roleArn: string;
```
- *Type:* string
The ARN of the IAM role.
---
##### `roleId`Required
```typescript
public readonly roleId: string;
```
- *Type:* string
The unique string identifying the role.
---
##### `roleName`Required
```typescript
public readonly roleName: string;
```
- *Type:* string
The name of the IAM role.
---
### BillingRole
#### Initializers
```typescript
import { BillingRole } from 'cdk-comprehend-s3olap'
new BillingRole(scope: Construct, id: string, props?: AdminRoleProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | AdminRoleProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Optional
- *Type:* AdminRoleProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { BillingRole } from 'cdk-comprehend-s3olap'
BillingRole.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| roleArn | string | The ARN of the IAM role. |
| roleId | string | The unique string identifying the role. |
| roleName | string | The name of the IAM role. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `roleArn`Required
```typescript
public readonly roleArn: string;
```
- *Type:* string
The ARN of the IAM role.
---
##### `roleId`Required
```typescript
public readonly roleId: string;
```
- *Type:* string
The unique string identifying the role.
---
##### `roleName`Required
```typescript
public readonly roleName: string;
```
- *Type:* string
The name of the IAM role.
---
### ComprehendS3olab
Creates the foundation necessary to deploy the S3 Object Lambda Acceess Control Use Case.
#### Initializers
```typescript
import { ComprehendS3olab } from 'cdk-comprehend-s3olap'
new ComprehendS3olab(scope: Construct, id: string, props: ComprehendS3olabProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | ComprehendS3olabProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* ComprehendS3olabProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| generateS3Prefix | *No description.* |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `generateS3Prefix`
```typescript
public generateS3Prefix(length: number): string
```
###### `length`Required
- *Type:* number
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { ComprehendS3olab } from 'cdk-comprehend-s3olap'
ComprehendS3olab.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| adminLambdaArn | string | The ARN of the Lambda function combined with Amazon Comprehend for thie administrator role in the redaction case. |
| billingLambdaArn | string | The ARN of the Lambda function combined with Amazon Comprehend for thie billing role in the redaction case. |
| customerSupportLambdaArn | string | The ARN of the Lambda function combined with Amazon Comprehend for thie customer support role in the redaction case. |
| piiAccessConrtolLambdaArn | string | The ARN of the Lambda function combined with Amazon Comprehend for the general case. |
| s3objectLambdaAccessControlArn | string | The ARN of the S3 Object Lambda for access control. |
| s3objectLambdaAdminArn | string | The ARN of the S3 Object Lambda for the admin role in the redaction case. |
| s3objectLambdaBillingArn | string | The ARN of the S3 Object Lambda for the billing role in the redaction case. |
| s3objectLambdaCustomerSupportArn | string | The ARN of the S3 Object Lambda for the customer support role in the redaction case. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `adminLambdaArn`Required
```typescript
public readonly adminLambdaArn: string;
```
- *Type:* string
The ARN of the Lambda function combined with Amazon Comprehend for thie administrator role in the redaction case.
---
##### `billingLambdaArn`Required
```typescript
public readonly billingLambdaArn: string;
```
- *Type:* string
The ARN of the Lambda function combined with Amazon Comprehend for thie billing role in the redaction case.
---
##### `customerSupportLambdaArn`Required
```typescript
public readonly customerSupportLambdaArn: string;
```
- *Type:* string
The ARN of the Lambda function combined with Amazon Comprehend for thie customer support role in the redaction case.
---
##### `piiAccessConrtolLambdaArn`Required
```typescript
public readonly piiAccessConrtolLambdaArn: string;
```
- *Type:* string
The ARN of the Lambda function combined with Amazon Comprehend for the general case.
---
##### `s3objectLambdaAccessControlArn`Required
```typescript
public readonly s3objectLambdaAccessControlArn: string;
```
- *Type:* string
The ARN of the S3 Object Lambda for access control.
---
##### `s3objectLambdaAdminArn`Required
```typescript
public readonly s3objectLambdaAdminArn: string;
```
- *Type:* string
The ARN of the S3 Object Lambda for the admin role in the redaction case.
---
##### `s3objectLambdaBillingArn`Required
```typescript
public readonly s3objectLambdaBillingArn: string;
```
- *Type:* string
The ARN of the S3 Object Lambda for the billing role in the redaction case.
---
##### `s3objectLambdaCustomerSupportArn`Required
```typescript
public readonly s3objectLambdaCustomerSupportArn: string;
```
- *Type:* string
The ARN of the S3 Object Lambda for the customer support role in the redaction case.
---
### CustSupportRole
#### Initializers
```typescript
import { CustSupportRole } from 'cdk-comprehend-s3olap'
new CustSupportRole(scope: Construct, id: string, props?: AdminRoleProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | AdminRoleProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Optional
- *Type:* AdminRoleProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { CustSupportRole } from 'cdk-comprehend-s3olap'
CustSupportRole.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| roleArn | string | The ARN of the IAM role. |
| roleId | string | The unique string identifying the role. |
| roleName | string | The name of the IAM role. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `roleArn`Required
```typescript
public readonly roleArn: string;
```
- *Type:* string
The ARN of the IAM role.
---
##### `roleId`Required
```typescript
public readonly roleId: string;
```
- *Type:* string
The unique string identifying the role.
---
##### `roleName`Required
```typescript
public readonly roleName: string;
```
- *Type:* string
The name of the IAM role.
---
### GeneralRole
The role that you are going to assume (switch role).
Explores how the S3 Object Lambda works.
#### Initializers
```typescript
import { GeneralRole } from 'cdk-comprehend-s3olap'
new GeneralRole(scope: Construct, id: string, props: GeneralRoleProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | GeneralRoleProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* GeneralRoleProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { GeneralRole } from 'cdk-comprehend-s3olap'
GeneralRole.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| roleArn | string | The ARN of the IAM role. |
| roleId | string | The unique string identifying the role. |
| roleName | string | The name of the IAM role. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `roleArn`Required
```typescript
public readonly roleArn: string;
```
- *Type:* string
The ARN of the IAM role.
---
##### `roleId`Required
```typescript
public readonly roleId: string;
```
- *Type:* string
The unique string identifying the role.
---
##### `roleName`Required
```typescript
public readonly roleName: string;
```
- *Type:* string
The name of the IAM role.
---
### LambdaArnCaptorCustomResource
#### Initializers
```typescript
import { LambdaArnCaptorCustomResource } from 'cdk-comprehend-s3olap'
new LambdaArnCaptorCustomResource(scope: Construct, id: string, props: LambdaArnCaptorResourceProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | LambdaArnCaptorResourceProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Required
- *Type:* LambdaArnCaptorResourceProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { LambdaArnCaptorCustomResource } from 'cdk-comprehend-s3olap'
LambdaArnCaptorCustomResource.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| lambdaArn | string | The ARN of the general Lambda function created from the serverless application. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `lambdaArn`Required
```typescript
public readonly lambdaArn: string;
```
- *Type:* string
The ARN of the general Lambda function created from the serverless application.
> [https://github.com/aws/aws-cdk/issues/8760](https://github.com/aws/aws-cdk/issues/8760)
---
### RedactionLambda
#### Initializers
```typescript
import { RedactionLambda } from 'cdk-comprehend-s3olap'
new RedactionLambda(scope: Construct, id: string, props?: RedactionLambdaProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | RedactionLambdaProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Optional
- *Type:* RedactionLambdaProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { RedactionLambda } from 'cdk-comprehend-s3olap'
RedactionLambda.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| stackName | string | The name of the underlying resoure in the serverless application. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `stackName`Required
```typescript
public readonly stackName: string;
```
- *Type:* string
The name of the underlying resoure in the serverless application.
---
## Structs
### AccessConrtolLambdaProps
#### Initializer
```typescript
import { AccessConrtolLambdaProps } from 'cdk-comprehend-s3olap'
const accessConrtolLambdaProps: AccessConrtolLambdaProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| confidenceThreshold | string | The minimum prediction confidence score above which PII classification and detection would be considered as final answer. |
| containsPiiEntitiesThreadCount | string | Number of threads to use for calling Comprehend's ContainsPiiEntities API. |
| defaultLanguageCode | string | Default language of the text to be processed. |
| documentMaxSize | string | Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size. |
| documentMaxSizeContainsPiiEntities | string | Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API. |
| isPartialObjectSupported | string | Whether to support partial objects or not. |
| logLevel | string | Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc. |
| maxCharsOverlap | string | Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit. |
| piiEntityTypes | string | List of comma separated PII entity types to be considered for access control. |
| publishCloudWatchMetrics | string | True if publish metrics to Cloudwatch, false otherwise. |
| semanticVersion | string | The version of the serverless application. |
| subsegmentOverlappingTokens | string | Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit. |
| unsupportedFileHandling | string | Handling logic for Unsupported files. |
---
##### `confidenceThreshold`Optional
```typescript
public readonly confidenceThreshold: string;
```
- *Type:* string
- *Default:* '0.5'
The minimum prediction confidence score above which PII classification and detection would be considered as final answer.
Valid range (0.5 to 1.0).
---
##### `containsPiiEntitiesThreadCount`Optional
```typescript
public readonly containsPiiEntitiesThreadCount: string;
```
- *Type:* string
- *Default:* '20'
Number of threads to use for calling Comprehend's ContainsPiiEntities API.
This controls the number of simultaneous calls that will be made from this Lambda.
---
##### `defaultLanguageCode`Optional
```typescript
public readonly defaultLanguageCode: string;
```
- *Type:* string
- *Default:* 'en'
Default language of the text to be processed.
This code will be used for interacting with Comprehend.
---
##### `documentMaxSize`Optional
```typescript
public readonly documentMaxSize: string;
```
- *Type:* string
- *Default:* '102400'
Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size.
---
##### `documentMaxSizeContainsPiiEntities`Optional
```typescript
public readonly documentMaxSizeContainsPiiEntities: string;
```
- *Type:* string
- *Default:* '50000'
Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API.
---
##### `isPartialObjectSupported`Optional
```typescript
public readonly isPartialObjectSupported: string;
```
- *Type:* string
- *Default:* 'false'
Whether to support partial objects or not.
Accessing partial object through http headers such byte-range can corrupt the object and/or affect PII detection accuracy.
---
##### `logLevel`Optional
```typescript
public readonly logLevel: string;
```
- *Type:* string
- *Default:* 'INFO'
Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc.
---
##### `maxCharsOverlap`Optional
```typescript
public readonly maxCharsOverlap: string;
```
- *Type:* string
- *Default:* '200'
Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit.
---
##### `piiEntityTypes`Optional
```typescript
public readonly piiEntityTypes: string;
```
- *Type:* string
- *Default:* 'ALL'
List of comma separated PII entity types to be considered for access control.
Refer Comprehend's documentation page for list of supported PII entity types.
---
##### `publishCloudWatchMetrics`Optional
```typescript
public readonly publishCloudWatchMetrics: string;
```
- *Type:* string
- *Default:* 'true'
True if publish metrics to Cloudwatch, false otherwise.
See README.md for details on CloudWatch metrics.
---
##### `semanticVersion`Optional
```typescript
public readonly semanticVersion: string;
```
- *Type:* string
- *Default:* '1.0.2'
The version of the serverless application.
---
##### `subsegmentOverlappingTokens`Optional
```typescript
public readonly subsegmentOverlappingTokens: string;
```
- *Type:* string
- *Default:* '20'
Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit.
---
##### `unsupportedFileHandling`Optional
```typescript
public readonly unsupportedFileHandling: string;
```
- *Type:* string
- *Default:* 'FAIL'
Handling logic for Unsupported files.
Valid values are PASS and FAIL.
---
### AdminRoleProps
#### Initializer
```typescript
import { AdminRoleProps } from 'cdk-comprehend-s3olap'
const adminRoleProps: AdminRoleProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| iamRoleName | string | The name of the IAM role. |
| objectLambdaAccessPointName | string | 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. |
| policyName | string | The name of the IAM policy for the IAM role. |
---
##### `iamRoleName`Optional
```typescript
public readonly iamRoleName: string;
```
- *Type:* string
- *Default:* 'RedactionAdminRole'
The name of the IAM role.
---
##### `objectLambdaAccessPointName`Optional
```typescript
public readonly objectLambdaAccessPointName: string;
```
- *Type:* string
- *Default:* 'admin-s3olap-call-transcripts-known-pii'
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.
---
##### `policyName`Optional
```typescript
public readonly policyName: string;
```
- *Type:* string
- *Default:* 'admin-role-s3olap-policy'
The name of the IAM policy for the IAM role.
---
### BillingRoleProps
#### Initializer
```typescript
import { BillingRoleProps } from 'cdk-comprehend-s3olap'
const billingRoleProps: BillingRoleProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| iamRoleName | string | The name of the IAM role. |
| objectLambdaAccessPointName | string | 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. |
| policyName | string | The name of the IAM policy for the IAM role. |
---
##### `iamRoleName`Optional
```typescript
public readonly iamRoleName: string;
```
- *Type:* string
- *Default:* 'RedactionBillingRole'
The name of the IAM role.
---
##### `objectLambdaAccessPointName`Optional
```typescript
public readonly objectLambdaAccessPointName: string;
```
- *Type:* string
- *Default:* 'billing-s3olap-call-transcripts-known-pii'
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.
---
##### `policyName`Optional
```typescript
public readonly policyName: string;
```
- *Type:* string
- *Default:* 'billing-role-s3olap-policy'
The name of the IAM policy for the IAM role.
---
### ComprehendS3olabProps
#### Initializer
```typescript
import { ComprehendS3olabProps } from 'cdk-comprehend-s3olap'
const comprehendS3olabProps: ComprehendS3olabProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| accessControlLambdaConfig | AccessConrtolLambdaProps | The parameters needed for the `ComprehendPiiAccessControlS3ObjectLambda` function. |
| adminRedactionLambdaConfig | RedactionLambdaProps | The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `AdminRole`. |
| adminRoleConfig | AdminRoleProps | The manageable properties for the administrator IAM role in the redaction case. |
| billingRedactionLambdaConfig | RedactionLambdaProps | The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `BillingRole`. |
| billingRoleConfig | BillingRoleProps | The manageable properties for the billing IAM role in the redaction case. |
| cusrtSupportRedactionLambdaConfig | RedactionLambdaProps | The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `CustSupportRole`. |
| custSupportRoleConfig | CustSupportRoleProps | The manageable properties for the customer support IAM role in the redaction case. |
| exampleFileDir | string | The directory path where `files/access_control/*.txt` and `files/redaction/*.txt` will be put. |
| generalRoleConfig | GeneralRoleProps | The manageable properties for the IAM role used to access the `survey-results.txt` data. |
| generateRandomCharacters | boolean | For distinguish test and normal deployment. |
| s3AccessPointNames | S3AccessPointNames | The names of the S3 access points for the access control case and redaction case. |
| surveyBucketPrefix | string | 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. |
| transcriptsBucketPrefix | string | 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. |
---
##### `accessControlLambdaConfig`Optional
```typescript
public readonly accessControlLambdaConfig: AccessConrtolLambdaProps;
```
- *Type:* AccessConrtolLambdaProps
The parameters needed for the `ComprehendPiiAccessControlS3ObjectLambda` function.
---
##### `adminRedactionLambdaConfig`Optional
```typescript
public readonly adminRedactionLambdaConfig: RedactionLambdaProps;
```
- *Type:* RedactionLambdaProps
The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `AdminRole`.
---
##### `adminRoleConfig`Optional
```typescript
public readonly adminRoleConfig: AdminRoleProps;
```
- *Type:* AdminRoleProps
The manageable properties for the administrator IAM role in the redaction case.
---
##### `billingRedactionLambdaConfig`Optional
```typescript
public readonly billingRedactionLambdaConfig: RedactionLambdaProps;
```
- *Type:* RedactionLambdaProps
The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `BillingRole`.
---
##### `billingRoleConfig`Optional
```typescript
public readonly billingRoleConfig: BillingRoleProps;
```
- *Type:* BillingRoleProps
The manageable properties for the billing IAM role in the redaction case.
---
##### `cusrtSupportRedactionLambdaConfig`Optional
```typescript
public readonly cusrtSupportRedactionLambdaConfig: RedactionLambdaProps;
```
- *Type:* RedactionLambdaProps
The parameters of the `ComprehendPiiRedactionS3ObjectLambda` function for the `CustSupportRole`.
---
##### `custSupportRoleConfig`Optional
```typescript
public readonly custSupportRoleConfig: CustSupportRoleProps;
```
- *Type:* CustSupportRoleProps
The manageable properties for the customer support IAM role in the redaction case.
---
##### `exampleFileDir`Optional
```typescript
public readonly exampleFileDir: string;
```
- *Type:* string
- *Default:* __dirname
The directory path where `files/access_control/*.txt` and `files/redaction/*.txt` will be put.
DO NOT INCLUDE `/` in the end.
---
##### `generalRoleConfig`Optional
```typescript
public readonly generalRoleConfig: GeneralRoleProps;
```
- *Type:* GeneralRoleProps
The manageable properties for the IAM role used to access the `survey-results.txt` data.
---
##### `generateRandomCharacters`Optional
```typescript
public readonly generateRandomCharacters: boolean;
```
- *Type:* boolean
- *Default:* true
For distinguish test and normal deployment.
---
##### `s3AccessPointNames`Optional
```typescript
public readonly s3AccessPointNames: S3AccessPointNames;
```
- *Type:* S3AccessPointNames
The names of the S3 access points for the access control case and redaction case.
---
##### `surveyBucketPrefix`Optional
```typescript
public readonly surveyBucketPrefix: string;
```
- *Type:* string
- *Default:* 6 random words
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.
---
##### `transcriptsBucketPrefix`Optional
```typescript
public readonly transcriptsBucketPrefix: string;
```
- *Type:* string
- *Default:* 6 random words
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.
---
### CustSupportRoleProps
#### Initializer
```typescript
import { CustSupportRoleProps } from 'cdk-comprehend-s3olap'
const custSupportRoleProps: CustSupportRoleProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| iamRoleName | string | The name of the IAM role. |
| objectLambdaAccessPointName | string | 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. |
| policyName | string | The name of the IAM policy for the IAM role. |
---
##### `iamRoleName`Optional
```typescript
public readonly iamRoleName: string;
```
- *Type:* string
- *Default:* 'RedactionCustSupportRole'
The name of the IAM role.
---
##### `objectLambdaAccessPointName`Optional
```typescript
public readonly objectLambdaAccessPointName: string;
```
- *Type:* string
- *Default:* 'custsupport-s3olap-call-transcripts-known-pii'
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.
---
##### `policyName`Optional
```typescript
public readonly policyName: string;
```
- *Type:* string
- *Default:* 'customersupport-role-s3olap-policy'
The name of the IAM policy for the IAM role.
---
### GeneralRoleProps
#### Initializer
```typescript
import { GeneralRoleProps } from 'cdk-comprehend-s3olap'
const generalRoleProps: GeneralRoleProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| iamRoleName | string | The name of the IAM role. |
| objectLambdaAccessPointName | string | 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. |
| policyName | string | The name of the IAM policy for the IAM role. |
---
##### `iamRoleName`Optional
```typescript
public readonly iamRoleName: string;
```
- *Type:* string
- *Default:* 'GeneralRole'
The name of the IAM role.
---
##### `objectLambdaAccessPointName`Optional
```typescript
public readonly objectLambdaAccessPointName: string;
```
- *Type:* string
- *Default:* 'accessctl-s3olap-survey-results-unknown-pii'
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.
---
##### `policyName`Optional
```typescript
public readonly policyName: string;
```
- *Type:* string
- *Default:* 'general-role-s3olap-policy'
The name of the IAM policy for the IAM role.
---
### LambdaArnCaptorResourceProps
#### Initializer
```typescript
import { LambdaArnCaptorResourceProps } from 'cdk-comprehend-s3olap'
const lambdaArnCaptorResourceProps: LambdaArnCaptorResourceProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| partialLambdaName | string | The partial fixed name of the gemeral Lambda function created from the serverless application. |
| roleName | string | the name of the corresponding IAM role. |
---
##### `partialLambdaName`Required
```typescript
public readonly partialLambdaName: string;
```
- *Type:* string
The partial fixed name of the gemeral Lambda function created from the serverless application.
---
##### `roleName`Required
```typescript
public readonly roleName: string;
```
- *Type:* string
the name of the corresponding IAM role.
---
### RedactionLambdaProps
#### Initializer
```typescript
import { RedactionLambdaProps } from 'cdk-comprehend-s3olap'
const redactionLambdaProps: RedactionLambdaProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| confidenceThreshold | string | The minimum prediction confidence score above which PII classification and detection would be considered as final answer. |
| containsPiiEntitiesThreadCount | string | Number of threads to use for calling Comprehend's ContainsPiiEntities API. |
| defaultLanguageCode | string | Default language of the text to be processed. |
| detectPiiEntitiesThreadCount | string | Number of threads to use for calling Comprehend's DetectPiiEntities API. |
| documentMaxSize | string | Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size. |
| documentMaxSizeContainsPiiEntities | string | Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API. |
| documentMaxSizeDetectPiiEntities | string | Maximum document size (in bytes) to be used for making calls to Comprehend's DetectPiiEntities API. |
| isPartialObjectSupported | string | Whether to support partial objects or not. |
| logLevel | string | Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc. |
| maskCharacter | string | A character that replaces each character in the redacted PII entity. |
| maskMode | string | Specifies whether the PII entity is redacted with the mask character or the entity type. |
| maxCharsOverlap | string | Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit. |
| piiEntityTypes | string | List of comma separated PII entity types to be considered for redaction. |
| publishCloudWatchMetrics | string | True if publish metrics to Cloudwatch, false otherwise. |
| semanticVersion | string | The version of the serverless application. |
| subsegmentOverlappingTokens | string | Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit. |
| unsupportedFileHandling | string | Handling logic for Unsupported files. |
---
##### `confidenceThreshold`Optional
```typescript
public readonly confidenceThreshold: string;
```
- *Type:* string
- *Default:* '0.5'
The minimum prediction confidence score above which PII classification and detection would be considered as final answer.
Valid range (0.5 to 1.0).
---
##### `containsPiiEntitiesThreadCount`Optional
```typescript
public readonly containsPiiEntitiesThreadCount: string;
```
- *Type:* string
- *Default:* '20'
Number of threads to use for calling Comprehend's ContainsPiiEntities API.
This controls the number of simultaneous calls that will be made from this Lambda.
---
##### `defaultLanguageCode`Optional
```typescript
public readonly defaultLanguageCode: string;
```
- *Type:* string
- *Default:* 'en'
Default language of the text to be processed.
This code will be used for interacting with Comprehend.
---
##### `detectPiiEntitiesThreadCount`Optional
```typescript
public readonly detectPiiEntitiesThreadCount: string;
```
- *Type:* string
- *Default:* '8'
Number of threads to use for calling Comprehend's DetectPiiEntities API.
This controls the number of simultaneous calls that will be made from this Lambda.
---
##### `documentMaxSize`Optional
```typescript
public readonly documentMaxSize: string;
```
- *Type:* string
- *Default:* '102400'
Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size.
---
##### `documentMaxSizeContainsPiiEntities`Optional
```typescript
public readonly documentMaxSizeContainsPiiEntities: string;
```
- *Type:* string
- *Default:* '50000'
Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API.
---
##### `documentMaxSizeDetectPiiEntities`Optional
```typescript
public readonly documentMaxSizeDetectPiiEntities: string;
```
- *Type:* string
- *Default:* '5000'
Maximum document size (in bytes) to be used for making calls to Comprehend's DetectPiiEntities API.
---
##### `isPartialObjectSupported`Optional
```typescript
public readonly isPartialObjectSupported: string;
```
- *Type:* string
- *Default:* 'false'
Whether to support partial objects or not.
Accessing partial object through http headers such byte-range can corrupt the object and/or affect PII detection accuracy.
---
##### `logLevel`Optional
```typescript
public readonly logLevel: string;
```
- *Type:* string
- *Default:* 'INFO'
Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc.
---
##### `maskCharacter`Optional
```typescript
public readonly maskCharacter: string;
```
- *Type:* string
- *Default:* '*'
A character that replaces each character in the redacted PII entity.
---
##### `maskMode`Optional
```typescript
public readonly maskMode: string;
```
- *Type:* string
Specifies whether the PII entity is redacted with the mask character or the entity type.
Valid values - REPLACE_WITH_PII_ENTITY_TYPE and MASK.
---
##### `maxCharsOverlap`Optional
```typescript
public readonly maxCharsOverlap: string;
```
- *Type:* string
- *Default:* '200'
Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit.
---
##### `piiEntityTypes`Optional
```typescript
public readonly piiEntityTypes: string;
```
- *Type:* string
- *Default:* 'ALL'
List of comma separated PII entity types to be considered for redaction.
Refer Comprehend's documentation page for list of supported PII entity types.
---
##### `publishCloudWatchMetrics`Optional
```typescript
public readonly publishCloudWatchMetrics: string;
```
- *Type:* string
- *Default:* 'true'
True if publish metrics to Cloudwatch, false otherwise.
See README.md for details on CloudWatch metrics.
---
##### `semanticVersion`Optional
```typescript
public readonly semanticVersion: string;
```
- *Type:* string
- *Default:* '1.0.2'
The version of the serverless application.
---
##### `subsegmentOverlappingTokens`Optional
```typescript
public readonly subsegmentOverlappingTokens: string;
```
- *Type:* string
- *Default:* '20'
Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit.
---
##### `unsupportedFileHandling`Optional
```typescript
public readonly unsupportedFileHandling: string;
```
- *Type:* string
- *Default:* 'FAIL'
Handling logic for Unsupported files.
Valid values are PASS and FAIL.
---
### S3AccessPointNames
#### Initializer
```typescript
import { S3AccessPointNames } from 'cdk-comprehend-s3olap'
const s3AccessPointNames: S3AccessPointNames = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| admin | string | The name of the S3 aceess point for the admin role in the redaction case. |
| billing | string | The name of the S3 aceess point for the billing role in the redaction case. |
| customerSupport | string | The name of the S3 aceess point for the customer support role in the redaction case. |
| general | string | The name of the S3 aceess point for the general role in the access control case. |
---
##### `admin`Required
```typescript
public readonly admin: string;
```
- *Type:* string
- *Default:* 'admin-s3-access-point-call-transcripts-known-pii'
The name of the S3 aceess point for the admin role in the redaction case.
---
##### `billing`Required
```typescript
public readonly billing: string;
```
- *Type:* string
- *Default:* 'bill-s3-access-point-call-transcripts-known-pii'
The name of the S3 aceess point for the billing role in the redaction case.
---
##### `customerSupport`Required
```typescript
public readonly customerSupport: string;
```
- *Type:* string
- *Default:* 'cs-s3-access-point-call-transcripts-known-pii'
The name of the S3 aceess point for the customer support role in the redaction case.
---
##### `general`Required
```typescript
public readonly general: string;
```
- *Type:* string
- *Default:* 'accessctl-s3-ap-survey-results-unknown-pii'
The name of the S3 aceess point for the general role in the access control case.
---
## Enums
### IamRoleName
#### Members
| **Name** | **Description** |
| --- | --- |
| GENERAL | *No description.* |
| ADMIN | *No description.* |
| BILLING | *No description.* |
| CUST_SUPPORT | *No description.* |
---
##### `GENERAL`
---
##### `ADMIN`
---
##### `BILLING`
---
##### `CUST_SUPPORT`
---