Class: Aws::Kendra::Types::ConfluenceAttachmentConfiguration

Inherits:

Struct

Object
Struct
Aws::Kendra::Types::ConfluenceAttachmentConfiguration

show all

Defined in:: gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#attachment_field_mappings ⇒ Array<Types::ConfluenceAttachmentToIndexFieldMapping>
Maps attributes or field names of Confluence attachments to Amazon Kendra index field names.
#crawl_attachments ⇒ Boolean
TRUE to index attachments of pages and blogs in Confluence.

Instance Attribute Details

#attachment_field_mappings ⇒ `Array<Types::ConfluenceAttachmentToIndexFieldMapping>`

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:

(Array<Types::ConfluenceAttachmentToIndexFieldMapping>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1394

class ConfluenceAttachmentConfiguration < Struct.new(
  :crawl_attachments,
  :attachment_field_mappings)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_attachments ⇒ `Boolean`

TRUE to index attachments of pages and blogs in Confluence.