Class: AWSCDK::Kendra::CfnDataSource::ConfluenceAttachmentToIndexFieldMappingProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kendra/cfn_data_source.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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_source_field_name:, index_field_name:, date_field_format: nil) ⇒ ConfluenceAttachmentToIndexFieldMappingProperty

Returns a new instance of ConfluenceAttachmentToIndexFieldMappingProperty.

Parameters:

  • data_source_field_name (String) —

    The name of the field in the data source.

  • index_field_name (String) —

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

  • date_field_format (String, nil) (defaults to: nil) —

    The format for date fields in the data source.



848
849
850
851
852
853
854
855
 
# File 'kendra/cfn_data_source.rb', line 848

def initialize(data_source_field_name:, index_field_name:, date_field_format: nil)
  @data_source_field_name = data_source_field_name
  Jsii::Type.check_type(@data_source_field_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataSourceFieldName")
  @index_field_name = index_field_name
  Jsii::Type.check_type(@index_field_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "indexFieldName")
  @date_field_format = date_field_format
  Jsii::Type.check_type(@date_field_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dateFieldFormat") unless @date_field_format.nil?
end

Instance Attribute Details

#data_source_field_name ⇒ String (readonly)

The name of the field in the data source.

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

Returns:

  • (String)

See Also:



863
864
865
 
# File 'kendra/cfn_data_source.rb', line 863

def data_source_field_name
  @data_source_field_name
end

#date_field_format ⇒ String? (readonly)

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, nil)

See Also:



877
878
879
 
# File 'kendra/cfn_data_source.rb', line 877

def date_field_format
  @date_field_format
end

#index_field_name ⇒ String (readonly)

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)

See Also:



870
871
872
 
# File 'kendra/cfn_data_source.rb', line 870

def index_field_name
  @index_field_name
end

Class Method Details

.jsii_properties ⇒ Object 



879
880
881
882
883
884
885
 
# File 'kendra/cfn_data_source.rb', line 879

def self.jsii_properties
  {
    :data_source_field_name => "dataSourceFieldName",
    :index_field_name => "indexFieldName",
    :date_field_format => "dateFieldFormat",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



887
888
889
890
891
892
893
894
895
 
# File 'kendra/cfn_data_source.rb', line 887

def to_jsii
  result = {}
  result.merge!({
    "dataSourceFieldName" => @data_source_field_name,
    "indexFieldName" => @index_field_name,
    "dateFieldFormat" => @date_field_format,
  })
  result.compact
end