Package software.amazon.awscdk.services.databrew

Interface CfnJob.EntityDetectorConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnJob.EntityDetectorConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnJob

@Stability(Stable)
public static interface CfnJob.EntityDetectorConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Configuration of entity detection for a profile job.

When undefined, entity detection is disabled.

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.databrew.*;
 EntityDetectorConfigurationProperty entityDetectorConfigurationProperty = EntityDetectorConfigurationProperty.builder()
         .entityTypes(List.of("entityTypes"))
         // the properties below are optional
         .allowedStatistics(AllowedStatisticsProperty.builder()
                 .statistics(List.of("statistics"))
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnJob.EntityDetectorConfigurationProperty.Builder	builder()
default Object	getAllowedStatistics()	Configuration of statistics that are allowed to be run on columns that contain detected entities.
List<String>	getEntityTypes()	Entity types to detect.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEntityTypes

@Stability(Stable)
@NotNull
List<String> getEntityTypes()

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.

See Also:

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

getAllowedStatistics

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

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.

See Also:

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

builder

@Stability(Stable)
static CfnJob.EntityDetectorConfigurationProperty.Builder builder()

Returns:

a CfnJob.EntityDetectorConfigurationProperty.Builder of CfnJob.EntityDetectorConfigurationProperty