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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass ConfluenceAttachmentConfiguration data as a hash:

{
  crawl_attachments: false,
  attachment_field_mappings: [
    {
      data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName",
    },
  ],
}

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

Instance Attribute Details

#attachment_field_mappingsArray<Types::ConfluenceAttachmentToIndexFieldMapping>

Defines how attachment metadata fields should be mapped to index fields. Before you can map a field, you must first create an index field with a matching type using the console or the UpdateIndex operation.

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



1102
1103
1104
1105
1106
1107
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1102

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

#crawl_attachmentsBoolean

Indicates whether Amazon Kendra indexes attachments to the pages and blogs in the Confluence data source.

Returns:

  • (Boolean)


1102
1103
1104
1105
1106
1107
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 1102

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