Class: AWSCDK::Kendra::CfnDataSource::SalesforceConfigurationProperty

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

Overview

Provides the configuration information to connect to Salesforce as your data source.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(secret_arn:, server_url:, chatter_feed_configuration: nil, crawl_attachments: nil, exclude_attachment_file_patterns: nil, include_attachment_file_patterns: nil, knowledge_article_configuration: nil, standard_object_attachment_configuration: nil, standard_object_configurations: nil) ⇒ SalesforceConfigurationProperty

Returns a new instance of SalesforceConfigurationProperty.

Parameters:



2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
 
# File 'kendra/cfn_data_source.rb', line 2769

def initialize(secret_arn:, server_url:, chatter_feed_configuration: nil, crawl_attachments: nil, exclude_attachment_file_patterns: nil, include_attachment_file_patterns: nil, knowledge_article_configuration: nil, standard_object_attachment_configuration: nil, standard_object_configurations: nil)
  @secret_arn = secret_arn
  Jsii::Type.check_type(@secret_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "secretArn")
  @server_url = server_url
  Jsii::Type.check_type(@server_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serverUrl")
  @chatter_feed_configuration = chatter_feed_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::SalesforceChatterFeedConfigurationProperty.new(**chatter_feed_configuration.transform_keys(&:to_sym)) : chatter_feed_configuration
  Jsii::Type.check_type(@chatter_feed_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5TYWxlc2ZvcmNlQ2hhdHRlckZlZWRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "chatterFeedConfiguration") unless @chatter_feed_configuration.nil?
  @crawl_attachments = crawl_attachments
  Jsii::Type.check_type(@crawl_attachments, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "crawlAttachments") unless @crawl_attachments.nil?
  @exclude_attachment_file_patterns = exclude_attachment_file_patterns
  Jsii::Type.check_type(@exclude_attachment_file_patterns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "excludeAttachmentFilePatterns") unless @exclude_attachment_file_patterns.nil?
  @include_attachment_file_patterns = include_attachment_file_patterns
  Jsii::Type.check_type(@include_attachment_file_patterns, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "includeAttachmentFilePatterns") unless @include_attachment_file_patterns.nil?
  @knowledge_article_configuration = knowledge_article_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::SalesforceKnowledgeArticleConfigurationProperty.new(**knowledge_article_configuration.transform_keys(&:to_sym)) : knowledge_article_configuration
  Jsii::Type.check_type(@knowledge_article_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5TYWxlc2ZvcmNlS25vd2xlZGdlQXJ0aWNsZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "knowledgeArticleConfiguration") unless @knowledge_article_configuration.nil?
  @standard_object_attachment_configuration = standard_object_attachment_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::SalesforceStandardObjectAttachmentConfigurationProperty.new(**standard_object_attachment_configuration.transform_keys(&:to_sym)) : standard_object_attachment_configuration
  Jsii::Type.check_type(@standard_object_attachment_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5TYWxlc2ZvcmNlU3RhbmRhcmRPYmplY3RBdHRhY2htZW50Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "standardObjectAttachmentConfiguration") unless @standard_object_attachment_configuration.nil?
  @standard_object_configurations = standard_object_configurations
  Jsii::Type.check_type(@standard_object_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2VuZHJhLkNmbkRhdGFTb3VyY2UuU2FsZXNmb3JjZVN0YW5kYXJkT2JqZWN0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "standardObjectConfigurations") unless @standard_object_configurations.nil?
end

Instance Attribute Details

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

Configuration information for Salesforce chatter feeds.

Returns:

See Also:



2813
2814
2815
 
# File 'kendra/cfn_data_source.rb', line 2813

def chatter_feed_configuration
  @chatter_feed_configuration
end

#crawl_attachments ⇒ Boolean, ... (readonly)

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

Returns:

See Also:



2818
2819
2820
 
# File 'kendra/cfn_data_source.rb', line 2818

def crawl_attachments
  @crawl_attachments
end

#exclude_attachment_file_patterns ⇒ Array<String>? (readonly)

A list of regular expression patterns to exclude certain documents in your Salesforce.

Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the name of the attached file.

Returns:

  • (Array<String>, nil)

See Also:



2827
2828
2829
 
# File 'kendra/cfn_data_source.rb', line 2827

def exclude_attachment_file_patterns
  @exclude_attachment_file_patterns
end

#include_attachment_file_patterns ⇒ Array<String>? (readonly)

A list of regular expression patterns to include certain documents in your Salesforce.

Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The pattern is applied to the name of the attached file.

Returns:

  • (Array<String>, nil)

See Also:



2836
2837
2838
 
# File 'kendra/cfn_data_source.rb', line 2836

def include_attachment_file_patterns
  @include_attachment_file_patterns
end

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

Configuration information for the knowledge article types that Amazon Kendra indexes.

Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

Returns:

See Also:



2843
2844
2845
 
# File 'kendra/cfn_data_source.rb', line 2843

def knowledge_article_configuration
  @knowledge_article_configuration
end

#secret_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance.

The secret must contain a JSON structure with the following keys:

  • authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.
  • consumerKey - The application public key generated when you created your Salesforce application.
  • consumerSecret - The application private key generated when you created your Salesforce application.
  • password - The password associated with the user logging in to the Salesforce instance.
  • securityToken - The token associated with the user logging in to the Salesforce instance.
  • username - The user name of the user logging in to the Salesforce instance.

Returns:

  • (String)

See Also:



2803
2804
2805
 
# File 'kendra/cfn_data_source.rb', line 2803

def secret_arn
  @secret_arn
end

#server_url ⇒ String (readonly)

The instance URL for the Salesforce site that you want to index.

Returns:

  • (String)

See Also:



2808
2809
2810
 
# File 'kendra/cfn_data_source.rb', line 2808

def server_url
  @server_url
end

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

Configuration information for processing attachments to Salesforce standard objects.

Returns:

See Also:



2848
2849
2850
 
# File 'kendra/cfn_data_source.rb', line 2848

def standard_object_attachment_configuration
  @standard_object_attachment_configuration
end

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

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

Returns:

See Also:



2853
2854
2855
 
# File 'kendra/cfn_data_source.rb', line 2853

def standard_object_configurations
  @standard_object_configurations
end

Class Method Details

.jsii_properties ⇒ Object 



2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
 
# File 'kendra/cfn_data_source.rb', line 2855

def self.jsii_properties
  {
    :secret_arn => "secretArn",
    :server_url => "serverUrl",
    :chatter_feed_configuration => "chatterFeedConfiguration",
    :crawl_attachments => "crawlAttachments",
    :exclude_attachment_file_patterns => "excludeAttachmentFilePatterns",
    :include_attachment_file_patterns => "includeAttachmentFilePatterns",
    :knowledge_article_configuration => "knowledgeArticleConfiguration",
    :standard_object_attachment_configuration => "standardObjectAttachmentConfiguration",
    :standard_object_configurations => "standardObjectConfigurations",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
 
# File 'kendra/cfn_data_source.rb', line 2869

def to_jsii
  result = {}
  result.merge!({
    "secretArn" => @secret_arn,
    "serverUrl" => @server_url,
    "chatterFeedConfiguration" => @chatter_feed_configuration,
    "crawlAttachments" => @crawl_attachments,
    "excludeAttachmentFilePatterns" => @exclude_attachment_file_patterns,
    "includeAttachmentFilePatterns" => @include_attachment_file_patterns,
    "knowledgeArticleConfiguration" => @knowledge_article_configuration,
    "standardObjectAttachmentConfiguration" => @standard_object_attachment_configuration,
    "standardObjectConfigurations" => @standard_object_configurations,
  })
  result.compact
end