AWS::Kendra::DataSource GoogleDriveConfiguration
Provides the configuration information to connect to Google Drive as your data source.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "ExcludeMimeTypes" :
[ String, ... ]
, "ExcludeSharedDrives" :[ String, ... ]
, "ExcludeUserAccounts" :[ String, ... ]
, "ExclusionPatterns" :[ String, ... ]
, "FieldMappings" :[ DataSourceToIndexFieldMapping, ... ]
, "InclusionPatterns" :[ String, ... ]
, "SecretArn" :String
}
YAML
ExcludeMimeTypes:
- String
ExcludeSharedDrives:- String
ExcludeUserAccounts:- String
ExclusionPatterns:- String
FieldMappings:- DataSourceToIndexFieldMapping
InclusionPatterns:- String
SecretArn:String
Properties
ExcludeMimeTypes
-
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.
Required: No
Type: Array of String
Minimum:
0
Maximum:
30
Update requires: No interruption
-
A list of identifiers or shared drives to exclude from the index. All files and folders stored on the shared drive are excluded.
Required: No
Type: Array of String
Minimum:
0
Maximum:
100
Update requires: No interruption
ExcludeUserAccounts
-
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.
Required: No
Type: Array of String
Minimum:
0
Maximum:
100
Update requires: No interruption
ExclusionPatterns
-
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.
Required: No
Type: Array of String
Minimum:
1
Maximum:
50 | 100
Update requires: No interruption
FieldMappings
-
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.Required: No
Type: Array of DataSourceToIndexFieldMapping
Maximum:
100
Update requires: No interruption
InclusionPatterns
-
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.
Required: No
Type: Array of String
Minimum:
1
Maximum:
50 | 100
Update requires: No interruption
SecretArn
-
The Amazon Resource Name (ARN) of a AWS Secrets Managersecret that contains the credentials required to connect to Google Drive. For more information, see Using a Google Workspace Drive data source.
Required: Yes
Type: String
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}
Minimum:
1
Maximum:
1284
Update requires: No interruption