Class: AWSCDK::Kendra::CfnDataSource::SalesforceStandardKnowledgeArticleTypeConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kendra/cfn_data_source.rb

Overview

Provides the configuration information for standard Salesforce knowledge articles.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(document_data_field_name:, document_title_field_name: nil, field_mappings: nil) ⇒ SalesforceStandardKnowledgeArticleTypeConfigurationProperty

Returns a new instance of SalesforceStandardKnowledgeArticleTypeConfigurationProperty.

Parameters:



3017
3018
3019
3020
3021
3022
3023
3024
 
# File 'kendra/cfn_data_source.rb', line 3017

def initialize(document_data_field_name:, document_title_field_name: nil, field_mappings: nil)
  @document_data_field_name = document_data_field_name
  Jsii::Type.check_type(@document_data_field_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "documentDataFieldName")
  @document_title_field_name = document_title_field_name
  Jsii::Type.check_type(@document_title_field_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "documentTitleFieldName") unless @document_title_field_name.nil?
  @field_mappings = field_mappings
  Jsii::Type.check_type(@field_mappings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2VuZHJhLkNmbkRhdGFTb3VyY2UuRGF0YVNvdXJjZVRvSW5kZXhGaWVsZE1hcHBpbmdQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "fieldMappings") unless @field_mappings.nil?
end

Instance Attribute Details

#document_data_field_name ⇒ String (readonly)

The name of the field that contains the document data to index.

Returns:

  • (String)

See Also:



3030
3031
3032
 
# File 'kendra/cfn_data_source.rb', line 3030

def document_data_field_name
  @document_data_field_name
end

#document_title_field_name ⇒ String? (readonly)

The name of the field that contains the document title.

Returns:

  • (String, nil)

See Also:



3035
3036
3037
 
# File 'kendra/cfn_data_source.rb', line 3035

def document_title_field_name
  @document_title_field_name
end

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

Maps attributes or field names of the knowledge article to Amazon Kendra index field names.

To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields . The Salesforce data source field names must exist in your Salesforce custom metadata.

Returns:

See Also:



3042
3043
3044
 
# File 'kendra/cfn_data_source.rb', line 3042

def field_mappings
  @field_mappings
end

Class Method Details

.jsii_properties ⇒ Object 



3044
3045
3046
3047
3048
3049
3050
 
# File 'kendra/cfn_data_source.rb', line 3044

def self.jsii_properties
  {
    :document_data_field_name => "documentDataFieldName",
    :document_title_field_name => "documentTitleFieldName",
    :field_mappings => "fieldMappings",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



3052
3053
3054
3055
3056
3057
3058
3059
3060
 
# File 'kendra/cfn_data_source.rb', line 3052

def to_jsii
  result = {}
  result.merge!({
    "documentDataFieldName" => @document_data_field_name,
    "documentTitleFieldName" => @document_title_field_name,
    "fieldMappings" => @field_mappings,
  })
  result.compact
end