Interface CfnDataSource.IGoogleDriveConfigurationProperty
Provides the configuration information to connect to Google Drive as your data source.
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IGoogleDriveConfigurationProperty
Syntax (vb)
Public Interface IGoogleDriveConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var googleDriveConfigurationProperty = new GoogleDriveConfigurationProperty {
SecretArn = "secretArn",
// the properties below are optional
ExcludeMimeTypes = new [] { "excludeMimeTypes" },
ExcludeSharedDrives = new [] { "excludeSharedDrives" },
ExcludeUserAccounts = new [] { "excludeUserAccounts" },
ExclusionPatterns = new [] { "exclusionPatterns" },
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} },
InclusionPatterns = new [] { "inclusionPatterns" }
};
Synopsis
Properties
ExcludeMimeTypes | A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded. |
ExcludeSharedDrives | A list of identifiers or shared drives to exclude from the index. |
ExcludeUserAccounts | A list of email addresses of the users. |
ExclusionPatterns | A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives. |
FieldMappings | Maps Google Drive data source attributes or field names to Amazon Kendra index field names. |
InclusionPatterns | A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives. |
SecretArn | The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains the credentials required to connect to Google Drive. |
Properties
ExcludeMimeTypes
A list of MIME types to exclude from the index. All documents matching the specified MIME type are excluded.
virtual string[] ExcludeMimeTypes { get; }
Property Value
System.String[]
Remarks
ExcludeSharedDrives
A list of identifiers or shared drives to exclude from the index.
virtual string[] ExcludeSharedDrives { get; }
Property Value
System.String[]
Remarks
All files and folders stored on the shared drive are excluded.
ExcludeUserAccounts
A list of email addresses of the users.
virtual string[] ExcludeUserAccounts { get; }
Property Value
System.String[]
Remarks
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
A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives.
virtual string[] ExclusionPatterns { get; }
Property Value
System.String[]
Remarks
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
Maps Google Drive data source attributes or field names to Amazon Kendra index field names.
virtual object FieldMappings { get; }
Property Value
System.Object
Remarks
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
A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives.
virtual string[] InclusionPatterns { get; }
Property Value
System.String[]
Remarks
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.
SecretArn
The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains the credentials required to connect to Google Drive.
string SecretArn { get; }
Property Value
System.String