Interface PIIDetection.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PIIDetection.Builder,PIIDetection>, SdkBuilder<PIIDetection.Builder,PIIDetection>, SdkPojo

Enclosing class:

PIIDetection

@Mutable
@NotThreadSafe
public static interface PIIDetection.Builder
extends SdkPojo, CopyableBuilder<PIIDetection.Builder,PIIDetection>

Method Summary

Modifier and Type	Method	Description
PIIDetection.Builder	detectionParameters(String detectionParameters)	Additional parameters for configuring PII detection behavior and sensitivity settings.
PIIDetection.Builder	detectionSensitivity(String detectionSensitivity)	The sensitivity level for PII detection.
PIIDetection.Builder	entityTypesToDetect(String... entityTypesToDetect)	Indicates the types of entities the PIIDetection transform will identify as PII data.
PIIDetection.Builder	entityTypesToDetect(Collection<String> entityTypesToDetect)	Indicates the types of entities the PIIDetection transform will identify as PII data.
PIIDetection.Builder	inputs(String... inputs)	The node ID inputs to the transform.
PIIDetection.Builder	inputs(Collection<String> inputs)	The node ID inputs to the transform.
PIIDetection.Builder	maskValue(String maskValue)	Indicates the value that will replace the detected entity.
PIIDetection.Builder	matchPattern(String matchPattern)	A regular expression pattern used to identify additional PII content beyond the standard detection algorithms.
PIIDetection.Builder	name(String name)	The name of the transform node.
PIIDetection.Builder	numLeftCharsToExclude(Integer numLeftCharsToExclude)	The number of characters to exclude from redaction on the left side of detected PII content.
PIIDetection.Builder	numRightCharsToExclude(Integer numRightCharsToExclude)	The number of characters to exclude from redaction on the right side of detected PII content.
PIIDetection.Builder	outputColumnName(String outputColumnName)	Indicates the output column name that will contain any entity type detected in that row.
PIIDetection.Builder	piiType(String piiType)	Indicates the type of PIIDetection transform.
PIIDetection.Builder	piiType(PiiType piiType)	Indicates the type of PIIDetection transform.
PIIDetection.Builder	redactChar(String redactChar)	The character used to replace detected PII content when redaction is enabled.
PIIDetection.Builder	redactText(String redactText)	Specifies whether to redact the detected PII text.
PIIDetection.Builder	sampleFraction(Double sampleFraction)	Indicates the fraction of the data to sample when scanning for PII entities.
PIIDetection.Builder	thresholdFraction(Double thresholdFraction)	Indicates the fraction of the data that must be met in order for a column to be identified as PII data.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

name

PIIDetection.Builder name(String name)

The name of the transform node.

Parameters:

name - The name of the transform node.

Returns:

Returns a reference to this object so that method calls can be chained together.

inputs

PIIDetection.Builder inputs(Collection<String> inputs)

The node ID inputs to the transform.

Parameters:

inputs - The node ID inputs to the transform.

Returns:

Returns a reference to this object so that method calls can be chained together.

inputs

PIIDetection.Builder inputs(String... inputs)

The node ID inputs to the transform.

Parameters:

inputs - The node ID inputs to the transform.

Returns:

Returns a reference to this object so that method calls can be chained together.

piiType

PIIDetection.Builder piiType(String piiType)

Indicates the type of PIIDetection transform.

Parameters:

piiType - Indicates the type of PIIDetection transform.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• PiiType
• PiiType

piiType

PIIDetection.Builder piiType(PiiType piiType)

Indicates the type of PIIDetection transform.

Parameters:

piiType - Indicates the type of PIIDetection transform.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• PiiType
• PiiType

entityTypesToDetect

PIIDetection.Builder entityTypesToDetect(Collection<String> entityTypesToDetect)

Indicates the types of entities the PIIDetection transform will identify as PII data.

PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER ,USA_DEA_NUMBER,USA_DRIVING_LICENSE

Parameters:

entityTypesToDetect - Indicates the types of entities the PIIDetection transform will identify as PII data.

PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD ,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE

Returns:

Returns a reference to this object so that method calls can be chained together.

entityTypesToDetect

PIIDetection.Builder entityTypesToDetect(String... entityTypesToDetect)

Indicates the types of entities the PIIDetection transform will identify as PII data.

PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD,USA_NATIONAL_PROVIDER_IDENTIFIER ,USA_DEA_NUMBER,USA_DRIVING_LICENSE

Parameters:

entityTypesToDetect - Indicates the types of entities the PIIDetection transform will identify as PII data.

PII type entities include: PERSON_NAME, DATE, USA_SNN, EMAIL, USA_ITIN, USA_PASSPORT_NUMBER, PHONE_NUMBER, BANK_ACCOUNT, IP_ADDRESS, MAC_ADDRESS, USA_CPT_CODE, USA_HCPCS_CODE, USA_NATIONAL_DRUG_CODE, USA_MEDICARE_BENEFICIARY_IDENTIFIER, USA_HEALTH_INSURANCE_CLAIM_NUMBER,CREDIT_CARD ,USA_NATIONAL_PROVIDER_IDENTIFIER,USA_DEA_NUMBER,USA_DRIVING_LICENSE

Returns:

Returns a reference to this object so that method calls can be chained together.

outputColumnName

PIIDetection.Builder outputColumnName(String outputColumnName)

Indicates the output column name that will contain any entity type detected in that row.

Parameters:

outputColumnName - Indicates the output column name that will contain any entity type detected in that row.

Returns:

Returns a reference to this object so that method calls can be chained together.

sampleFraction

PIIDetection.Builder sampleFraction(Double sampleFraction)

Indicates the fraction of the data to sample when scanning for PII entities.

Parameters:

sampleFraction - Indicates the fraction of the data to sample when scanning for PII entities.

Returns:

Returns a reference to this object so that method calls can be chained together.

thresholdFraction

PIIDetection.Builder thresholdFraction(Double thresholdFraction)

Indicates the fraction of the data that must be met in order for a column to be identified as PII data.

Parameters:

thresholdFraction - Indicates the fraction of the data that must be met in order for a column to be identified as PII data.

Returns:

Returns a reference to this object so that method calls can be chained together.

maskValue

PIIDetection.Builder maskValue(String maskValue)

Indicates the value that will replace the detected entity.

Parameters:

maskValue - Indicates the value that will replace the detected entity.

Returns:

Returns a reference to this object so that method calls can be chained together.

redactText

PIIDetection.Builder redactText(String redactText)

Specifies whether to redact the detected PII text. When set to true, PII content is replaced with redaction characters.

Parameters:

redactText - Specifies whether to redact the detected PII text. When set to true, PII content is replaced with redaction characters.

Returns:

Returns a reference to this object so that method calls can be chained together.

redactChar

PIIDetection.Builder redactChar(String redactChar)

The character used to replace detected PII content when redaction is enabled. The default redaction character is *.

Parameters:

redactChar - The character used to replace detected PII content when redaction is enabled. The default redaction character is *.

Returns:

Returns a reference to this object so that method calls can be chained together.

matchPattern

PIIDetection.Builder matchPattern(String matchPattern)

A regular expression pattern used to identify additional PII content beyond the standard detection algorithms.

Parameters:

matchPattern - A regular expression pattern used to identify additional PII content beyond the standard detection algorithms.

Returns:

Returns a reference to this object so that method calls can be chained together.

numLeftCharsToExclude

PIIDetection.Builder numLeftCharsToExclude(Integer numLeftCharsToExclude)

The number of characters to exclude from redaction on the left side of detected PII content. This allows preserving context around the sensitive data.

Parameters:

numLeftCharsToExclude - The number of characters to exclude from redaction on the left side of detected PII content. This allows preserving context around the sensitive data.

Returns:

Returns a reference to this object so that method calls can be chained together.

numRightCharsToExclude

PIIDetection.Builder numRightCharsToExclude(Integer numRightCharsToExclude)

The number of characters to exclude from redaction on the right side of detected PII content. This allows preserving context around the sensitive data.

Parameters:

numRightCharsToExclude - The number of characters to exclude from redaction on the right side of detected PII content. This allows preserving context around the sensitive data.

Returns:

Returns a reference to this object so that method calls can be chained together.

detectionParameters

PIIDetection.Builder detectionParameters(String detectionParameters)

Additional parameters for configuring PII detection behavior and sensitivity settings.

Parameters:

detectionParameters - Additional parameters for configuring PII detection behavior and sensitivity settings.

Returns:

Returns a reference to this object so that method calls can be chained together.

detectionSensitivity

PIIDetection.Builder detectionSensitivity(String detectionSensitivity)

The sensitivity level for PII detection. Higher sensitivity levels detect more potential PII but may result in more false positives.

Parameters:

detectionSensitivity - The sensitivity level for PII detection. Higher sensitivity levels detect more potential PII but may result in more false positives.

Returns:

Returns a reference to this object so that method calls can be chained together.