interface DataSourceConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins.CfnDataSourcePropsMixin.DataSourceConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskendra/mixins#CfnDataSourcePropsMixin_DataSourceConfigurationProperty`
Java	`software.amazon.awscdk.mixins.preview.services.kendra.mixins.CfnDataSourcePropsMixin.DataSourceConfigurationProperty`
Python	`aws_cdk.mixins_preview.aws_kendra.mixins.CfnDataSourcePropsMixin.DataSourceConfigurationProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_kendra` » `mixins` » `CfnDataSourcePropsMixin` » `DataSourceConfigurationProperty`

Provides the configuration information for an Amazon Kendra data source.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as kendra_mixins } from '@aws-cdk/mixins-preview/aws-kendra';
const dataSourceConfigurationProperty: kendra_mixins.CfnDataSourcePropsMixin.DataSourceConfigurationProperty = {
  confluenceConfiguration: {
    attachmentConfiguration: {
      attachmentFieldMappings: [{
        dataSourceFieldName: 'dataSourceFieldName',
        dateFieldFormat: 'dateFieldFormat',
        indexFieldName: 'indexFieldName',
      }],
      crawlAttachments: false,
    },
    blogConfiguration: {
      blogFieldMappings: [{
        dataSourceFieldName: 'dataSourceFieldName',
        dateFieldFormat: 'dateFieldFormat',
        indexFieldName: 'indexFieldName',
      }],
    },
    exclusionPatterns: ['exclusionPatterns'],
    inclusionPatterns: ['inclusionPatterns'],
    pageConfiguration: {
      pageFieldMappings: [{
        dataSourceFieldName: 'dataSourceFieldName',
        dateFieldFormat: 'dateFieldFormat',
        indexFieldName: 'indexFieldName',
      }],
    },
    secretArn: 'secretArn',
    serverUrl: 'serverUrl',
    spaceConfiguration: {
      crawlArchivedSpaces: false,
      crawlPersonalSpaces: false,
      excludeSpaces: ['excludeSpaces'],
      includeSpaces: ['includeSpaces'],
      spaceFieldMappings: [{
        dataSourceFieldName: 'dataSourceFieldName',
        dateFieldFormat: 'dateFieldFormat',
        indexFieldName: 'indexFieldName',
      }],
    },
    version: 'version',
    vpcConfiguration: {
      securityGroupIds: ['securityGroupIds'],
      subnetIds: ['subnetIds'],
    },
  },
  databaseConfiguration: {
    aclConfiguration: {
      allowedGroupsColumnName: 'allowedGroupsColumnName',
    },
    columnConfiguration: {
      changeDetectingColumns: ['changeDetectingColumns'],
      documentDataColumnName: 'documentDataColumnName',
      documentIdColumnName: 'documentIdColumnName',
      documentTitleColumnName: 'documentTitleColumnName',
      fieldMappings: [{
        dataSourceFieldName: 'dataSourceFieldName',
        dateFieldFormat: 'dateFieldFormat',
        indexFieldName: 'indexFieldName',
      }],
    },
    connectionConfiguration: {
      databaseHost: 'databaseHost',
      databaseName: 'databaseName',
      databasePort: 123,
      secretArn: 'secretArn',
      tableName: 'tableName',
    },
    databaseEngineType: 'databaseEngineType',
    sqlConfiguration: {
      queryIdentifiersEnclosingOption: 'queryIdentifiersEnclosingOption',
    },
    vpcConfiguration: {
      securityGroupIds: ['securityGroupIds'],
      subnetIds: ['subnetIds'],
    },
  },
  googleDriveConfiguration: {
    excludeMimeTypes: ['excludeMimeTypes'],
    excludeSharedDrives: ['excludeSharedDrives'],
    excludeUserAccounts: ['excludeUserAccounts'],
    exclusionPatterns: ['exclusionPatterns'],
    fieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      dateFieldFormat: 'dateFieldFormat',
      indexFieldName: 'indexFieldName',
    }],
    inclusionPatterns: ['inclusionPatterns'],
    secretArn: 'secretArn',
  },
  oneDriveConfiguration: {
    disableLocalGroups: false,
    exclusionPatterns: ['exclusionPatterns'],
    fieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      dateFieldFormat: 'dateFieldFormat',
      indexFieldName: 'indexFieldName',
    }],
    inclusionPatterns: ['inclusionPatterns'],
    oneDriveUsers: {
      oneDriveUserList: ['oneDriveUserList'],
      oneDriveUserS3Path: {
        bucket: 'bucket',
        key: 'key',
      },
    },
    secretArn: 'secretArn',
    tenantDomain: 'tenantDomain',
  },
  s3Configuration: {
    accessControlListConfiguration: {
      keyPath: 'keyPath',
    },
    bucketName: 'bucketName',
    documentsMetadataConfiguration: {
      s3Prefix: 's3Prefix',
    },
    exclusionPatterns: ['exclusionPatterns'],
    inclusionPatterns: ['inclusionPatterns'],
    inclusionPrefixes: ['inclusionPrefixes'],
  },
  salesforceConfiguration: {
    chatterFeedConfiguration: {
      documentDataFieldName: 'documentDataFieldName',
      documentTitleFieldName: 'documentTitleFieldName',
      fieldMappings: [{
        dataSourceFieldName: 'dataSourceFieldName',
        dateFieldFormat: 'dateFieldFormat',
        indexFieldName: 'indexFieldName',
      }],
      includeFilterTypes: ['includeFilterTypes'],
    },
    crawlAttachments: false,
    excludeAttachmentFilePatterns: ['excludeAttachmentFilePatterns'],
    includeAttachmentFilePatterns: ['includeAttachmentFilePatterns'],
    knowledgeArticleConfiguration: {
      customKnowledgeArticleTypeConfigurations: [{
        documentDataFieldName: 'documentDataFieldName',
        documentTitleFieldName: 'documentTitleFieldName',
        fieldMappings: [{
          dataSourceFieldName: 'dataSourceFieldName',
          dateFieldFormat: 'dateFieldFormat',
          indexFieldName: 'indexFieldName',
        }],
        name: 'name',
      }],
      includedStates: ['includedStates'],
      standardKnowledgeArticleTypeConfiguration: {
        documentDataFieldName: 'documentDataFieldName',
        documentTitleFieldName: 'documentTitleFieldName',
        fieldMappings: [{
          dataSourceFieldName: 'dataSourceFieldName',
          dateFieldFormat: 'dateFieldFormat',
          indexFieldName: 'indexFieldName',
        }],
      },
    },
    secretArn: 'secretArn',
    serverUrl: 'serverUrl',
    standardObjectAttachmentConfiguration: {
      documentTitleFieldName: 'documentTitleFieldName',
      fieldMappings: [{
        dataSourceFieldName: 'dataSourceFieldName',
        dateFieldFormat: 'dateFieldFormat',
        indexFieldName: 'indexFieldName',
      }],
    },
    standardObjectConfigurations: [{
      documentDataFieldName: 'documentDataFieldName',
      documentTitleFieldName: 'documentTitleFieldName',
      fieldMappings: [{
        dataSourceFieldName: 'dataSourceFieldName',
        dateFieldFormat: 'dateFieldFormat',
        indexFieldName: 'indexFieldName',
      }],
      name: 'name',
    }],
  },
  serviceNowConfiguration: {
    authenticationType: 'authenticationType',
    hostUrl: 'hostUrl',
    knowledgeArticleConfiguration: {
      crawlAttachments: false,
      documentDataFieldName: 'documentDataFieldName',
      documentTitleFieldName: 'documentTitleFieldName',
      excludeAttachmentFilePatterns: ['excludeAttachmentFilePatterns'],
      fieldMappings: [{
        dataSourceFieldName: 'dataSourceFieldName',
        dateFieldFormat: 'dateFieldFormat',
        indexFieldName: 'indexFieldName',
      }],
      filterQuery: 'filterQuery',
      includeAttachmentFilePatterns: ['includeAttachmentFilePatterns'],
    },
    secretArn: 'secretArn',
    serviceCatalogConfiguration: {
      crawlAttachments: false,
      documentDataFieldName: 'documentDataFieldName',
      documentTitleFieldName: 'documentTitleFieldName',
      excludeAttachmentFilePatterns: ['excludeAttachmentFilePatterns'],
      fieldMappings: [{
        dataSourceFieldName: 'dataSourceFieldName',
        dateFieldFormat: 'dateFieldFormat',
        indexFieldName: 'indexFieldName',
      }],
      includeAttachmentFilePatterns: ['includeAttachmentFilePatterns'],
    },
    serviceNowBuildVersion: 'serviceNowBuildVersion',
  },
  sharePointConfiguration: {
    crawlAttachments: false,
    disableLocalGroups: false,
    documentTitleFieldName: 'documentTitleFieldName',
    exclusionPatterns: ['exclusionPatterns'],
    fieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      dateFieldFormat: 'dateFieldFormat',
      indexFieldName: 'indexFieldName',
    }],
    inclusionPatterns: ['inclusionPatterns'],
    secretArn: 'secretArn',
    sharePointVersion: 'sharePointVersion',
    sslCertificateS3Path: {
      bucket: 'bucket',
      key: 'key',
    },
    urls: ['urls'],
    useChangeLog: false,
    vpcConfiguration: {
      securityGroupIds: ['securityGroupIds'],
      subnetIds: ['subnetIds'],
    },
  },
  templateConfiguration: {
    template: 'template',
  },
  webCrawlerConfiguration: {
    authenticationConfiguration: {
      basicAuthentication: [{
        credentials: 'credentials',
        host: 'host',
        port: 123,
      }],
    },
    crawlDepth: 123,
    maxContentSizePerPageInMegaBytes: 123,
    maxLinksPerPage: 123,
    maxUrlsPerMinuteCrawlRate: 123,
    proxyConfiguration: {
      credentials: 'credentials',
      host: 'host',
      port: 123,
    },
    urlExclusionPatterns: ['urlExclusionPatterns'],
    urlInclusionPatterns: ['urlInclusionPatterns'],
    urls: {
      seedUrlConfiguration: {
        seedUrls: ['seedUrls'],
        webCrawlerMode: 'webCrawlerMode',
      },
      siteMapsConfiguration: {
        siteMaps: ['siteMaps'],
      },
    },
  },
  workDocsConfiguration: {
    crawlComments: false,
    exclusionPatterns: ['exclusionPatterns'],
    fieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      dateFieldFormat: 'dateFieldFormat',
      indexFieldName: 'indexFieldName',
    }],
    inclusionPatterns: ['inclusionPatterns'],
    organizationId: 'organizationId',
    useChangeLog: false,
  },
};

Properties

Name	Type	Description
confluenceConfiguration?	`IResolvable` `\|` `ConfluenceConfigurationProperty`	Provides the configuration information to connect to Confluence as your data source.
databaseConfiguration?	`IResolvable` `\|` `DatabaseConfigurationProperty`	Provides the configuration information to connect to a database as your data source.
googleDriveConfiguration?	`IResolvable` `\|` `GoogleDriveConfigurationProperty`	Provides the configuration information to connect to Google Drive as your data source.
oneDriveConfiguration?	`IResolvable` `\|` `OneDriveConfigurationProperty`	Provides the configuration information to connect to Microsoft OneDrive as your data source.
s3Configuration?	`IResolvable` `\|` `S3DataSourceConfigurationProperty`	Provides the configuration information to connect to an Amazon S3 bucket as your data source.
salesforceConfiguration?	`IResolvable` `\|` `SalesforceConfigurationProperty`	Provides the configuration information to connect to Salesforce as your data source.
serviceNowConfiguration?	`IResolvable` `\|` `ServiceNowConfigurationProperty`	Provides the configuration information to connect to ServiceNow as your data source.
sharePointConfiguration?	`IResolvable` `\|` `SharePointConfigurationProperty`	Provides the configuration information to connect to Microsoft SharePoint as your data source.
templateConfiguration?	`IResolvable` `\|` `TemplateConfigurationProperty`	Provides a template for the configuration information to connect to your data source.
webCrawlerConfiguration?	`IResolvable` `\|` `WebCrawlerConfigurationProperty`	Provides the configuration information required for Amazon Kendra Web Crawler.
workDocsConfiguration?	`IResolvable` `\|` `WorkDocsConfigurationProperty`	Provides the configuration information to connect to WorkDocs as your data source.

confluenceConfiguration?

Type: IResolvable | ConfluenceConfigurationProperty (optional)

Provides the configuration information to connect to Confluence as your data source.

databaseConfiguration?

Type: IResolvable | DatabaseConfigurationProperty (optional)

Provides the configuration information to connect to a database as your data source.

googleDriveConfiguration?

Type: IResolvable | GoogleDriveConfigurationProperty (optional)

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

oneDriveConfiguration?

Type: IResolvable | OneDriveConfigurationProperty (optional)

Provides the configuration information to connect to Microsoft OneDrive as your data source.

s3Configuration?

Type: IResolvable | S3DataSourceConfigurationProperty (optional)

Provides the configuration information to connect to an Amazon S3 bucket as your data source.

Amazon Kendra now supports an upgraded Amazon S3 connector.

You must now use the TemplateConfiguration object instead of the S3DataSourceConfiguration object to configure your connector.

Connectors configured using the older console and API architecture will continue to function as configured. However, you won't be able to edit or update them. If you want to edit or update your connector configuration, you must create a new connector.

We recommended migrating your connector workflow to the upgraded version. Support for connectors configured using the older architecture is scheduled to end by June 2024.