Class: Aws::Kendra::Types::GoogleDriveConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::GoogleDriveConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

Provides the configuration information to connect to Google Drive as your data source.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #exclude_mime_types ⇒ Array<String>

  A list of MIME types to exclude from the index.

• #exclude_shared_drives ⇒ Array<String>

  A list of identifiers or shared drives to exclude from the index.

• #exclude_user_accounts ⇒ Array<String>

  A list of email addresses of the users.

• #exclusion_patterns ⇒ Array<String>

  A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users’ My Drives.

• #field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

  Maps Google Drive 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 items in your Google Drive, including shared drives and users’ My Drives.

• #secret_arn ⇒ String

  The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive.

Instance Attribute Details

#exclude_mime_types ⇒ Array<String>

A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.

For a list of MIME types, see [Using a Google Workspace Drive data source].

[1]: docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html

Returns:

• (Array<String>)

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

class GoogleDriveConfiguration < Struct.new(
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :exclude_mime_types,
  :exclude_user_accounts,
  :exclude_shared_drives)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_shared_drives ⇒ Array<String>

A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.

Returns:

• (Array<String>)

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

class GoogleDriveConfiguration < Struct.new(
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :exclude_mime_types,
  :exclude_user_accounts,
  :exclude_shared_drives)
  SENSITIVE = []
  include Aws::Structure
end

#exclude_user_accounts ⇒ Array<String>

A list of email addresses of the users. Documents owned by these users are excluded from the index. Documents shared with excluded users are indexed unless they are excluded in another way.

Returns:

• (Array<String>)

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

class GoogleDriveConfiguration < Struct.new(
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :exclude_mime_types,
  :exclude_user_accounts,
  :exclude_shared_drives)
  SENSITIVE = []
  include Aws::Structure
end

#exclusion_patterns ⇒ Array<String>

A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users’ My Drives. Items that match the patterns are excluded from the index. Items that don’t match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.

Returns:

• (Array<String>)

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

class GoogleDriveConfiguration < Struct.new(
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :exclude_mime_types,
  :exclude_user_accounts,
  :exclude_shared_drives)
  SENSITIVE = []
  include Aws::Structure
end

#field_mappings ⇒ Array<Types::DataSourceToIndexFieldMapping>

Maps Google Drive data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the ‘UpdateIndex` API before you map to Google Drive fields. For more information, see [Mapping data source fields]. The Google Drive data source field names must exist in your Google Drive 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 6289

class GoogleDriveConfiguration < Struct.new(
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :exclude_mime_types,
  :exclude_user_accounts,
  :exclude_shared_drives)
  SENSITIVE = []
  include Aws::Structure
end

#inclusion_patterns ⇒ Array<String>

A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users’ My Drives. Items that match the patterns are included in the index. Items that don’t match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn’t included in the index.

Returns:

• (Array<String>)

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

class GoogleDriveConfiguration < Struct.new(
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :exclude_mime_types,
  :exclude_user_accounts,
  :exclude_shared_drives)
  SENSITIVE = []
  include Aws::Structure
end

#secret_arn ⇒ String

The Amazon Resource Name (ARN) of a Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see [Using a Google Workspace Drive data source].

[1]: docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html

Returns:

• (String)

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

class GoogleDriveConfiguration < Struct.new(
  :secret_arn,
  :inclusion_patterns,
  :exclusion_patterns,
  :field_mappings,
  :exclude_mime_types,
  :exclude_user_accounts,
  :exclude_shared_drives)
  SENSITIVE = []
  include Aws::Structure
end