Class: Aws::Kendra::Types::OneDriveConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::OneDriveConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

Provides the configuration information to connect to OneDrive as your data source.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #disable_local_groups ⇒ Boolean

  ‘TRUE` to disable local groups information.

• #exclusion_patterns ⇒ Array<String>

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

• #field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  A list of ‘DataSourceToIndexFieldMapping` objects that map OneDrive 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 OneDrive.

• #one_drive_users ⇒ Types::OneDriveUsers

  A list of user accounts whose documents should be indexed.

• #secret_arn ⇒ String

  The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive.

• #tenant_domain ⇒ String

  The Azure Active Directory domain of the organization.

Instance Attribute Details

#disable_local_groups ⇒ Boolean

‘TRUE` to disable local groups information.

Returns:

• (Boolean)

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

class OneDriveConfiguration < Struct.new(
  :tenant_domain,
  :secret_arn,
  :one_drive_users,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :disable_local_groups)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_patterns ⇒ Array<String>

A list of regular expression patterns to exclude certain documents in your OneDrive. 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 pattern is applied to the file name.

Returns:

• (Array<String>)

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

class OneDriveConfiguration < Struct.new(
  :tenant_domain,
  :secret_arn,
  :one_drive_users,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :disable_local_groups)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

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

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

Returns:

• (Array<Types::DataSourceToIndexFieldMapping>)

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

class OneDriveConfiguration < Struct.new(
  :tenant_domain,
  :secret_arn,
  :one_drive_users,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :disable_local_groups)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patterns ⇒ Array<String>

A list of regular expression patterns to include certain documents in your OneDrive. 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 pattern is applied to the file name.

Returns:

• (Array<String>)

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

class OneDriveConfiguration < Struct.new(
  :tenant_domain,
  :secret_arn,
  :one_drive_users,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :disable_local_groups)
  SENSITIVE = []
  include Aws::Structure
end

#one_drive_users ⇒ Types::OneDriveUsers

A list of user accounts whose documents should be indexed.

Returns:

• (Types::OneDriveUsers)

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

class OneDriveConfiguration < Struct.new(
  :tenant_domain,
  :secret_arn,
  :one_drive_users,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :disable_local_groups)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

The Amazon Resource Name (ARN) of an Secrets Managersecret that contains the user name and password to connect to OneDrive. The user name should be the application ID for the OneDrive application, and the password is the application key for the OneDrive application.

Returns:

• (String)

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

class OneDriveConfiguration < Struct.new(
  :tenant_domain,
  :secret_arn,
  :one_drive_users,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :disable_local_groups)
  SENSITIVE = []
  include Aws::Structure
end

#tenant_domain ⇒ String

The Azure Active Directory domain of the organization.

Returns:

• (String)

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

class OneDriveConfiguration < Struct.new(
  :tenant_domain,
  :secret_arn,
  :one_drive_users,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :disable_local_groups)
  SENSITIVE = []
  include Aws::Structure
end