Class: AWSCDK::Bedrock::CfnDataAutomationProject::PIIEntitiesConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Bedrock::CfnDataAutomationProject::PIIEntitiesConfigurationProperty

Defined in:

bedrock/cfn_data_automation_project.rb

Overview

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

Specify which PII entity types to detect and the redaction mask mode. If not provided, defaults to ALL entity types with ENTITY_TYPE redaction mask mode.

See Also:

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

Instance Attribute Summary

• #pii_entity_types ⇒ Array<String>^? readonly

  List of PII entity types to detect/redact in the output.

• #redaction_mask_mode ⇒ String^? readonly

  Defines how detected PII entities are masked in redacted output files.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(pii_entity_types: nil, redaction_mask_mode: nil) ⇒ PIIEntitiesConfigurationProperty constructor

  A new instance of PIIEntitiesConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(pii_entity_types: nil, redaction_mask_mode: nil) ⇒ PIIEntitiesConfigurationProperty

Returns a new instance of PIIEntitiesConfigurationProperty.

Parameters:

• pii_entity_types (Array<String>, nil) (defaults to: nil) —

  List of PII entity types to detect/redact in the output.

• redaction_mask_mode (String, nil) (defaults to: nil) —

  Defines how detected PII entities are masked in redacted output files.

# File 'bedrock/cfn_data_automation_project.rb', line 1876

def initialize(pii_entity_types: nil, redaction_mask_mode: nil)
  @pii_entity_types = pii_entity_types
  Jsii::Type.check_type(@pii_entity_types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "piiEntityTypes") unless @pii_entity_types.nil?
  @redaction_mask_mode = redaction_mask_mode
  Jsii::Type.check_type(@redaction_mask_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "redactionMaskMode") unless @redaction_mask_mode.nil?
end

Instance Attribute Details

#pii_entity_types ⇒ Array<String>^? (readonly)

List of PII entity types to detect/redact in the output.

Choose from specific entity types (such as ADDRESS, NAME, EMAIL, PHONE, US_SOCIAL_SECURITY_NUMBER) or specify ALL to detect all supported PII types. If not specified, defaults to ALL.

Returns:

• (Array<String>, nil)

See Also:

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

# File 'bedrock/cfn_data_automation_project.rb', line 1889

def pii_entity_types
  @pii_entity_types
end

#redaction_mask_mode ⇒ String^? (readonly)

Defines how detected PII entities are masked in redacted output files.

Set to PII to replace all detected entities with a generic [PII] marker regardless of entity type. Set to ENTITY_TYPE to replace each detected entity with its specific type marker (for example, [NAME], [EMAIL], [ADDRESS]). This setting only applies when detectionMode is set to DETECTION_AND_REDACTION. If not specified, defaults to ENTITY_TYPE.

Returns:

• (String, nil)

See Also:

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

# File 'bedrock/cfn_data_automation_project.rb', line 1896

def redaction_mask_mode
  @redaction_mask_mode
end

Class Method Details

.jsii_properties ⇒ Object

# File 'bedrock/cfn_data_automation_project.rb', line 1898

def self.jsii_properties
  {
    :pii_entity_types => "piiEntityTypes",
    :redaction_mask_mode => "redactionMaskMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'bedrock/cfn_data_automation_project.rb', line 1905

def to_jsii
  result = {}
  result.merge!({
    "piiEntityTypes" => @pii_entity_types,
    "redactionMaskMode" => @redaction_mask_mode,
  })
  result.compact
end