Class: AWSCDK::Kendra::CfnDataSource::ConfluenceBlogToIndexFieldMappingProperty

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

Overview

Maps attributes or field names of Confluence blog 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) ⇒ ConfluenceBlogToIndexFieldMappingProperty

Returns a new instance of ConfluenceBlogToIndexFieldMappingProperty.

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.



948
949
950
951
952
953
954
955
 
# File 'kendra/cfn_data_source.rb', line 948

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:



961
962
963
 
# File 'kendra/cfn_data_source.rb', line 961

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:



975
976
977
 
# File 'kendra/cfn_data_source.rb', line 975

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:



968
969
970
 
# File 'kendra/cfn_data_source.rb', line 968

def index_field_name
  @index_field_name
end

Class Method Details

.jsii_properties ⇒ Object 



977
978
979
980
981
982
983
 
# File 'kendra/cfn_data_source.rb', line 977

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

Instance Method Details

#to_jsii ⇒ Object 



985
986
987
988
989
990
991
992
993
 
# File 'kendra/cfn_data_source.rb', line 985

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