Class: AWSCDK::DataBrew::CfnJob::EntityDetectorConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::DataBrew::CfnJob::EntityDetectorConfigurationProperty

Defined in:

data_brew/cfn_job.rb

Overview

Configuration of entity detection for a profile job.

When undefined, entity detection is disabled.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-entitydetectorconfiguration.html

Instance Attribute Summary

• #allowed_statistics ⇒ AWSCDK::IResolvable, ... readonly

  Configuration of statistics that are allowed to be run on columns that contain detected entities.

• #entity_types ⇒ Array<String> readonly

  Entity types to detect.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(entity_types:, allowed_statistics: nil) ⇒ EntityDetectorConfigurationProperty constructor

  A new instance of EntityDetectorConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(entity_types:, allowed_statistics: nil) ⇒ EntityDetectorConfigurationProperty

Returns a new instance of EntityDetectorConfigurationProperty.

Parameters:

• entity_types (Array<String>) —

  Entity types to detect. Can be any of the following:.

• allowed_statistics (AWSCDK::IResolvable, AWSCDK::DataBrew::CfnJob::AllowedStatisticsProperty, nil) (defaults to: nil) —

  Configuration of statistics that are allowed to be run on columns that contain detected entities.

# File 'data_brew/cfn_job.rb', line 1101

def initialize(entity_types:, allowed_statistics: nil)
  @entity_types = entity_types
  Jsii::Type.check_type(@entity_types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "entityTypes")
  @allowed_statistics = allowed_statistics.is_a?(Hash) ? ::AWSCDK::DataBrew::CfnJob::AllowedStatisticsProperty.new(**allowed_statistics.transform_keys(&:to_sym)) : allowed_statistics
  Jsii::Type.check_type(@allowed_statistics, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kYXRhYnJldy5DZm5Kb2IuQWxsb3dlZFN0YXRpc3RpY3NQcm9wZXJ0eSJ9XX19")), "allowedStatistics") unless @allowed_statistics.nil?
end

Instance Attribute Details

#allowed_statistics ⇒ AWSCDK::IResolvable, ... (readonly)

Configuration of statistics that are allowed to be run on columns that contain detected entities.

When undefined, no statistics will be computed on columns that contain detected entities.

Returns:

• (AWSCDK::IResolvable, AWSCDK::DataBrew::CfnJob::AllowedStatisticsProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-entitydetectorconfiguration.html#cfn-databrew-job-entitydetectorconfiguration-allowedstatistics

# File 'data_brew/cfn_job.rb', line 1141

def allowed_statistics
  @allowed_statistics
end

#entity_types ⇒ Array<String> (readonly)

Entity types to detect. Can be any of the following:.

• USA_SSN
• EMAIL
• USA_ITIN
• USA_PASSPORT_NUMBER
• PHONE_NUMBER
• USA_DRIVING_LICENSE
• BANK_ACCOUNT
• CREDIT_CARD
• IP_ADDRESS
• MAC_ADDRESS
• USA_DEA_NUMBER
• USA_HCPCS_CODE
• USA_NATIONAL_PROVIDER_IDENTIFIER
• USA_NATIONAL_DRUG_CODE
• USA_HEALTH_INSURANCE_CLAIM_NUMBER
• USA_MEDICARE_BENEFICIARY_IDENTIFIER
• USA_CPT_CODE
• PERSON_NAME
• DATE

The Entity type group USA_ALL is also supported, and includes all of the above entity types except PERSON_NAME and DATE.

Returns:

• (Array<String>)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-databrew-job-entitydetectorconfiguration.html#cfn-databrew-job-entitydetectorconfiguration-entitytypes

# File 'data_brew/cfn_job.rb', line 1134

def entity_types
  @entity_types
end

Class Method Details

.jsii_properties ⇒ Object

# File 'data_brew/cfn_job.rb', line 1143

def self.jsii_properties
  {
    :entity_types => "entityTypes",
    :allowed_statistics => "allowedStatistics",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'data_brew/cfn_job.rb', line 1150

def to_jsii
  result = {}
  result.merge!({
    "entityTypes" => @entity_types,
    "allowedStatistics" => @allowed_statistics,
  })
  result.compact
end