DatabaseConfigurationProperty Struct
Provides the configuration information to an Amazon Kendra supported database .
Example
ts
// 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
aclConfigurationoptionalIResolvable | CfnDataSource.AclConfigurationPropertyacl_configurationoptionaltyping.Union[IResolvable, AclConfigurationProperty]aclConfigurationoptionalIResolvableAclConfigurationoptionalIResolvableAclConfigurationoptionalinterface{}#Information about the database column that provides information for user context filtering.
columnConfigurationIResolvable | CfnDataSource.ColumnConfigurationPropertycolumn_configurationtyping.Union[IResolvable, ColumnConfigurationProperty]columnConfigurationIResolvableColumnConfigurationIResolvableColumnConfigurationinterface{}required#Information about where the index should get the document information from the database.
connectionConfigurationIResolvable | CfnDataSource.ConnectionConfigurationPropertyconnection_configurationtyping.Union[IResolvable, ConnectionConfigurationProperty]connectionConfigurationIResolvableConnectionConfigurationIResolvableConnectionConfigurationinterface{}required#Configuration information that's required to connect to a database.
databaseEngineTypestringdatabase_engine_typestrdatabaseEngineTypeStringDatabaseEngineTypestringDatabaseEngineType*stringrequired#The type of database engine that runs the database.
sqlConfigurationoptionalIResolvable | CfnDataSource.SqlConfigurationPropertysql_configurationoptionaltyping.Union[IResolvable, SqlConfigurationProperty]sqlConfigurationoptionalIResolvableSqlConfigurationoptionalIResolvableSqlConfigurationoptionalinterface{}#Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
vpcConfigurationoptionalIResolvable | CfnDataSource.DataSourceVpcConfigurationPropertyvpc_configurationoptionaltyping.Union[IResolvable, DataSourceVpcConfigurationProperty]vpcConfigurationoptionalIResolvableVpcConfigurationoptionalIResolvableVpcConfigurationoptionalinterface{}#Provides information for connecting to an Amazon VPC.