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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/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 the configuration information to connect to Google Drive as your data source.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns:

  • (Array<String>)


8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8116

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


8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8116

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


8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8116

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


8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8116

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



8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8116

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


8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8116

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_arnString

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.

Returns:

  • (String)


8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 8116

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