interface DatabaseConfigurationProperty
| Language | Type name |
|---|---|
.NET | Amazon.CDK.Mixins.Preview.AWS.Kendra.Mixins.CfnDataSourcePropsMixin.DatabaseConfigurationProperty |
Go | github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskendra/mixins#CfnDataSourcePropsMixin_DatabaseConfigurationProperty |
Java | software.amazon.awscdk.mixins.preview.services.kendra.mixins.CfnDataSourcePropsMixin.DatabaseConfigurationProperty |
Python | aws_cdk.mixins_preview.aws_kendra.mixins.CfnDataSourcePropsMixin.DatabaseConfigurationProperty |
TypeScript | @aws-cdk/mixins-preview » aws_kendra » mixins » CfnDataSourcePropsMixin » DatabaseConfigurationProperty |
Provides the configuration information to an Amazon Kendra supported database .
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 databaseConfigurationProperty: kendra_mixins.CfnDataSourcePropsMixin.DatabaseConfigurationProperty = {
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'],
},
};
Properties
| Name | Type | Description |
|---|---|---|
| acl | IResolvable | Acl | Information about the database column that provides information for user context filtering. |
| column | IResolvable | Column | Information about where the index should get the document information from the database. |
| connection | IResolvable | Connection | Configuration information that's required to connect to a database. |
| database | string | The type of database engine that runs the database. |
| sql | IResolvable | Sql | Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source. |
| vpc | IResolvable | Data | Provides information for connecting to an Amazon VPC. |
aclConfiguration?
Type:
IResolvable | Acl
(optional)
Information about the database column that provides information for user context filtering.
columnConfiguration?
Type:
IResolvable | Column
(optional)
Information about where the index should get the document information from the database.
connectionConfiguration?
Type:
IResolvable | Connection
(optional)
Configuration information that's required to connect to a database.
databaseEngineType?
Type:
string
(optional)
The type of database engine that runs the database.
sqlConfiguration?
Type:
IResolvable | Sql
(optional)
Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
vpcConfiguration?
Type:
IResolvable | Data
(optional)
Provides information for connecting to an Amazon VPC.

.NET
Go
Java
Python
TypeScript