Class: AWSCDK::Kendra::CfnDataSource::SalesforceChatterFeedConfigurationProperty

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

Overview

The configuration information for syncing a Salesforce chatter feed.

The contents of the object comes from the Salesforce FeedItem table.

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, include_filter_types: nil) ⇒ SalesforceChatterFeedConfigurationProperty

Returns a new instance of SalesforceChatterFeedConfigurationProperty.

Parameters:

  • document_data_field_name (String) —

    The name of the column in the Salesforce FeedItem table that contains the content to index.

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

    The name of the column in the Salesforce FeedItem table that contains the title of the document.

  • field_mappings (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Kendra::CfnDataSource::DataSourceToIndexFieldMappingProperty>, nil) (defaults to: nil) —

    Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

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

    Filters the documents in the feed based on status of the user.



2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
 
# File 'kendra/cfn_data_source.rb', line 2695

def initialize(document_data_field_name:, document_title_field_name: nil, field_mappings: nil, include_filter_types: 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?
  @include_filter_types = include_filter_types
  Jsii::Type.check_type(@include_filter_types, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "includeFilterTypes") unless @include_filter_types.nil?
end

Instance Attribute Details

#document_data_field_name ⇒ String (readonly)

The name of the column in the Salesforce FeedItem table that contains the content to index.

Typically this is the Body column.

Returns:

  • (String)

See Also:



2712
2713
2714
 
# File 'kendra/cfn_data_source.rb', line 2712

def document_data_field_name
  @document_data_field_name
end

#document_title_field_name ⇒ String? (readonly)

The name of the column in the Salesforce FeedItem table that contains the title of the document.

This is typically the Title column.

Returns:

  • (String, nil)

See Also:



2719
2720
2721
 
# File 'kendra/cfn_data_source.rb', line 2719

def document_title_field_name
  @document_title_field_name
end

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

Maps fields from a Salesforce chatter feed into Amazon Kendra index fields.

Returns:

See Also:



2724
2725
2726
 
# File 'kendra/cfn_data_source.rb', line 2724

def field_mappings
  @field_mappings
end

#include_filter_types ⇒ Array<String>? (readonly)

Filters the documents in the feed based on status of the user.

When you specify ACTIVE_USERS only documents from users who have an active account are indexed. When you specify STANDARD_USER only documents for Salesforce standard users are documented. You can specify both.

Returns:

  • (Array<String>, nil)

See Also:



2731
2732
2733
 
# File 'kendra/cfn_data_source.rb', line 2731

def include_filter_types
  @include_filter_types
end

Class Method Details

.jsii_properties ⇒ Object 



2733
2734
2735
2736
2737
2738
2739
2740
 
# File 'kendra/cfn_data_source.rb', line 2733

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

Instance Method Details

#to_jsii ⇒ Object 



2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
 
# File 'kendra/cfn_data_source.rb', line 2742

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