aws-cdk-lib.aws_kendra.CfnDataSource.DatabaseConfigurationProperty

interface DatabaseConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Kendra.CfnDataSource.DatabaseConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnDataSource_DatabaseConfigurationProperty
Javasoftware.amazon.awscdk.services.kendra.CfnDataSource.DatabaseConfigurationProperty
Pythonaws_cdk.aws_kendra.CfnDataSource.DatabaseConfigurationProperty
TypeScript aws-cdk-lib » aws_kendra » CfnDataSource » DatabaseConfigurationProperty

Provides the configuration information to connect to a index.

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 databaseConfigurationProperty: kendra.CfnDataSource.DatabaseConfigurationProperty = {
  columnConfiguration: {
    changeDetectingColumns: ['changeDetectingColumns'],
    documentDataColumnName: 'documentDataColumnName',
    documentIdColumnName: 'documentIdColumnName',

    // the properties below are optional
    documentTitleColumnName: 'documentTitleColumnName',
    fieldMappings: [{
      dataSourceFieldName: 'dataSourceFieldName',
      indexFieldName: 'indexFieldName',

      // the properties below are optional
      dateFieldFormat: 'dateFieldFormat',
    }],
  },
  connectionConfiguration: {
    databaseHost: 'databaseHost',
    databaseName: 'databaseName',
    databasePort: 123,
    secretArn: 'secretArn',
    tableName: 'tableName',
  },
  databaseEngineType: 'databaseEngineType',

  // the properties below are optional
  aclConfiguration: {
    allowedGroupsColumnName: 'allowedGroupsColumnName',
  },
  sqlConfiguration: {
    queryIdentifiersEnclosingOption: 'queryIdentifiersEnclosingOption',
  },
  vpcConfiguration: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
};

Properties

NameTypeDescription
columnConfigurationIResolvable | ColumnConfigurationPropertyInformation about where the index should get the document information from the database.
connectionConfigurationIResolvable | ConnectionConfigurationPropertyConfiguration information that's required to connect to a database.
databaseEngineTypestringThe type of database engine that runs the database.
aclConfiguration?IResolvable | AclConfigurationPropertyInformation about the database column that provides information for user context filtering.
sqlConfiguration?IResolvable | SqlConfigurationPropertyProvides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
vpcConfiguration?IResolvable | DataSourceVpcConfigurationPropertyProvides information for connecting to an Amazon VPC.

columnConfiguration

Type: IResolvable | ColumnConfigurationProperty

Information about where the index should get the document information from the database.


connectionConfiguration

Type: IResolvable | ConnectionConfigurationProperty

Configuration information that's required to connect to a database.


databaseEngineType

Type: string

The type of database engine that runs the database.


aclConfiguration?

Type: IResolvable | AclConfigurationProperty (optional)

Information about the database column that provides information for user context filtering.


sqlConfiguration?

Type: IResolvable | SqlConfigurationProperty (optional)

Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.


vpcConfiguration?

Type: IResolvable | DataSourceVpcConfigurationProperty (optional)

Provides information for connecting to an Amazon VPC.