Struct AlfrescoConfiguration 

#[non_exhaustive]
pub struct AlfrescoConfiguration {

    pub site_url: String,
    pub site_id: String,
    pub secret_arn: String,
    pub ssl_certificate_s3_path: Option<S3Path>,
    pub crawl_system_folders: bool,
    pub crawl_comments: bool,
    pub entity_filter: Option<Vec<AlfrescoEntity>>,
    pub document_library_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
    pub blog_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
    pub wiki_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
    pub inclusion_patterns: Option<Vec<String>>,
    pub exclusion_patterns: Option<Vec<String>>,
    pub vpc_configuration: Option<DataSourceVpcConfiguration>,
}

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

Support for AlfrescoConfiguration ended May 2023. We recommend migrating to or using the Alfresco data source template schema / TemplateConfiguration API.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

site_url: String

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

site_id: String

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

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.

ssl_certificate_s3_path: Option<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.

crawl_system_folders: bool

TRUE to index shared files.

crawl_comments: bool

TRUE to index comments of blogs and other content.

entity_filter: Option<Vec<AlfrescoEntity>>

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

document_library_field_mappings: Option<Vec<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.

blog_field_mappings: Option<Vec<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.

wiki_field_mappings: Option<Vec<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.

inclusion_patterns: Option<Vec<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.

exclusion_patterns: Option<Vec<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.

vpc_configuration: Option<DataSourceVpcConfiguration>

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

Implementations

impl AlfrescoConfiguration

pub fn site_url(&self) -> &str

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

pub fn site_id(&self) -> &str

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

pub fn secret_arn(&self) -> &str

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.

pub fn ssl_certificate_s3_path(&self) -> Option<&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.

pub fn crawl_system_folders(&self) -> bool

TRUE to index shared files.

pub fn crawl_comments(&self) -> bool

TRUE to index comments of blogs and other content.

pub fn entity_filter(&self) -> &[AlfrescoEntity]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .entity_filter.is_none().

pub fn document_library_field_mappings( &self, ) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .document_library_field_mappings.is_none().

pub fn blog_field_mappings(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .blog_field_mappings.is_none().

pub fn wiki_field_mappings(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .wiki_field_mappings.is_none().

pub fn inclusion_patterns(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .inclusion_patterns.is_none().

pub fn exclusion_patterns(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .exclusion_patterns.is_none().

pub fn vpc_configuration(&self) -> Option<&DataSourceVpcConfiguration>

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

impl AlfrescoConfiguration

pub fn builder() -> AlfrescoConfigurationBuilder

Creates a new builder-style object to manufacture AlfrescoConfiguration.

Trait Implementations

impl Clone for AlfrescoConfiguration

fn clone(&self) -> AlfrescoConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AlfrescoConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for AlfrescoConfiguration

fn eq(&self, other: &AlfrescoConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for AlfrescoConfiguration