Package software.amazon.awscdk.services.bedrock

Interface CfnDataAutomationProject.SensitiveDataConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataAutomationProject.SensitiveDataConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataAutomationProject

@Stability(Stable)
public static interface CfnDataAutomationProject.SensitiveDataConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Configuration for detecting and redacting sensitive data in content.

Use this to control whether sensitive data is detected only or both detected and redacted, specify the scope of detection (standard output, custom output, or both), and configure specific PII entity types to detect along with how they should be masked when redacted.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 SensitiveDataConfigurationProperty sensitiveDataConfigurationProperty = SensitiveDataConfigurationProperty.builder()
         .detectionMode("detectionMode")
         .detectionScope(List.of("detectionScope"))
         .piiEntitiesConfiguration(PIIEntitiesConfigurationProperty.builder()
                 .piiEntityTypes(List.of("piiEntityTypes"))
                 .redactionMaskMode("redactionMaskMode")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-dataautomationproject-sensitivedataconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataAutomationProject.SensitiveDataConfigurationProperty.Builder	builder()
default String	getDetectionMode()	Specifies the mode for handling sensitive data detection.
default List<String>	getDetectionScope()	Defines which BDA output types to apply sensitive data detection to.
default Object	getPiiEntitiesConfiguration()	Configuration for detecting and redacting Personally Identifiable Information (PII) entities.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDetectionMode

@Stability(Stable)
@Nullable
default String getDetectionMode()

Specifies the mode for handling sensitive data detection.

Set to DETECTION to only identify sensitive data without modifying content - this produces one output file per detection scope containing detection information with original unredacted content. Set to DETECTION_AND_REDACTION to both identify and mask sensitive data - this produces two output files per detection scope: one unredacted file with detection information and one redacted file with masking applied to sensitive content. For example, if detectionScope includes both STANDARD and CUSTOM with DETECTION_AND_REDACTION mode, four output files will be generated (two for standard output and two for custom output).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-dataautomationproject-sensitivedataconfiguration.html#cfn-bedrock-dataautomationproject-sensitivedataconfiguration-detectionmode

getDetectionScope

@Stability(Stable)
@Nullable
default List<String> getDetectionScope()

Defines which BDA output types to apply sensitive data detection to.

Specify STANDARD to detect sensitive data in standard output, CUSTOM to detect in custom output (blueprint-based extraction), or both to apply detection to both output types. If not specified, defaults to both STANDARD and CUSTOM. The number of output files generated depends on both the detection mode and the scopes selected - each scope specified will produce its own set of output files according to the detection mode configured.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-dataautomationproject-sensitivedataconfiguration.html#cfn-bedrock-dataautomationproject-sensitivedataconfiguration-detectionscope

getPiiEntitiesConfiguration

@Stability(Stable)
@Nullable
default Object getPiiEntitiesConfiguration()

Configuration for detecting and redacting Personally Identifiable Information (PII) entities.

Returns union: either IResolvable or CfnDataAutomationProject.PIIEntitiesConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-dataautomationproject-sensitivedataconfiguration.html#cfn-bedrock-dataautomationproject-sensitivedataconfiguration-piientitiesconfiguration

builder

@Stability(Stable)
static CfnDataAutomationProject.SensitiveDataConfigurationProperty.Builder builder()

Returns:

a CfnDataAutomationProject.SensitiveDataConfigurationProperty.Builder of CfnDataAutomationProject.SensitiveDataConfigurationProperty