You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Kendra::Types::SharePointConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SharePointConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  share_point_version: "SHAREPOINT_ONLINE", # required, accepts 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,
}

Provides configuration information for connecting to a Microsoft SharePoint data source.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#crawl_attachments ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#disable_local_groups ⇒ Boolean

A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

Returns:

  • (Boolean) —

    A Boolean value that specifies whether local groups are disabled (True) or enabled (False).

#document_title_field_name ⇒ String

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

Returns:

  • (String) —

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

#exclusion_patterns ⇒ Array<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.

Returns:

  • (Array<String>) —

    A list of regular expression patterns.

#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

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.

Returns:

  • (Array<Types::DataSourceToIndexFieldMapping>) —

    A list of DataSourceToIndexFieldMapping objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index.

#inclusion_patterns ⇒ Array<String>

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.

Returns:

  • (Array<String>) —

    A list of regular expression patterns.

#secret_arn ⇒ 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.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager.

#share_point_version ⇒ String

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

Possible values:

  • SHAREPOINT_ONLINE

Returns:

  • (String) —

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

#urls ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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

#use_change_log ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Set to TRUE to use the Microsoft SharePoint change log to determine the documents that need to be updated in the index.

#vpc_configuration ⇒ Types::DataSourceVpcConfiguration

Provides information for connecting to an Amazon VPC.

Returns: