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

Inherits:

Struct

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

Includes:

Structure

Defined in:

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:

• (Array<Types::ConfluenceAttachmentToIndexFieldMapping>)

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

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.

Returns:

• (Boolean)

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

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