/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 * 
 *  http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */

/*
 * Do not modify this file. This file is generated from the kendra-2019-02-03.normal.json service model.
 */
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;

using Amazon.Runtime;
using Amazon.Runtime.Internal;

namespace Amazon.Kendra.Model
{
    /// <summary>
    /// Provides the configuration information to connect to Alfresco as your data source.
    /// 
    ///  <note> 
    /// <para>
    /// Support for <code>AlfrescoConfiguration</code> ended May 2023. We recommend migrating
    /// to or using the Alfresco data source template schema / <a href="https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html">TemplateConfiguration</a>
    /// API.
    /// </para>
    ///  </note>
    /// </summary>
    public partial class AlfrescoConfiguration
    {
        private List<DataSourceToIndexFieldMapping> _blogFieldMappings = new List<DataSourceToIndexFieldMapping>();
        private bool? _crawlComments;
        private bool? _crawlSystemFolders;
        private List<DataSourceToIndexFieldMapping> _documentLibraryFieldMappings = new List<DataSourceToIndexFieldMapping>();
        private List<string> _entityFilter = new List<string>();
        private List<string> _exclusionPatterns = new List<string>();
        private List<string> _inclusionPatterns = new List<string>();
        private string _secretArn;
        private string _siteId;
        private string _siteUrl;
        private S3Path _sslCertificateS3Path;
        private DataSourceVpcConfiguration _vpcConfiguration;
        private List<DataSourceToIndexFieldMapping> _wikiFieldMappings = new List<DataSourceToIndexFieldMapping>();

        /// <summary>
        /// Gets and sets the property BlogFieldMappings. 
        /// <para>
        /// A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
        /// field names of Alfresco blogs to Amazon Kendra index field names. To create custom
        /// fields, use the <code>UpdateIndex</code> API before you map to Alfresco fields. For
        /// more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">
        /// Mapping data source fields</a>. The Alfresco data source field names must exist in
        /// your Alfresco custom metadata.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=100)]
        public List<DataSourceToIndexFieldMapping> BlogFieldMappings
        {
            get { return this._blogFieldMappings; }
            set { this._blogFieldMappings = value; }
        }

        // Check to see if BlogFieldMappings property is set
        internal bool IsSetBlogFieldMappings()
        {
            return this._blogFieldMappings != null && this._blogFieldMappings.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property CrawlComments. 
        /// <para>
        ///  <code>TRUE</code> to index comments of blogs and other content.
        /// </para>
        /// </summary>
        public bool CrawlComments
        {
            get { return this._crawlComments.GetValueOrDefault(); }
            set { this._crawlComments = value; }
        }

        // Check to see if CrawlComments property is set
        internal bool IsSetCrawlComments()
        {
            return this._crawlComments.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property CrawlSystemFolders. 
        /// <para>
        ///  <code>TRUE</code> to index shared files.
        /// </para>
        /// </summary>
        public bool CrawlSystemFolders
        {
            get { return this._crawlSystemFolders.GetValueOrDefault(); }
            set { this._crawlSystemFolders = value; }
        }

        // Check to see if CrawlSystemFolders property is set
        internal bool IsSetCrawlSystemFolders()
        {
            return this._crawlSystemFolders.HasValue; 
        }

        /// <summary>
        /// Gets and sets the property DocumentLibraryFieldMappings. 
        /// <para>
        /// A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
        /// field names of Alfresco document libraries to Amazon Kendra index field names. To
        /// create custom fields, use the <code>UpdateIndex</code> API before you map to Alfresco
        /// fields. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">
        /// Mapping data source fields</a>. The Alfresco data source field names must exist in
        /// your Alfresco custom metadata.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=100)]
        public List<DataSourceToIndexFieldMapping> DocumentLibraryFieldMappings
        {
            get { return this._documentLibraryFieldMappings; }
            set { this._documentLibraryFieldMappings = value; }
        }

        // Check to see if DocumentLibraryFieldMappings property is set
        internal bool IsSetDocumentLibraryFieldMappings()
        {
            return this._documentLibraryFieldMappings != null && this._documentLibraryFieldMappings.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property EntityFilter. 
        /// <para>
        /// Specify whether to index document libraries, wikis, or blogs. You can specify one
        /// or more of these options.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=3)]
        public List<string> EntityFilter
        {
            get { return this._entityFilter; }
            set { this._entityFilter = value; }
        }

        // Check to see if EntityFilter property is set
        internal bool IsSetEntityFilter()
        {
            return this._entityFilter != null && this._entityFilter.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property ExclusionPatterns. 
        /// <para>
        /// 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.
        /// </para>
        /// </summary>
        [AWSProperty(Min=0, Max=250)]
        public List<string> ExclusionPatterns
        {
            get { return this._exclusionPatterns; }
            set { this._exclusionPatterns = value; }
        }

        // Check to see if ExclusionPatterns property is set
        internal bool IsSetExclusionPatterns()
        {
            return this._exclusionPatterns != null && this._exclusionPatterns.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property InclusionPatterns. 
        /// <para>
        /// 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.
        /// </para>
        /// </summary>
        [AWSProperty(Min=0, Max=250)]
        public List<string> InclusionPatterns
        {
            get { return this._inclusionPatterns; }
            set { this._inclusionPatterns = value; }
        }

        // Check to see if InclusionPatterns property is set
        internal bool IsSetInclusionPatterns()
        {
            return this._inclusionPatterns != null && this._inclusionPatterns.Count > 0; 
        }

        /// <summary>
        /// Gets and sets the property SecretArn. 
        /// <para>
        /// 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:
        /// </para>
        ///  <ul> <li> 
        /// <para>
        /// username—The user name of the Alfresco account.
        /// </para>
        ///  </li> <li> 
        /// <para>
        /// password—The password of the Alfresco account.
        /// </para>
        ///  </li> </ul>
        /// </summary>
        [AWSProperty(Required=true, Min=1, Max=1284)]
        public string SecretArn
        {
            get { return this._secretArn; }
            set { this._secretArn = value; }
        }

        // Check to see if SecretArn property is set
        internal bool IsSetSecretArn()
        {
            return this._secretArn != null;
        }

        /// <summary>
        /// Gets and sets the property SiteId. 
        /// <para>
        /// The identifier of the Alfresco site. For example, <i>my-site</i>.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true, Min=1, Max=128)]
        public string SiteId
        {
            get { return this._siteId; }
            set { this._siteId = value; }
        }

        // Check to see if SiteId property is set
        internal bool IsSetSiteId()
        {
            return this._siteId != null;
        }

        /// <summary>
        /// Gets and sets the property SiteUrl. 
        /// <para>
        /// The URL of the Alfresco site. For example, <i>https://hostname:8080</i>.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true, Min=1, Max=2048)]
        public string SiteUrl
        {
            get { return this._siteUrl; }
            set { this._siteUrl = value; }
        }

        // Check to see if SiteUrl property is set
        internal bool IsSetSiteUrl()
        {
            return this._siteUrl != null;
        }

        /// <summary>
        /// Gets and sets the property SslCertificateS3Path. 
        /// <para>
        /// 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.
        /// </para>
        ///  
        /// <para>
        /// 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 <a href="https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html">Create
        /// and sign an X509 certificate</a>.
        /// </para>
        /// </summary>
        [AWSProperty(Required=true)]
        public S3Path SslCertificateS3Path
        {
            get { return this._sslCertificateS3Path; }
            set { this._sslCertificateS3Path = value; }
        }

        // Check to see if SslCertificateS3Path property is set
        internal bool IsSetSslCertificateS3Path()
        {
            return this._sslCertificateS3Path != null;
        }

        /// <summary>
        /// Gets and sets the property VpcConfiguration. 
        /// <para>
        /// Configuration information for an Amazon Virtual Private Cloud to connect to your Alfresco.
        /// For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring
        /// a VPC</a>.
        /// </para>
        /// </summary>
        public DataSourceVpcConfiguration VpcConfiguration
        {
            get { return this._vpcConfiguration; }
            set { this._vpcConfiguration = value; }
        }

        // Check to see if VpcConfiguration property is set
        internal bool IsSetVpcConfiguration()
        {
            return this._vpcConfiguration != null;
        }

        /// <summary>
        /// Gets and sets the property WikiFieldMappings. 
        /// <para>
        /// A list of <code>DataSourceToIndexFieldMapping</code> objects that map attributes or
        /// field names of Alfresco wikis to Amazon Kendra index field names. To create custom
        /// fields, use the <code>UpdateIndex</code> API before you map to Alfresco fields. For
        /// more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">
        /// Mapping data source fields</a>. The Alfresco data source field names must exist in
        /// your Alfresco custom metadata.
        /// </para>
        /// </summary>
        [AWSProperty(Min=1, Max=100)]
        public List<DataSourceToIndexFieldMapping> WikiFieldMappings
        {
            get { return this._wikiFieldMappings; }
            set { this._wikiFieldMappings = value; }
        }

        // Check to see if WikiFieldMappings property is set
        internal bool IsSetWikiFieldMappings()
        {
            return this._wikiFieldMappings != null && this._wikiFieldMappings.Count > 0; 
        }

    }
}