class CfnDataSourcePropsMixin

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

Implements IMixin

Extends Mixin

Creates a data source connector that you want to use with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information for the data source connector.

CreateDataSource does not support connectors which require a TemplateConfiguration object for connecting to Amazon Kendra .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-datasource.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as kendra_mixins } from '@aws-cdk/mixins-preview/aws-kendra';
const cfnDataSourcePropsMixin = new kendra_mixins.CfnDataSourcePropsMixin({
  customDocumentEnrichmentConfiguration: {
    inlineConfigurations: [{
      condition: {
        conditionDocumentAttributeKey: 'conditionDocumentAttributeKey',
        conditionOnValue: {
          dateValue: 'dateValue',
          longValue: 123,
          stringListValue: ['stringListValue'],
          stringValue: 'stringValue',
        },
        operator: 'operator',
      },
      documentContentDeletion: false,
      target: {
        targetDocumentAttributeKey: 'targetDocumentAttributeKey',
        targetDocumentAttributeValue: {
          dateValue: 'dateValue',
          longValue: 123,
          stringListValue: ['stringListValue'],
          stringValue: 'stringValue',
        },
        targetDocumentAttributeValueDeletion: false,
      },
    }],
    postExtractionHookConfiguration: {
      invocationCondition: {
        conditionDocumentAttributeKey: 'conditionDocumentAttributeKey',
        conditionOnValue: {
          dateValue: 'dateValue',
          longValue: 123,
          stringListValue: ['stringListValue'],
          stringValue: 'stringValue',
        },
        operator: 'operator',
      },
      lambdaArn: 'lambdaArn',
      s3Bucket: 's3Bucket',
    },
    preExtractionHookConfiguration: {
      invocationCondition: {
        conditionDocumentAttributeKey: 'conditionDocumentAttributeKey',
        conditionOnValue: {
          dateValue: 'dateValue',
          longValue: 123,
          stringListValue: ['stringListValue'],
          stringValue: 'stringValue',
        },
        operator: 'operator',
      },
      lambdaArn: 'lambdaArn',
      s3Bucket: 's3Bucket',
    },
    roleArn: 'roleArn',
  },
  dataSourceConfiguration: {
    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,
    },
  },
  description: 'description',
  indexId: 'indexId',
  languageCode: 'languageCode',
  name: 'name',
  roleArn: 'roleArn',
  schedule: 'schedule',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  type: 'type',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnDataSourcePropsMixin(props: CfnDataSourceMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnDataSourceMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

Create a mixin to apply properties to AWS::Kendra::DataSource.

Properties

Name	Type	Description
props	CfnDataSourceMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnDataSourceMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.