software.amazon.awscdk.services.kendra

Interface CfnDataSource.GoogleDriveConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.GoogleDriveConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=Stable)
public static interface CfnDataSource.GoogleDriveConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.kendra.*;
 GoogleDriveConfigurationProperty googleDriveConfigurationProperty = GoogleDriveConfigurationProperty.builder()
         .secretArn("secretArn")
         // the properties below are optional
         .excludeMimeTypes(List.of("excludeMimeTypes"))
         .excludeSharedDrives(List.of("excludeSharedDrives"))
         .excludeUserAccounts(List.of("excludeUserAccounts"))
         .exclusionPatterns(List.of("exclusionPatterns"))
         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                 .dataSourceFieldName("dataSourceFieldName")
                 .indexFieldName("indexFieldName")
                 // the properties below are optional
                 .dateFieldFormat("dateFieldFormat")
                 .build()))
         .inclusionPatterns(List.of("inclusionPatterns"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDataSource.GoogleDriveConfigurationProperty.Builder A builder for CfnDataSource.GoogleDriveConfigurationProperty
static class	CfnDataSource.GoogleDriveConfigurationProperty.Jsii$Proxy An implementation for CfnDataSource.GoogleDriveConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.GoogleDriveConfigurationProperty.Builder	builder()
default List<String>	getExcludeMimeTypes() A list of MIME types to exclude from the index.
default List<String>	getExcludeSharedDrives() A list of identifiers or shared drives to exclude from the index.
default List<String>	getExcludeUserAccounts() A list of email addresses of the users.
default List<String>	getExclusionPatterns() A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives.
default Object	getFieldMappings() Maps Google Drive data source attributes or field names to Amazon Kendra index field names.
default List<String>	getInclusionPatterns() A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives.
String	getSecretArn() The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that contains the credentials required to connect to Google Drive.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSecretArn

@Stability(value=Stable)
 @NotNull
String getSecretArn()

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 .

getExcludeMimeTypes

@Stability(value=Stable)
 @Nullable
default List<String> getExcludeMimeTypes()

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 .

getExcludeSharedDrives

@Stability(value=Stable)
 @Nullable
default List<String> getExcludeSharedDrives()

A list of identifiers or shared drives to exclude from the index.

All files and folders stored on the shared drive are excluded.

getExcludeUserAccounts

@Stability(value=Stable)
 @Nullable
default List<String> getExcludeUserAccounts()

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.

getExclusionPatterns

@Stability(value=Stable)
 @Nullable
default List<String> getExclusionPatterns()

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.

getFieldMappings

@Stability(value=Stable)
 @Nullable
default Object getFieldMappings()

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.

getInclusionPatterns

@Stability(value=Stable)
 @Nullable
default List<String> getInclusionPatterns()

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.

builder

@Stability(value=Stable)
static CfnDataSource.GoogleDriveConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.GoogleDriveConfigurationProperty.Builder of CfnDataSource.GoogleDriveConfigurationProperty