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

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#disable_local_groupsBoolean

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

Returns:

  • (Boolean)

4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
# 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_patternsArray<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>)

4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
# 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_mappingsArray<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.


4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
# 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_patternsArray<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>)

4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
# 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_usersTypes::OneDriveUsers

A list of user accounts whose documents should be indexed.


4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
# 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_arnString

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)

4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
# 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_domainString

The Azure Active Directory domain of the organization.

Returns:

  • (String)

4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
# 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