Class: AWSCDK::Kendra::CfnDataSource::ConfluenceSpaceToIndexFieldMappingProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kendra/cfn_data_source.rb

Overview

Maps attributes or field names of Confluence spaces 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.

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) ⇒ ConfluenceSpaceToIndexFieldMappingProperty

Returns a new instance of ConfluenceSpaceToIndexFieldMappingProperty.

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.



1321
1322
1323
1324
1325
1326
1327
1328
 
# File 'kendra/cfn_data_source.rb', line 1321

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.

Returns:

  • (String)

See Also:



1334
1335
1336
 
# File 'kendra/cfn_data_source.rb', line 1334

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:



1348
1349
1350
 
# File 'kendra/cfn_data_source.rb', line 1348

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:



1341
1342
1343
 
# File 'kendra/cfn_data_source.rb', line 1341

def index_field_name
  @index_field_name
end

Class Method Details

.jsii_properties ⇒ Object 



1350
1351
1352
1353
1354
1355
1356
 
# File 'kendra/cfn_data_source.rb', line 1350

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

Instance Method Details

#to_jsii ⇒ Object 



1358
1359
1360
1361
1362
1363
1364
1365
1366
 
# File 'kendra/cfn_data_source.rb', line 1358

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