aws-cdk-lib.aws_kendra.CfnDataSource.GoogleDriveConfigurationProperty

GoogleDriveConfigurationProperty Struct

Provides the configuration information to connect to Google Drive as your data source.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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'],
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

google_drive_configuration_property = kendra.CfnDataSource.GoogleDriveConfigurationProperty(
    secret_arn="secretArn",

    # the properties below are optional
    exclude_mime_types=["excludeMimeTypes"],
    exclude_shared_drives=["excludeSharedDrives"],
    exclude_user_accounts=["excludeUserAccounts"],
    exclusion_patterns=["exclusionPatterns"],
    field_mappings=[kendra.CfnDataSource.DataSourceToIndexFieldMappingProperty(
        data_source_field_name="dataSourceFieldName",
        index_field_name="indexFieldName",

        # the properties below are optional
        date_field_format="dateFieldFormat"
    )],
    inclusion_patterns=["inclusionPatterns"]
)

// 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();

// Install: dotnet add package Amazon.CDK.Lib
// 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" }
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

googleDriveConfigurationProperty := &GoogleDriveConfigurationProperty{
	SecretArn: jsii.String("secretArn"),

	// the properties below are optional
	ExcludeMimeTypes: []*string{
		jsii.String("excludeMimeTypes"),
	},
	ExcludeSharedDrives: []*string{
		jsii.String("excludeSharedDrives"),
	},
	ExcludeUserAccounts: []*string{
		jsii.String("excludeUserAccounts"),
	},
	ExclusionPatterns: []*string{
		jsii.String("exclusionPatterns"),
	},
	FieldMappings: []interface{}{
		&DataSourceToIndexFieldMappingProperty{
			DataSourceFieldName: jsii.String("dataSourceFieldName"),
			IndexFieldName: jsii.String("indexFieldName"),

			// the properties below are optional
			DateFieldFormat: jsii.String("dateFieldFormat"),
		},
	},
	InclusionPatterns: []*string{
		jsii.String("inclusionPatterns"),
	},
}

Properties

excludeMimeTypes?optionalstring[]exclude_mime_types?optionaltyping.List[str]excludeMimeTypes?optionalList<String>ExcludeMimeTypes?optionalstring[]ExcludeMimeTypes?optional*[]*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 .

excludeSharedDrives?optionalstring[]exclude_shared_drives?optionaltyping.List[str]excludeSharedDrives?optionalList<String>ExcludeSharedDrives?optionalstring[]ExcludeSharedDrives?optional*[]*string#

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

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

excludeUserAccounts?optionalstring[]exclude_user_accounts?optionaltyping.List[str]excludeUserAccounts?optionalList<String>ExcludeUserAccounts?optionalstring[]ExcludeUserAccounts?optional*[]*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.

exclusionPatterns?optionalstring[]exclusion_patterns?optionaltyping.List[str]exclusionPatterns?optionalList<String>ExclusionPatterns?optionalstring[]ExclusionPatterns?optional*[]*string#

A list of regular expression patterns to exclude certain items in your Google Drive, including shared drives and users' My Drives.

notes

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?optionalIResolvable | IResolvable | CfnDataSource.DataSourceToIndexFieldMappingProperty[]field_mappings?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DataSourceToIndexFieldMappingProperty]]]fieldMappings?optionalIResolvableFieldMappings?optionalIResolvableFieldMappings?optionalinterface{}#

Maps Google Drive data source attributes or field names to Amazon Kendra index field names.

notes

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?optionalstring[]inclusion_patterns?optionaltyping.List[str]inclusionPatterns?optionalList<String>InclusionPatterns?optionalstring[]InclusionPatterns?optional*[]*string#

A list of regular expression patterns to include certain items in your Google Drive, including shared drives and users' My Drives.

notes

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.

secretArnstringsecret_arnstrsecretArnStringSecretArnstringSecretArn*stringrequired#

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 .