io.github.hsiehshujeng.cdk.comprehend.s3olap

Class AccessConrtolLambda.Builder

java.lang.Object

io.github.hsiehshujeng.cdk.comprehend.s3olap.AccessConrtolLambda.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AccessConrtolLambda>

Enclosing class:

AccessConrtolLambda

@Stability(value=Stable)
public static final class AccessConrtolLambda.Builder
extends Object
implements software.amazon.jsii.Builder<AccessConrtolLambda>

A fluent builder for AccessConrtolLambda.

Method Summary

Modifier and Type	Method and Description
AccessConrtolLambda	build()
AccessConrtolLambda.Builder	confidenceThreshold(String confidenceThreshold) The minimum prediction confidence score above which PII classification and detection would be considered as final answer.
AccessConrtolLambda.Builder	containsPiiEntitiesThreadCount(String containsPiiEntitiesThreadCount) Number of threads to use for calling Comprehend's ContainsPiiEntities API.
static AccessConrtolLambda.Builder	create(software.amazon.awscdk.core.Construct scope, String id)
AccessConrtolLambda.Builder	defaultLanguageCode(String defaultLanguageCode) Default language of the text to be processed.
AccessConrtolLambda.Builder	documentMaxSize(String documentMaxSize) Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size.
AccessConrtolLambda.Builder	documentMaxSizeContainsPiiEntities(String documentMaxSizeContainsPiiEntities) Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API.
AccessConrtolLambda.Builder	isPartialObjectSupported(String isPartialObjectSupported) Whether to support partial objects or not.
AccessConrtolLambda.Builder	logLevel(String logLevel) Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc.
AccessConrtolLambda.Builder	maxCharsOverlap(String maxCharsOverlap) Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit.
AccessConrtolLambda.Builder	piiEntityTypes(String piiEntityTypes) List of comma separated PII entity types to be considered for access control.
AccessConrtolLambda.Builder	publishCloudWatchMetrics(String publishCloudWatchMetrics) True if publish metrics to Cloudwatch, false otherwise.
AccessConrtolLambda.Builder	semanticVersion(String semanticVersion) The version of the serverless application.
AccessConrtolLambda.Builder	subsegmentOverlappingTokens(String subsegmentOverlappingTokens) Number of tokens/words to overlap among segments of a document in case chunking is needed because of maximum document size limit.
AccessConrtolLambda.Builder	unsupportedFileHandling(String unsupportedFileHandling) Handling logic for Unsupported files.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Stable)
public static AccessConrtolLambda.Builder create(software.amazon.awscdk.core.Construct scope,
                                                                          String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of AccessConrtolLambda.Builder.

confidenceThreshold

@Stability(value=Stable)
public AccessConrtolLambda.Builder confidenceThreshold(String confidenceThreshold)

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'

Parameters:

confidenceThreshold - The minimum prediction confidence score above which PII classification and detection would be considered as final answer. This parameter is required.

Returns:

this

containsPiiEntitiesThreadCount

@Stability(value=Stable)
public AccessConrtolLambda.Builder containsPiiEntitiesThreadCount(String containsPiiEntitiesThreadCount)

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'

Parameters:

containsPiiEntitiesThreadCount - Number of threads to use for calling Comprehend's ContainsPiiEntities API. This parameter is required.

Returns:

this

defaultLanguageCode

@Stability(value=Stable)
public AccessConrtolLambda.Builder defaultLanguageCode(String defaultLanguageCode)

Default language of the text to be processed.

This code will be used for interacting with Comprehend.

Default: 'en'

Parameters:

defaultLanguageCode - Default language of the text to be processed. This parameter is required.

Returns:

this

documentMaxSize

@Stability(value=Stable)
public AccessConrtolLambda.Builder documentMaxSize(String documentMaxSize)

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

Default: '102400'

Parameters:

documentMaxSize - Default maximum document size (in bytes) that this function can process otherwise will throw exception for too large document size. This parameter is required.

Returns:

this

documentMaxSizeContainsPiiEntities

@Stability(value=Stable)
public AccessConrtolLambda.Builder documentMaxSizeContainsPiiEntities(String documentMaxSizeContainsPiiEntities)

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

Default: '50000'

Parameters:

documentMaxSizeContainsPiiEntities - Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API. This parameter is required.

Returns:

this

isPartialObjectSupported

@Stability(value=Stable)
public AccessConrtolLambda.Builder isPartialObjectSupported(String isPartialObjectSupported)

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'

Parameters:

isPartialObjectSupported - Whether to support partial objects or not. This parameter is required.

Returns:

this

logLevel

@Stability(value=Stable)
public AccessConrtolLambda.Builder logLevel(String logLevel)

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

Default: 'INFO'

Parameters:

logLevel - Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc. This parameter is required.

Returns:

this

maxCharsOverlap

@Stability(value=Stable)
public AccessConrtolLambda.Builder maxCharsOverlap(String maxCharsOverlap)

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

Default: '200'

Parameters:

maxCharsOverlap - Maximum characters to overlap among segments of a document in case chunking is needed because of maximum document size limit. This parameter is required.

Returns:

this

piiEntityTypes

@Stability(value=Stable)
public AccessConrtolLambda.Builder piiEntityTypes(String piiEntityTypes)

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'

Parameters:

piiEntityTypes - List of comma separated PII entity types to be considered for access control. This parameter is required.

Returns:

this

publishCloudWatchMetrics

@Stability(value=Stable)
public AccessConrtolLambda.Builder publishCloudWatchMetrics(String publishCloudWatchMetrics)

True if publish metrics to Cloudwatch, false otherwise.

See README.md for details on CloudWatch metrics.

Default: 'true'

Parameters:

publishCloudWatchMetrics - True if publish metrics to Cloudwatch, false otherwise. This parameter is required.

Returns:

this

semanticVersion

@Stability(value=Stable)
public AccessConrtolLambda.Builder semanticVersion(String semanticVersion)

The version of the serverless application.

Default: '1.0.2'

Parameters:

semanticVersion - The version of the serverless application. This parameter is required.

Returns:

this

subsegmentOverlappingTokens

@Stability(value=Stable)
public AccessConrtolLambda.Builder subsegmentOverlappingTokens(String subsegmentOverlappingTokens)

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

Default: '20'

Parameters:

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

Returns:

this

unsupportedFileHandling

@Stability(value=Stable)
public AccessConrtolLambda.Builder unsupportedFileHandling(String unsupportedFileHandling)

Handling logic for Unsupported files.

Valid values are PASS and FAIL.

Default: 'FAIL'

Parameters:

unsupportedFileHandling - Handling logic for Unsupported files. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public AccessConrtolLambda build()

Specified by:

build in interface software.amazon.jsii.Builder<AccessConrtolLambda>