Class: AWSCDK::Kendra::CfnDataSource::ConfluenceAttachmentConfigurationProperty

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

Overview

Configuration of attachment settings for the Confluence data source.

Attachment settings are optional, if you don't specify settings attachments, Amazon Kendra won't index them.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attachment_field_mappings: nil, crawl_attachments: nil) ⇒ ConfluenceAttachmentConfigurationProperty

Returns a new instance of ConfluenceAttachmentConfigurationProperty.

Parameters:



798
799
800
801
802
803
 
# File 'kendra/cfn_data_source.rb', line 798

def initialize(attachment_field_mappings: nil, crawl_attachments: nil)
  @attachment_field_mappings = attachment_field_mappings
  Jsii::Type.check_type(@attachment_field_mappings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2VuZHJhLkNmbkRhdGFTb3VyY2UuQ29uZmx1ZW5jZUF0dGFjaG1lbnRUb0luZGV4RmllbGRNYXBwaW5nUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "attachmentFieldMappings") unless @attachment_field_mappings.nil?
  @crawl_attachments = crawl_attachments
  Jsii::Type.check_type(@crawl_attachments, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "crawlAttachments") unless @crawl_attachments.nil?
end

Instance Attribute Details

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

Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.

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

If you specify the AttachentFieldMappings parameter, you must specify at least one field mapping.

Returns:

See Also:



813
814
815
 
# File 'kendra/cfn_data_source.rb', line 813

def attachment_field_mappings
  @attachment_field_mappings
end

#crawl_attachments ⇒ Boolean, ... (readonly)

TRUE to index attachments of pages and blogs in Confluence.

Returns:

See Also:



818
819
820
 
# File 'kendra/cfn_data_source.rb', line 818

def crawl_attachments
  @crawl_attachments
end

Class Method Details

.jsii_properties ⇒ Object 



820
821
822
823
824
825
 
# File 'kendra/cfn_data_source.rb', line 820

def self.jsii_properties
  {
    :attachment_field_mappings => "attachmentFieldMappings",
    :crawl_attachments => "crawlAttachments",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



827
828
829
830
831
832
833
834
 
# File 'kendra/cfn_data_source.rb', line 827

def to_jsii
  result = {}
  result.merge!({
    "attachmentFieldMappings" => @attachment_field_mappings,
    "crawlAttachments" => @crawl_attachments,
  })
  result.compact
end