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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass OneDriveConfiguration data as a hash:

{
  tenant_domain: "TenantDomain", # required
  secret_arn: "SecretArn", # required
  one_drive_users: { # required
    one_drive_user_list: ["OneDriveUser"],
    one_drive_user_s3_path: {
      bucket: "S3BucketName", # required
      key: "S3ObjectKey", # required
    },
  },
  inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
  exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
  field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
  disable_local_groups: false,
}

Provides configuration information for data sources that connect to OneDrive.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #disable_local_groups ⇒ Boolean

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

• #exclusion_patterns ⇒ Array<String>

  List of regular expressions applied to documents.

• #field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

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

• #inclusion_patterns ⇒ Array<String>

  A list of regular expression patterns.

• #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 AWS Secrets Manager secret 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

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

Returns:

• (Boolean)

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

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>

List of regular expressions applied to documents. Items that match the exclusion pattern are not indexed. If you provide both an inclusion pattern and an exclusion pattern, any item that matches the exclusion pattern isn't indexed.

The exclusion pattern is applied to the file name.

Returns:

• (Array<String>)

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

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 Microsoft OneDrive fields to custom fields in the Amazon Kendra index. You must first create the index fields before you map OneDrive fields.

Returns:

• (Array<Types::DataSourceToIndexFieldMapping>)

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

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. Documents that match the pattern are included in the index. Documents that don't match the pattern 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 exclusion pattern is applied to the file name.

Returns:

• (Array<String>)

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

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 4259

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 AWS Secrets Manager secret that contains the user name and password to connect to OneDrive. The user namd 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 4259

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 4259

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