Class: AWSCDK::CustomerProfiles::CfnDomain::MatchingProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
customer_profiles/cfn_domain.rb

Overview

The process of matching duplicate profiles.

If Matching = true , Connect Customer Customer Profiles starts a weekly batch process called Identity Resolution Job . If you do not specify a date and time for the Identity Resolution Job to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the Identity Resolution Job completes, use the GetMatches API to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest , you can download the results from S3.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(enabled:, auto_merging: nil, exporting_config: nil, job_schedule: nil) ⇒ MatchingProperty

Returns a new instance of MatchingProperty.

Parameters:



1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
 
# File 'customer_profiles/cfn_domain.rb', line 1063

def initialize(enabled:, auto_merging: nil, exporting_config: nil, job_schedule: nil)
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enabled")
  @auto_merging = auto_merging.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnDomain::AutoMergingProperty.new(**auto_merging.transform_keys(&:to_sym)) : auto_merging
  Jsii::Type.check_type(@auto_merging, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jdXN0b21lcnByb2ZpbGVzLkNmbkRvbWFpbi5BdXRvTWVyZ2luZ1Byb3BlcnR5In1dfX0=")), "autoMerging") unless @auto_merging.nil?
  @exporting_config = exporting_config.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnDomain::ExportingConfigProperty.new(**exporting_config.transform_keys(&:to_sym)) : exporting_config
  Jsii::Type.check_type(@exporting_config, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jdXN0b21lcnByb2ZpbGVzLkNmbkRvbWFpbi5FeHBvcnRpbmdDb25maWdQcm9wZXJ0eSJ9XX19")), "exportingConfig") unless @exporting_config.nil?
  @job_schedule = job_schedule.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnDomain::JobScheduleProperty.new(**job_schedule.transform_keys(&:to_sym)) : job_schedule
  Jsii::Type.check_type(@job_schedule, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jdXN0b21lcnByb2ZpbGVzLkNmbkRvbWFpbi5Kb2JTY2hlZHVsZVByb3BlcnR5In1dfX0=")), "jobSchedule") unless @job_schedule.nil?
end

Instance Attribute Details

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

Configuration information about the auto-merging process.

Returns:

See Also:



1083
1084
1085
 
# File 'customer_profiles/cfn_domain.rb', line 1083

def auto_merging
  @auto_merging
end

#enabled ⇒ Boolean, AWSCDK::IResolvable (readonly)

The flag that enables the matching process of duplicate profiles.

Returns:

See Also:



1078
1079
1080
 
# File 'customer_profiles/cfn_domain.rb', line 1078

def enabled
  @enabled
end

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

The S3 location where Identity Resolution Jobs write result files.

Returns:

See Also:



1088
1089
1090
 
# File 'customer_profiles/cfn_domain.rb', line 1088

def exporting_config
  @exporting_config
end

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

The day and time when do you want to start the Identity Resolution Job every week.

Returns:

See Also:



1093
1094
1095
 
# File 'customer_profiles/cfn_domain.rb', line 1093

def job_schedule
  @job_schedule
end

Class Method Details

.jsii_properties ⇒ Object 



1095
1096
1097
1098
1099
1100
1101
1102
 
# File 'customer_profiles/cfn_domain.rb', line 1095

def self.jsii_properties
  {
    :enabled => "enabled",
    :auto_merging => "autoMerging",
    :exporting_config => "exportingConfig",
    :job_schedule => "jobSchedule",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
 
# File 'customer_profiles/cfn_domain.rb', line 1104

def to_jsii
  result = {}
  result.merge!({
    "enabled" => @enabled,
    "autoMerging" => @auto_merging,
    "exportingConfig" => @exporting_config,
    "jobSchedule" => @job_schedule,
  })
  result.compact
end