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

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 GoogleDriveConfiguration data as a hash:

{
  secret_arn: "SecretArn", # required
  inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
  exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
  field_mappings: [
    {
      data_source_field_name: "DataSourceFieldName", # required
      date_field_format: "DataSourceDateFieldFormat",
      index_field_name: "IndexFieldName", # required
    },
  ],
  exclude_mime_types: ["MimeType"],
  exclude_user_accounts: ["UserAccount"],
  exclude_shared_drives: ["SharedDriveId"],
}

Provides configuration information for data sources that connect to Google Drive.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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

3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
 
# File 'lib/aws-sdk-kendra/types.rb', line 3660

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

3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
 
# File 'lib/aws-sdk-kendra/types.rb', line 3660

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

3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
 
# File 'lib/aws-sdk-kendra/types.rb', line 3660

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 that apply to the path on Google Drive. Items that match the pattern are excluded from the index from both shared drives and users' My Drives. Items that don't match the pattern are included in the index. If an item matches both an exclusion pattern and an inclusion pattern, it is excluded from the index.

Returns:

  • (Array<String>) 

3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
 
# File 'lib/aws-sdk-kendra/types.rb', line 3660

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>

Defines mapping between a field in the Google Drive and a Amazon Kendra index field.

If you are using the console, you can define index fields when creating the mapping. If you are using the API, you must first create the field using the UpdateIndex operation.

Returns:


3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
 
# File 'lib/aws-sdk-kendra/types.rb', line 3660

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 that apply to path on Google Drive. Items that match the pattern are included in the index from both shared drives and users' My Drives. Items that don't match the pattern are excluded from the index. If an item matches both an inclusion pattern and an exclusion pattern, it is excluded from the index.

Returns:

  • (Array<String>) 

3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
 
# File 'lib/aws-sdk-kendra/types.rb', line 3660

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

3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
 
# File 'lib/aws-sdk-kendra/types.rb', line 3660

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