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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass SharePointConfiguration data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#crawl_attachmentsBoolean

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

Returns:

  • (Boolean)

5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
# File 'lib/aws-sdk-kendra/types.rb', line 5799

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)
  SENSITIVE = []
  include Aws::Structure
end

#disable_local_groupsBoolean

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

Returns:

  • (Boolean)

5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
# File 'lib/aws-sdk-kendra/types.rb', line 5799

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)
  SENSITIVE = []
  include Aws::Structure
end

#document_title_field_nameString

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

Returns:

  • (String)

5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
# File 'lib/aws-sdk-kendra/types.rb', line 5799

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)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_patternsArray<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>)

5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
# File 'lib/aws-sdk-kendra/types.rb', line 5799

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)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappingsArray<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].

[1]: docs.aws.amazon.com/kendra/latest/dg/field-mapping.html


5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
# File 'lib/aws-sdk-kendra/types.rb', line 5799

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)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patternsArray<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>)

5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
# File 'lib/aws-sdk-kendra/types.rb', line 5799

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)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arnString

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 ][2] in the *AWS Secrets Manager* user guide.

[1]: docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html [2]: docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html

Returns:

  • (String)

5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
# File 'lib/aws-sdk-kendra/types.rb', line 5799

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)
  SENSITIVE = []
  include Aws::Structure
end

#share_point_versionString

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

Returns:

  • (String)

5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
# File 'lib/aws-sdk-kendra/types.rb', line 5799

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)
  SENSITIVE = []
  include Aws::Structure
end

#urlsArray<String>

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

Returns:

  • (Array<String>)

5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
# File 'lib/aws-sdk-kendra/types.rb', line 5799

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)
  SENSITIVE = []
  include Aws::Structure
end

#use_change_logBoolean

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)

5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
# File 'lib/aws-sdk-kendra/types.rb', line 5799

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)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configurationTypes::DataSourceVpcConfiguration

Provides information for connecting to an Amazon VPC.


5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
# File 'lib/aws-sdk-kendra/types.rb', line 5799

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)
  SENSITIVE = []
  include Aws::Structure
end