Class: AWSCDK::Kendra::CfnDataSource::ConfluenceSpaceConfigurationProperty

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

Overview

Configuration information for indexing Confluence spaces.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(crawl_archived_spaces: nil, crawl_personal_spaces: nil, exclude_spaces: nil, include_spaces: nil, space_field_mappings: nil) ⇒ ConfluenceSpaceConfigurationProperty

Returns a new instance of ConfluenceSpaceConfigurationProperty.

Parameters:



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
 
# File 'kendra/cfn_data_source.rb', line 1238

def initialize(crawl_archived_spaces: nil, crawl_personal_spaces: nil, exclude_spaces: nil, include_spaces: nil, space_field_mappings: nil)
  @crawl_archived_spaces = crawl_archived_spaces
  Jsii::Type.check_type(@crawl_archived_spaces, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "crawlArchivedSpaces") unless @crawl_archived_spaces.nil?
  @crawl_personal_spaces = crawl_personal_spaces
  Jsii::Type.check_type(@crawl_personal_spaces, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "crawlPersonalSpaces") unless @crawl_personal_spaces.nil?
  @exclude_spaces = exclude_spaces
  Jsii::Type.check_type(@exclude_spaces, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "excludeSpaces") unless @exclude_spaces.nil?
  @include_spaces = include_spaces
  Jsii::Type.check_type(@include_spaces, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "includeSpaces") unless @include_spaces.nil?
  @space_field_mappings = space_field_mappings
  Jsii::Type.check_type(@space_field_mappings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2VuZHJhLkNmbkRhdGFTb3VyY2UuQ29uZmx1ZW5jZVNwYWNlVG9JbmRleEZpZWxkTWFwcGluZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "spaceFieldMappings") unless @space_field_mappings.nil?
end

Instance Attribute Details

#crawl_archived_spaces ⇒ Boolean, ... (readonly)

TRUE to index archived spaces.

Returns:

See Also:



1255
1256
1257
 
# File 'kendra/cfn_data_source.rb', line 1255

def crawl_archived_spaces
  @crawl_archived_spaces
end

#crawl_personal_spaces ⇒ Boolean, ... (readonly)

TRUE to index personal spaces.

You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context .

Returns:

See Also:



1262
1263
1264
 
# File 'kendra/cfn_data_source.rb', line 1262

def crawl_personal_spaces
  @crawl_personal_spaces
end

#exclude_spaces ⇒ Array<String>? (readonly)

A list of space keys of Confluence spaces.

If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.

Returns:

  • (Array<String>, nil)

See Also:



1269
1270
1271
 
# File 'kendra/cfn_data_source.rb', line 1269

def exclude_spaces
  @exclude_spaces
end

#include_spaces ⇒ Array<String>? (readonly)

A list of space keys for Confluence spaces.

If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.

Returns:

  • (Array<String>, nil)

See Also:



1276
1277
1278
 
# File 'kendra/cfn_data_source.rb', line 1276

def include_spaces
  @include_spaces
end

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

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.

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

Returns:

See Also:



1285
1286
1287
 
# File 'kendra/cfn_data_source.rb', line 1285

def space_field_mappings
  @space_field_mappings
end

Class Method Details

.jsii_properties ⇒ Object 



1287
1288
1289
1290
1291
1292
1293
1294
1295
 
# File 'kendra/cfn_data_source.rb', line 1287

def self.jsii_properties
  {
    :crawl_archived_spaces => "crawlArchivedSpaces",
    :crawl_personal_spaces => "crawlPersonalSpaces",
    :exclude_spaces => "excludeSpaces",
    :include_spaces => "includeSpaces",
    :space_field_mappings => "spaceFieldMappings",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
 
# File 'kendra/cfn_data_source.rb', line 1297

def to_jsii
  result = {}
  result.merge!({
    "crawlArchivedSpaces" => @crawl_archived_spaces,
    "crawlPersonalSpaces" => @crawl_personal_spaces,
    "excludeSpaces" => @exclude_spaces,
    "includeSpaces" => @include_spaces,
    "spaceFieldMappings" => @space_field_mappings,
  })
  result.compact
end