AlfrescoConfiguration
Provides the configuration information to connect to Alfresco as your data source.
Note
Support for AlfrescoConfiguration
ended May 2023.
We recommend migrating to or using the Alfresco data source template
schema / TemplateConfiguration API.
Contents
- SecretArn
-
The Amazon Resource Name (ARN) of an AWS 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1284.
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
Required: Yes
-
- SiteId
-
The identifier of the Alfresco site. For example, my-site.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[A-Za-z0-9-]+$
Required: Yes
- SiteUrl
-
The URL of the Alfresco site. For example, https://hostname:8080.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Pattern:
^https:\/\/[a-zA-Z0-9_\-\.]+$
Required: Yes
- SslCertificateS3Path
-
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.
Type: S3Path object
Required: Yes
- BlogFieldMappings
-
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 theUpdateIndex
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.Type: Array of DataSourceToIndexFieldMapping objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
- CrawlComments
-
TRUE
to index comments of blogs and other content.Type: Boolean
Required: No
- CrawlSystemFolders
-
TRUE
to index shared files.Type: Boolean
Required: No
- DocumentLibraryFieldMappings
-
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 theUpdateIndex
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.Type: Array of DataSourceToIndexFieldMapping objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
- EntityFilter
-
Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 3 items.
Valid Values:
wiki | blog | documentLibrary
Required: No
- ExclusionPatterns
-
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.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
- InclusionPatterns
-
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.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 250 items.
Length Constraints: Minimum length of 1. Maximum length of 300.
Required: No
- VpcConfiguration
-
Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.
Type: DataSourceVpcConfiguration object
Required: No
- WikiFieldMappings
-
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 theUpdateIndex
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.Type: Array of DataSourceToIndexFieldMapping objects
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: