io.github.hsiehshujeng.cdk.comprehend.s3olap

Interface AccessConrtolLambdaProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AccessConrtolLambdaProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.31.0 (build 6fa403d)",
           date="2021-07-12T01:29:24.609Z")
 @Stability(value=Stable)
public interface AccessConrtolLambdaProps
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AccessConrtolLambdaProps.Builder A builder for AccessConrtolLambdaProps
static class	AccessConrtolLambdaProps.Jsii$Proxy An implementation for AccessConrtolLambdaProps

Method Summary

Modifier and Type	Method and Description
static AccessConrtolLambdaProps.Builder	builder()
default String	getConfidenceThreshold() The minimum prediction confidence score above which PII classification and detection would be considered as final answer.
default String	getContainsPiiEntitiesThreadCount() Number of threads to use for calling Comprehend's ContainsPiiEntities API.
default String	getDefaultLanguageCode() Default language of the text to be processed.
default String	getDocumentMaxSize() Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size.
default String	getDocumentMaxSizeContainsPiiEntities() Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API.
default String	getIsPartialObjectSupported() Whether to support partial objects or not.
default String	getLogLevel() Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc.
default String	getMaxCharsOverlap() Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit.
default String	getPiiEntityTypes() List of comma separated PII entity types to be considered for access control.
default String	getPublishCloudWatchMetrics() True if publish metrics to Cloudwatch, false otherwise.
default String	getSemanticVersion() The version of the serverless application.
default String	getSubsegmentOverlappingTokens() Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit.
default String	getUnsupportedFileHandling() Handling logic for Unsupported files.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getConfidenceThreshold

@Stability(value=Stable)
 @Nullable
default String getConfidenceThreshold()

The minimum prediction confidence score above which PII classification and detection would be considered as final answer.

Valid range (0.5 to 1.0).

Default: '0.5'

getContainsPiiEntitiesThreadCount

@Stability(value=Stable)
 @Nullable
default String getContainsPiiEntitiesThreadCount()

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.

Default: '20'

getDefaultLanguageCode

@Stability(value=Stable)
 @Nullable
default String getDefaultLanguageCode()

Default language of the text to be processed.

This code will be used for interacting with Comprehend.

Default: 'en'

getDocumentMaxSize

@Stability(value=Stable)
 @Nullable
default String getDocumentMaxSize()

Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size.

Default: '102400'

getDocumentMaxSizeContainsPiiEntities

@Stability(value=Stable)
 @Nullable
default String getDocumentMaxSizeContainsPiiEntities()

Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API.

Default: '50000'

getIsPartialObjectSupported

@Stability(value=Stable)
 @Nullable
default String getIsPartialObjectSupported()

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.

Default: 'false'

getLogLevel

@Stability(value=Stable)
 @Nullable
default String getLogLevel()

Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc.

Default: 'INFO'

getMaxCharsOverlap

@Stability(value=Stable)
 @Nullable
default String getMaxCharsOverlap()

Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit.

Default: '200'

getPiiEntityTypes

@Stability(value=Stable)
 @Nullable
default String getPiiEntityTypes()

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.

Default: 'ALL'

getPublishCloudWatchMetrics

@Stability(value=Stable)
 @Nullable
default String getPublishCloudWatchMetrics()

True if publish metrics to Cloudwatch, false otherwise.

See README.md for details on CloudWatch metrics.

Default: 'true'

getSemanticVersion

@Stability(value=Stable)
 @Nullable
default String getSemanticVersion()

The version of the serverless application.

Default: '1.0.2'

getSubsegmentOverlappingTokens

@Stability(value=Stable)
 @Nullable
default String getSubsegmentOverlappingTokens()

Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit.

Default: '20'

getUnsupportedFileHandling

@Stability(value=Stable)
 @Nullable
default String getUnsupportedFileHandling()

Handling logic for Unsupported files.

Valid values are PASS and FAIL.

Default: 'FAIL'

builder

@Stability(value=Stable)
static AccessConrtolLambdaProps.Builder builder()

Returns:

a AccessConrtolLambdaProps.Builder of AccessConrtolLambdaProps