interface GoogleDriveConfigurationProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Kendra.CfnDataSource.GoogleDriveConfigurationProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnDataSource_GoogleDriveConfigurationProperty |
![]() | software.amazon.awscdk.services.kendra.CfnDataSource.GoogleDriveConfigurationProperty |
![]() | aws_cdk.aws_kendra.CfnDataSource.GoogleDriveConfigurationProperty |
![]() | aws-cdk-lib » aws_kendra » CfnDataSource » GoogleDriveConfigurationProperty |
Provides the configuration information to connect to Google Drive as your data source.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const googleDriveConfigurationProperty: kendra.CfnDataSource.GoogleDriveConfigurationProperty = {
secretArn: 'secretArn',
// the properties below are optional
excludeMimeTypes: ['excludeMimeTypes'],
excludeSharedDrives: ['excludeSharedDrives'],
excludeUserAccounts: ['excludeUserAccounts'],
exclusionPatterns: ['exclusionPatterns'],
fieldMappings: [{
dataSourceFieldName: 'dataSourceFieldName',
indexFieldName: 'indexFieldName',
// the properties below are optional
dateFieldFormat: 'dateFieldFormat',
}],
inclusionPatterns: ['inclusionPatterns'],
};
Properties
Name | Type | Description |
---|---|---|
secret | string | The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains the credentials required to connect to Google Drive. |
exclude | string[] | A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded. |
exclude | string[] | A list of identifiers or shared drives to exclude from the index. |
exclude | string[] | A list of email addresses of the users. |
exclusion | string[] | A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. |
field | IResolvable | IResolvable | Data [] | Maps Google Drive data source attributes or field names to Amazon Kendra index field names. |
inclusion | string[] | A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. |
secretArn
Type:
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 .
excludeMimeTypes?
Type:
string[]
(optional)
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 .
excludeSharedDrives?
Type:
string[]
(optional)
A list of identifiers or shared drives to exclude from the index.
All files and folders stored on the shared drive are excluded.
excludeUserAccounts?
Type:
string[]
(optional)
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.
exclusionPatterns?
Type:
string[]
(optional)
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.
fieldMappings?
Type:
IResolvable
|
IResolvable
|
Data
[]
(optional)
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.
inclusionPatterns?
Type:
string[]
(optional)
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.