Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data AlfrescoConfiguration = AlfrescoConfiguration' {
- blogFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- crawlComments :: Maybe Bool
- crawlSystemFolders :: Maybe Bool
- documentLibraryFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- entityFilter :: Maybe (NonEmpty AlfrescoEntity)
- exclusionPatterns :: Maybe [Text]
- inclusionPatterns :: Maybe [Text]
- vpcConfiguration :: Maybe DataSourceVpcConfiguration
- wikiFieldMappings :: Maybe (NonEmpty DataSourceToIndexFieldMapping)
- siteUrl :: Text
- siteId :: Text
- secretArn :: Text
- sslCertificateS3Path :: S3Path
- newAlfrescoConfiguration :: Text -> Text -> Text -> S3Path -> AlfrescoConfiguration
- alfrescoConfiguration_blogFieldMappings :: Lens' AlfrescoConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
- alfrescoConfiguration_crawlComments :: Lens' AlfrescoConfiguration (Maybe Bool)
- alfrescoConfiguration_crawlSystemFolders :: Lens' AlfrescoConfiguration (Maybe Bool)
- alfrescoConfiguration_documentLibraryFieldMappings :: Lens' AlfrescoConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
- alfrescoConfiguration_entityFilter :: Lens' AlfrescoConfiguration (Maybe (NonEmpty AlfrescoEntity))
- alfrescoConfiguration_exclusionPatterns :: Lens' AlfrescoConfiguration (Maybe [Text])
- alfrescoConfiguration_inclusionPatterns :: Lens' AlfrescoConfiguration (Maybe [Text])
- alfrescoConfiguration_vpcConfiguration :: Lens' AlfrescoConfiguration (Maybe DataSourceVpcConfiguration)
- alfrescoConfiguration_wikiFieldMappings :: Lens' AlfrescoConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping))
- alfrescoConfiguration_siteUrl :: Lens' AlfrescoConfiguration Text
- alfrescoConfiguration_siteId :: Lens' AlfrescoConfiguration Text
- alfrescoConfiguration_secretArn :: Lens' AlfrescoConfiguration Text
- alfrescoConfiguration_sslCertificateS3Path :: Lens' AlfrescoConfiguration S3Path
Documentation
data AlfrescoConfiguration Source #
Provides the configuration information to connect to Alfresco as your data source.
Alfresco data source connector is currently in preview mode. Basic authentication is currently supported. If you would like to use Alfresco connector in production, contact Support.
See: newAlfrescoConfiguration
smart constructor.
AlfrescoConfiguration' | |
|
Instances
newAlfrescoConfiguration Source #
:: Text | |
-> Text | |
-> Text | |
-> S3Path | |
-> AlfrescoConfiguration |
Create a value of AlfrescoConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:blogFieldMappings:AlfrescoConfiguration'
, alfrescoConfiguration_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 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.
$sel:crawlComments:AlfrescoConfiguration'
, alfrescoConfiguration_crawlComments
- TRUE
to index comments of blogs and other content.
$sel:crawlSystemFolders:AlfrescoConfiguration'
, alfrescoConfiguration_crawlSystemFolders
- TRUE
to index shared files.
$sel:documentLibraryFieldMappings:AlfrescoConfiguration'
, alfrescoConfiguration_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 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.
$sel:entityFilter:AlfrescoConfiguration'
, alfrescoConfiguration_entityFilter
- Specify whether to index document libraries, wikis, or blogs. You can
specify one or more of these options.
$sel:exclusionPatterns:AlfrescoConfiguration'
, alfrescoConfiguration_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.
$sel:inclusionPatterns:AlfrescoConfiguration'
, alfrescoConfiguration_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.
$sel:vpcConfiguration:AlfrescoConfiguration'
, alfrescoConfiguration_vpcConfiguration
- Configuration information for an Amazon Virtual Private Cloud to connect
to your Alfresco. For more information, see
Configuring a VPC.
$sel:wikiFieldMappings:AlfrescoConfiguration'
, alfrescoConfiguration_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 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.
$sel:siteUrl:AlfrescoConfiguration'
, alfrescoConfiguration_siteUrl
- The URL of the Alfresco site. For example, https://hostname:8080.
$sel:siteId:AlfrescoConfiguration'
, alfrescoConfiguration_siteId
- The identifier of the Alfresco site. For example, my-site.
$sel:secretArn:AlfrescoConfiguration'
, alfrescoConfiguration_secretArn
- 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.
$sel:sslCertificateS3Path:AlfrescoConfiguration'
, alfrescoConfiguration_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.
alfrescoConfiguration_blogFieldMappings :: Lens' AlfrescoConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #
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.
alfrescoConfiguration_crawlComments :: Lens' AlfrescoConfiguration (Maybe Bool) Source #
TRUE
to index comments of blogs and other content.
alfrescoConfiguration_crawlSystemFolders :: Lens' AlfrescoConfiguration (Maybe Bool) Source #
TRUE
to index shared files.
alfrescoConfiguration_documentLibraryFieldMappings :: Lens' AlfrescoConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #
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.
alfrescoConfiguration_entityFilter :: Lens' AlfrescoConfiguration (Maybe (NonEmpty AlfrescoEntity)) Source #
Specify whether to index document libraries, wikis, or blogs. You can specify one or more of these options.
alfrescoConfiguration_exclusionPatterns :: Lens' AlfrescoConfiguration (Maybe [Text]) Source #
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.
alfrescoConfiguration_inclusionPatterns :: Lens' AlfrescoConfiguration (Maybe [Text]) Source #
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.
alfrescoConfiguration_vpcConfiguration :: Lens' AlfrescoConfiguration (Maybe DataSourceVpcConfiguration) Source #
Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco. For more information, see Configuring a VPC.
alfrescoConfiguration_wikiFieldMappings :: Lens' AlfrescoConfiguration (Maybe (NonEmpty DataSourceToIndexFieldMapping)) Source #
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.
alfrescoConfiguration_siteUrl :: Lens' AlfrescoConfiguration Text Source #
The URL of the Alfresco site. For example, https://hostname:8080.
alfrescoConfiguration_siteId :: Lens' AlfrescoConfiguration Text Source #
The identifier of the Alfresco site. For example, my-site.
alfrescoConfiguration_secretArn :: Lens' AlfrescoConfiguration Text Source #
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.
alfrescoConfiguration_sslCertificateS3Path :: Lens' AlfrescoConfiguration S3Path Source #
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.