Class: Aws::Kendra::Types::ConfluenceAttachmentToIndexFieldMapping

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::ConfluenceAttachmentToIndexFieldMapping

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

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 Confuence data source field names must exist in your Confluence custom metadata.

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #data_source_field_name ⇒ String

  The name of the field in the data source.

• #date_field_format ⇒ String

  The format for date fields in the data source.

• #index_field_name ⇒ String

  The name of the index field to map to the Confluence data source field.

Instance Attribute Details

#data_source_field_name ⇒ String

The name of the field in the data source.

You must first create the index field using the ‘UpdateIndex` API.

Returns:

• (String)

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

class ConfluenceAttachmentToIndexFieldMapping < Struct.new(
  :data_source_field_name,
  :date_field_format,
  :index_field_name)
  SENSITIVE = []
  include Aws::Structure
end

#date_field_format ⇒ String

The format for date fields in the data source. If the field specified in ‘DataSourceFieldName` is a date field you must specify the date format. If the field is not a date field, an exception is thrown.

Returns:

• (String)

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

class ConfluenceAttachmentToIndexFieldMapping < Struct.new(
  :data_source_field_name,
  :date_field_format,
  :index_field_name)
  SENSITIVE = []
  include Aws::Structure
end

#index_field_name ⇒ String

The name of the index field to map to the Confluence data source field. The index field type must match the Confluence field type.

Returns:

• (String)

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

class ConfluenceAttachmentToIndexFieldMapping < Struct.new(
  :data_source_field_name,
  :date_field_format,
  :index_field_name)
  SENSITIVE = []
  include Aws::Structure
end