Class: Aws::Kendra::Types::AlfrescoConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Provides the configuration information to connect to Alfresco as your data source.

<note markdown=“1”> Support for ‘AlfrescoConfiguration` ended May 2023. We recommend migrating to or using the Alfresco data source template schema /

TemplateConfiguration][1

API.

</note>

[1]: docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#blog_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Alfresco blogs to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Alfresco fields. For more information, see [ Mapping data source fields]. The Alfresco data source field names must exist in your Alfresco custom metadata.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aws-sdk-kendra/types.rb', line 247

class AlfrescoConfiguration < Struct.new(
  :site_url,
  :site_id,
  :secret_arn,
  :ssl_certificate_s3_path,
  :crawl_system_folders,
  :crawl_comments,
  :entity_filter,
  :document_library_field_mappings,
  :blog_field_mappings,
  :wiki_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_comments ⇒ Boolean

‘TRUE` to index comments of blogs and other content.

Returns:

  • (Boolean) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aws-sdk-kendra/types.rb', line 247

class AlfrescoConfiguration < Struct.new(
  :site_url,
  :site_id,
  :secret_arn,
  :ssl_certificate_s3_path,
  :crawl_system_folders,
  :crawl_comments,
  :entity_filter,
  :document_library_field_mappings,
  :blog_field_mappings,
  :wiki_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_system_folders ⇒ Boolean

‘TRUE` to index shared files.

Returns:

  • (Boolean) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aws-sdk-kendra/types.rb', line 247

class AlfrescoConfiguration < Struct.new(
  :site_url,
  :site_id,
  :secret_arn,
  :ssl_certificate_s3_path,
  :crawl_system_folders,
  :crawl_comments,
  :entity_filter,
  :document_library_field_mappings,
  :blog_field_mappings,
  :wiki_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#document_library_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Alfresco document libraries to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Alfresco fields. For more information, see [ Mapping data source fields]. The Alfresco data source field names must exist in your Alfresco custom metadata.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aws-sdk-kendra/types.rb', line 247

class AlfrescoConfiguration < Struct.new(
  :site_url,
  :site_id,
  :secret_arn,
  :ssl_certificate_s3_path,
  :crawl_system_folders,
  :crawl_comments,
  :entity_filter,
  :document_library_field_mappings,
  :blog_field_mappings,
  :wiki_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#entity_filter ⇒ Array<String>

Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.

Returns:

  • (Array<String>) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aws-sdk-kendra/types.rb', line 247

class AlfrescoConfiguration < Struct.new(
  :site_url,
  :site_id,
  :secret_arn,
  :ssl_certificate_s3_path,
  :crawl_system_folders,
  :crawl_comments,
  :entity_filter,
  :document_library_field_mappings,
  :blog_field_mappings,
  :wiki_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_patterns ⇒ Array<String>

A list of regular expression patterns to exclude certain files in your Alfresco data source. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.

Returns:

  • (Array<String>) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aws-sdk-kendra/types.rb', line 247

class AlfrescoConfiguration < Struct.new(
  :site_url,
  :site_id,
  :secret_arn,
  :ssl_certificate_s3_path,
  :crawl_system_folders,
  :crawl_comments,
  :entity_filter,
  :document_library_field_mappings,
  :blog_field_mappings,
  :wiki_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patterns ⇒ Array<String>

A list of regular expression patterns to include certain files in your Alfresco data source. Files that match the patterns are included in the index. Files that don’t match the patterns are excluded from the index. If a file matches both an inclusion pattern and an exclusion pattern, the exclusion pattern takes precedence and the file isn’t included in the index.

Returns:

  • (Array<String>) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aws-sdk-kendra/types.rb', line 247

class AlfrescoConfiguration < Struct.new(
  :site_url,
  :site_id,
  :secret_arn,
  :ssl_certificate_s3_path,
  :crawl_system_folders,
  :crawl_comments,
  :entity_filter,
  :document_library_field_mappings,
  :blog_field_mappings,
  :wiki_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs required to connect to your Alfresco data source. The secret must contain a JSON structure with the following keys:

  • username—The user name of the Alfresco account.

  • password—The password of the Alfresco account.

Returns:

  • (String) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aws-sdk-kendra/types.rb', line 247

class AlfrescoConfiguration < Struct.new(
  :site_url,
  :site_id,
  :secret_arn,
  :ssl_certificate_s3_path,
  :crawl_system_folders,
  :crawl_comments,
  :entity_filter,
  :document_library_field_mappings,
  :blog_field_mappings,
  :wiki_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#site_id ⇒ String

The identifier of the Alfresco site. For example, my-site.

Returns:

  • (String) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aws-sdk-kendra/types.rb', line 247

class AlfrescoConfiguration < Struct.new(
  :site_url,
  :site_id,
  :secret_arn,
  :ssl_certificate_s3_path,
  :crawl_system_folders,
  :crawl_comments,
  :entity_filter,
  :document_library_field_mappings,
  :blog_field_mappings,
  :wiki_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#site_url ⇒ String

The URL of the Alfresco site. For example, https://hostname:8080.

Returns:

  • (String) 


247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aws-sdk-kendra/types.rb', line 247

class AlfrescoConfiguration < Struct.new(
  :site_url,
  :site_id,
  :secret_arn,
  :ssl_certificate_s3_path,
  :crawl_system_folders,
  :crawl_comments,
  :entity_filter,
  :document_library_field_mappings,
  :blog_field_mappings,
  :wiki_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ssl_certificate_s3_path ⇒ Types::S3Path

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to Alfresco if you require a secure SSL connection.

You can simply generate a self-signed X509 certificate on any computer using OpenSSL. For an example of using OpenSSL to create an X509 certificate, see [Create and sign an X509 certificate].

[1]: docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html

Returns:



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aws-sdk-kendra/types.rb', line 247

class AlfrescoConfiguration < Struct.new(
  :site_url,
  :site_id,
  :secret_arn,
  :ssl_certificate_s3_path,
  :crawl_system_folders,
  :crawl_comments,
  :entity_filter,
  :document_library_field_mappings,
  :blog_field_mappings,
  :wiki_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configuration ⇒ Types::DataSourceVpcConfiguration

Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see [Configuring a VPC].

[1]: docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html

Returns:



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aws-sdk-kendra/types.rb', line 247

class AlfrescoConfiguration < Struct.new(
  :site_url,
  :site_id,
  :secret_arn,
  :ssl_certificate_s3_path,
  :crawl_system_folders,
  :crawl_comments,
  :entity_filter,
  :document_library_field_mappings,
  :blog_field_mappings,
  :wiki_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#wiki_field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of ‘DataSourceToIndexFieldMapping` objects that map attributes or field names of Alfresco wikis to Amazon Kendra index field names. To create custom fields, use the `UpdateIndex` API before you map to Alfresco fields. For more information, see [ Mapping data source fields]. The Alfresco data source field names must exist in your Alfresco custom metadata.

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html

Returns:



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aws-sdk-kendra/types.rb', line 247

class AlfrescoConfiguration < Struct.new(
  :site_url,
  :site_id,
  :secret_arn,
  :ssl_certificate_s3_path,
  :crawl_system_folders,
  :crawl_comments,
  :entity_filter,
  :document_library_field_mappings,
  :blog_field_mappings,
  :wiki_field_mappings,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration)
  SENSITIVE = []
  include Aws::Structure
end