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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::SharePointConfiguration

Defined in:

gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Provides the configuration information to connect to Microsoft SharePoint as your data source.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #authentication_type ⇒ String

  Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.

• #crawl_attachments ⇒ Boolean

  TRUE to index document attachments.

• #disable_local_groups ⇒ Boolean

  TRUE to disable local groups information.

• #document_title_field_name ⇒ String

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

• #exclusion_patterns ⇒ Array<String>

  A list of regular expression patterns to exclude certain documents in your SharePoint.

• #field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names.

• #inclusion_patterns ⇒ Array<String>

  A list of regular expression patterns to include certain documents in your SharePoint.

• #proxy_configuration ⇒ Types::ProxyConfiguration

  Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy.

• #secret_arn ⇒ String

  The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance.

• #share_point_version ⇒ String

  The version of Microsoft SharePoint that you use.

• #ssl_certificate_s3_path ⇒ Types::S3Path

  The path to the SSL certificate stored in an Amazon S3 bucket.

• #urls ⇒ Array<String>

  The Microsoft SharePoint site URLs for the documents you want to index.

• #use_change_log ⇒ Boolean

  TRUE to use the SharePoint change log to determine which documents require updating in the index.

• #vpc_configuration ⇒ Types::DataSourceVpcConfiguration

  Configuration information for an Amazon Virtual Private Cloud to connect to your Microsoft SharePoint.

Instance Attribute Details

#authentication_type ⇒ String

Whether you want to connect to SharePoint Online using basic authentication of user name and password, or OAuth authentication of user name, password, client ID, and client secret, or AD App-only authentication of client secret.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#crawl_attachments ⇒ Boolean

TRUE to index document attachments.

Returns:

• (Boolean)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#disable_local_groups ⇒ Boolean

TRUE to disable local groups information.

Returns:

• (Boolean)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#document_title_field_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_patterns ⇒ Array<String>

A list of regular expression patterns to exclude certain documents in your SharePoint. 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 inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The regex applies to the display URL of the SharePoint document.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

A list of DataSourceToIndexFieldMapping objects that map SharePoint data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to SharePoint fields. For more information, see Mapping data source fields. The SharePoint data source field names must exist in your SharePoint custom metadata.

Returns:

• (Array<Types::DataSourceToIndexFieldMapping>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patterns ⇒ Array<String>

A list of regular expression patterns to include certain documents in your SharePoint. 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 and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

The regex applies to the display URL of the SharePoint document.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#proxy_configuration ⇒ Types::ProxyConfiguration

Configuration information to connect to your Microsoft SharePoint site URLs via instance via a web proxy. You can use this option for SharePoint Server.

You must provide the website host name and port number. For example, the host name of *https://a.example.com/page1.html* is "a.example.com" and the port is 443, the standard port for HTTPS.

Web proxy credentials are optional and you can use them to connect to a web proxy server that requires basic authentication of user name and password. To store web proxy credentials, you use a secret in Secrets Manager.

It is recommended that you follow best security practices when configuring your web proxy. This includes setting up throttling, setting up logging and monitoring, and applying security patches on a regular basis. If you use your web proxy with multiple data sources, sync jobs that occur at the same time could strain the load on your proxy. It is recommended you prepare your proxy beforehand for any security and load requirements.

Returns:

• (Types::ProxyConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the user name and password required to connect to the SharePoint instance. For more information, see Microsoft SharePoint.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#share_point_version ⇒ String

The version of Microsoft SharePoint that you use.

Returns:

• (String)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#ssl_certificate_s3_path ⇒ Types::S3Path

The path to the SSL certificate stored in an Amazon S3 bucket. You use this to connect to SharePoint Server if you require a secure SSL connection.

You can 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.

Returns:

• (Types::S3Path)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#urls ⇒ Array<String>

The Microsoft SharePoint site URLs for the documents you want to index.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#use_change_log ⇒ Boolean

TRUE to use the SharePoint change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in SharePoint.

Returns:

• (Boolean)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configuration ⇒ Types::DataSourceVpcConfiguration

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

Returns:

• (Types::DataSourceVpcConfiguration)

# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9638

class SharePointConfiguration < Struct.new(
  :share_point_version,
  :urls,
  :secret_arn,
  :crawl_attachments,
  :use_change_log,
  :inclusion_patterns,
  :exclusion_patterns,
  :vpc_configuration,
  :field_mappings,
  :document_title_field_name,
  :disable_local_groups,
  :ssl_certificate_s3_path,
  :authentication_type,
  :proxy_configuration)
  SENSITIVE = []
  include Aws::Structure
end