SharePointConfiguration

public struct SharePointConfiguration : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

  • TRUE to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE.

    Declaration

    Swift

    public let crawlAttachments: Bool?

  • The Microsoft SharePoint attribute field that contains the title of the document.

    Declaration

    Swift

    public let documentTitleFieldName: String?

  • A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don’t match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index. The regex is applied to the display URL of the SharePoint document.

    Declaration

    Swift

    public let exclusionPatterns: [String]?

  • A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.

    Declaration

    Swift

    public let fieldMappings: [DataSourceToIndexFieldMapping]?

  • A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don’t match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index. The regex is applied to the display URL of the SharePoint document.

    Declaration

    Swift

    public let inclusionPatterns: [String]?

  • The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.

    Declaration

    Swift

    public let secretArn: String

  • The version of Microsoft SharePoint that you are using as a data source.

    Declaration

    Swift

    public let sharePointVersion: SharePointVersion

  • The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.

    Declaration

    Swift

    public let urls: [String]

  • Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index. Depending on the size of the SharePoint change log, it may take longer for Amazon Kendra to use the change log than it takes it to determine the changed documents using the Amazon Kendra document crawler.

    Declaration

    Swift

    public let useChangeLog: Bool?

  • Undocumented

    Declaration

    Swift

    public let vpcConfiguration: DataSourceVpcConfiguration?

  • Undocumented

    Declaration

    Swift

    public init(crawlAttachments: Bool? = nil, documentTitleFieldName: String? = nil, exclusionPatterns: [String]? = nil, fieldMappings: [DataSourceToIndexFieldMapping]? = nil, inclusionPatterns: [String]? = nil, secretArn: String, sharePointVersion: SharePointVersion, urls: [String], useChangeLog: Bool? = nil, vpcConfiguration: DataSourceVpcConfiguration? = nil)

  • Declaration

    Swift

    public func validate(name: String) throws