class Aws::Kendra::Types::SharePointConfiguration
Provides configuration information for connecting to a Microsoft SharePoint data source.
@note When making an API call, you may pass SharePointConfiguration
data as a hash: { share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE urls: ["Url"], # required secret_arn: "SecretArn", # required crawl_attachments: false, use_change_log: false, inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"], vpc_configuration: { subnet_ids: ["SubnetId"], # required security_group_ids: ["VpcSecurityGroupId"], # required }, field_mappings: [ { data_source_field_name: "DataSourceFieldName", # required date_field_format: "DataSourceDateFieldFormat", index_field_name: "IndexFieldName", # required }, ], document_title_field_name: "DataSourceFieldName", disable_local_groups: false, ssl_certificate_s3_path: { bucket: "S3BucketName", # required key: "S3ObjectKey", # required }, }
@!attribute [rw] share_point_version
The version of Microsoft SharePoint that you are using as a data source. @return [String]
@!attribute [rw] urls
The URLs of the Microsoft SharePoint site that contains the documents that should be indexed. @return [Array<String>]
@!attribute [rw] secret_arn
The Amazon Resource Name (ARN) of credentials stored in Secrets Manager. The credentials should be a user/password pair. If you use SharePoint Server, you also need to provide the sever domain name as part of the credentials. For more information, see [Using a Microsoft SharePoint Data Source][1]. For more information about Secrets Manager, see [ What Is Secrets Manager][2] in the <i>Secrets Manager </i> user guide. [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html [2]: https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html @return [String]
@!attribute [rw] crawl_attachments
`TRUE` to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, `FALSE`. @return [Boolean]
@!attribute [rw] use_change_log
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. @return [Boolean]
@!attribute [rw] inclusion_patterns
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. @return [Array<String>]
@!attribute [rw] exclusion_patterns
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. @return [Array<String>]
@!attribute [rw] vpc_configuration
Provides information for connecting to an Amazon VPC. @return [Types::DataSourceVpcConfiguration]
@!attribute [rw] field_mappings
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 `UpdateIndex` operation before you map SharePoint attributes. For more information, see [Mapping Data Source Fields][1]. [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html @return [Array<Types::DataSourceToIndexFieldMapping>]
@!attribute [rw] document_title_field_name
The Microsoft SharePoint attribute field that contains the title of the document. @return [String]
@!attribute [rw] disable_local_groups
A Boolean value that specifies whether local groups are disabled (`True`) or enabled (`False`). @return [Boolean]
@!attribute [rw] ssl_certificate_s3_path
Information required to find a specific file in an Amazon S3 bucket. @return [Types::S3Path]
@see docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SharePointConfiguration AWS API Documentation
Constants
- SENSITIVE