Package io.github.hsiehshujeng.cdk.comprehend.s3olap

Interface RedactionLambdaProps

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    RedactionLambdaProps.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.60.1 (build 2799dc8)",
           date="2022-06-12T09:44:01.757Z")
@Stability(Stable)
public interface RedactionLambdaProps
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getConfidenceThreshold

        @Stability(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(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(Stable)
@Nullable
default String getDefaultLanguageCode()
        Default language of the text to be processed.

        This code will be used for interacting with Comprehend.

        Default: 'en'

      • getDetectPiiEntitiesThreadCount

        @Stability(Stable)
@Nullable
default String getDetectPiiEntitiesThreadCount()
        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.

        Default: '8'

      • getDocumentMaxSize

        @Stability(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(Stable)
@Nullable
default String getDocumentMaxSizeContainsPiiEntities()
        Maximum document size (in bytes) to be used for making calls to Comprehend's ContainsPiiEntities API.

        Default: '50000'

      • getDocumentMaxSizeDetectPiiEntities

        @Stability(Stable)
@Nullable
default String getDocumentMaxSizeDetectPiiEntities()
        Maximum document size (in bytes) to be used for making calls to Comprehend's DetectPiiEntities API.

        Default: '5000'

      • getIsPartialObjectSupported

        @Stability(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(Stable)
@Nullable
default String getLogLevel()
        Log level for Lambda function logging, e.g., ERROR, INFO, DEBUG, etc.

        Default: 'INFO'

      • getMaskCharacter

        @Stability(Stable)
@Nullable
default String getMaskCharacter()
        A character that replaces each character in the redacted PII entity.

        Default: '*'

      • getMaskMode

        @Stability(Stable)
@Nullable
default String getMaskMode()
        Specifies whether the PII entity is redacted with the mask character or the entity type.

        Valid values - REPLACE_WITH_PII_ENTITY_TYPE and MASK.

      • getMaxCharsOverlap

        @Stability(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(Stable)
@Nullable
default String getPiiEntityTypes()
        List of comma separated PII entity types to be considered for redaction.

        Refer Comprehend's documentation page for list of supported PII entity types.

        Default: 'ALL'

      • getPublishCloudWatchMetrics

        @Stability(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(Stable)
@Nullable
default String getSemanticVersion()
        The version of the serverless application.

        Default: '1.0.2'

      • getSubsegmentOverlappingTokens

        @Stability(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(Stable)
@Nullable
default String getUnsupportedFileHandling()
        Handling logic for Unsupported files.

        Valid values are PASS and FAIL.

        Default: 'FAIL'