Class: AWSCDK::Kendra::CfnDataSource::ConfluencePageConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Kendra::CfnDataSource::ConfluencePageConfigurationProperty

Defined in:

kendra/cfn_data_source.rb

Overview

Configuration of the page settings for the Confluence data source.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepageconfiguration.html

Instance Attribute Summary

• #page_field_mappings ⇒ AWSCDK::IResolvable, ... readonly

  Maps attributes or field names of Confluence pages to Amazon Kendra index field names.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(page_field_mappings: nil) ⇒ ConfluencePageConfigurationProperty constructor

  A new instance of ConfluencePageConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(page_field_mappings: nil) ⇒ ConfluencePageConfigurationProperty

Returns a new instance of ConfluencePageConfigurationProperty.

Parameters:

• page_field_mappings (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Kendra::CfnDataSource::ConfluencePageToIndexFieldMappingProperty>, nil) (defaults to: nil) —

  Maps attributes or field names of Confluence pages to Amazon Kendra index field names.

# File 'kendra/cfn_data_source.rb', line 1138

def initialize(page_field_mappings: nil)
  @page_field_mappings = page_field_mappings
  Jsii::Type.check_type(@page_field_mappings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2VuZHJhLkNmbkRhdGFTb3VyY2UuQ29uZmx1ZW5jZVBhZ2VUb0luZGV4RmllbGRNYXBwaW5nUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "pageFieldMappings") unless @page_field_mappings.nil?
end

Instance Attribute Details

#page_field_mappings ⇒ AWSCDK::IResolvable, ... (readonly)

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

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

Returns:

• (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::Kendra::CfnDataSource::ConfluencePageToIndexFieldMappingProperty>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-confluencepageconfiguration.html#cfn-kendra-datasource-confluencepageconfiguration-pagefieldmappings

# File 'kendra/cfn_data_source.rb', line 1151

def page_field_mappings
  @page_field_mappings
end

Class Method Details

.jsii_properties ⇒ Object

# File 'kendra/cfn_data_source.rb', line 1153

def self.jsii_properties
  {
    :page_field_mappings => "pageFieldMappings",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'kendra/cfn_data_source.rb', line 1159

def to_jsii
  result = {}
  result.merge!({
    "pageFieldMappings" => @page_field_mappings,
  })
  result.compact
end