Class: AWSCDK::Kendra::CfnDataSource::SalesforceKnowledgeArticleConfigurationProperty

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

Overview

Provides the 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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(included_states:, custom_knowledge_article_type_configurations: nil, standard_knowledge_article_type_configuration: nil) ⇒ SalesforceKnowledgeArticleConfigurationProperty

Returns a new instance of SalesforceKnowledgeArticleConfigurationProperty.

Parameters:



2962
2963
2964
2965
2966
2967
2968
2969
 
# File 'kendra/cfn_data_source.rb', line 2962

def initialize(included_states:, custom_knowledge_article_type_configurations: nil, standard_knowledge_article_type_configuration: nil)
  @included_states = included_states
  Jsii::Type.check_type(@included_states, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "includedStates")
  @custom_knowledge_article_type_configurations = custom_knowledge_article_type_configurations
  Jsii::Type.check_type(@custom_knowledge_article_type_configurations, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2VuZHJhLkNmbkRhdGFTb3VyY2UuU2FsZXNmb3JjZUN1c3RvbUtub3dsZWRnZUFydGljbGVUeXBlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "customKnowledgeArticleTypeConfigurations") unless @custom_knowledge_article_type_configurations.nil?
  @standard_knowledge_article_type_configuration = standard_knowledge_article_type_configuration.is_a?(Hash) ? ::AWSCDK::Kendra::CfnDataSource::SalesforceStandardKnowledgeArticleTypeConfigurationProperty.new(**standard_knowledge_article_type_configuration.transform_keys(&:to_sym)) : standard_knowledge_article_type_configuration
  Jsii::Type.check_type(@standard_knowledge_article_type_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rZW5kcmEuQ2ZuRGF0YVNvdXJjZS5TYWxlc2ZvcmNlU3RhbmRhcmRLbm93bGVkZ2VBcnRpY2xlVHlwZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "standardKnowledgeArticleTypeConfiguration") unless @standard_knowledge_article_type_configuration.nil?
end

Instance Attribute Details

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

Configuration information for custom Salesforce knowledge articles.

Returns:

See Also:



2982
2983
2984
 
# File 'kendra/cfn_data_source.rb', line 2982

def custom_knowledge_article_type_configurations
  @custom_knowledge_article_type_configurations
end

#included_states ⇒ Array<String> (readonly)

Specifies the document states that should be included when Amazon Kendra indexes knowledge articles.

You must specify at least one state.

Returns:

  • (Array<String>)

See Also:



2977
2978
2979
 
# File 'kendra/cfn_data_source.rb', line 2977

def included_states
  @included_states
end

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

Configuration information for standard Salesforce knowledge articles.

Returns:

See Also:



2987
2988
2989
 
# File 'kendra/cfn_data_source.rb', line 2987

def standard_knowledge_article_type_configuration
  @standard_knowledge_article_type_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



2989
2990
2991
2992
2993
2994
2995
 
# File 'kendra/cfn_data_source.rb', line 2989

def self.jsii_properties
  {
    :included_states => "includedStates",
    :custom_knowledge_article_type_configurations => "customKnowledgeArticleTypeConfigurations",
    :standard_knowledge_article_type_configuration => "standardKnowledgeArticleTypeConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



2997
2998
2999
3000
3001
3002
3003
3004
3005
 
# File 'kendra/cfn_data_source.rb', line 2997

def to_jsii
  result = {}
  result.merge!({
    "includedStates" => @included_states,
    "customKnowledgeArticleTypeConfigurations" => @custom_knowledge_article_type_configurations,
    "standardKnowledgeArticleTypeConfiguration" => @standard_knowledge_article_type_configuration,
  })
  result.compact
end