Class CfnDataSource.DatabaseConfigurationProperty
Provides the configuration information to an Amazon Kendra supported database .
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Kendra
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class DatabaseConfigurationProperty : Object, CfnDataSource.IDatabaseConfigurationProperty
Syntax (vb)
Public Class DatabaseConfigurationProperty
Inherits Object
Implements CfnDataSource.IDatabaseConfigurationProperty
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;
var databaseConfigurationProperty = new DatabaseConfigurationProperty {
ColumnConfiguration = new ColumnConfigurationProperty {
ChangeDetectingColumns = new [] { "changeDetectingColumns" },
DocumentDataColumnName = "documentDataColumnName",
DocumentIdColumnName = "documentIdColumnName",
// the properties below are optional
DocumentTitleColumnName = "documentTitleColumnName",
FieldMappings = new [] { new DataSourceToIndexFieldMappingProperty {
DataSourceFieldName = "dataSourceFieldName",
IndexFieldName = "indexFieldName",
// the properties below are optional
DateFieldFormat = "dateFieldFormat"
} }
},
ConnectionConfiguration = new ConnectionConfigurationProperty {
DatabaseHost = "databaseHost",
DatabaseName = "databaseName",
DatabasePort = 123,
SecretArn = "secretArn",
TableName = "tableName"
},
DatabaseEngineType = "databaseEngineType",
// the properties below are optional
AclConfiguration = new AclConfigurationProperty {
AllowedGroupsColumnName = "allowedGroupsColumnName"
},
SqlConfiguration = new SqlConfigurationProperty {
QueryIdentifiersEnclosingOption = "queryIdentifiersEnclosingOption"
},
VpcConfiguration = new DataSourceVpcConfigurationProperty {
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
};
Synopsis
Constructors
DatabaseConfigurationProperty() |
Properties
AclConfiguration | Information about the database column that provides information for user context filtering. |
ColumnConfiguration | Information about where the index should get the document information from the database. |
ConnectionConfiguration | Configuration information that's required to connect to a database. |
DatabaseEngineType | The type of database engine that runs the database. |
SqlConfiguration | Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source. |
VpcConfiguration | Provides information for connecting to an Amazon VPC. |
Constructors
DatabaseConfigurationProperty()
public DatabaseConfigurationProperty()
Properties
AclConfiguration
Information about the database column that provides information for user context filtering.
public object AclConfiguration { get; set; }
Property Value
System.Object
Remarks
ColumnConfiguration
Information about where the index should get the document information from the database.
public object ColumnConfiguration { get; set; }
Property Value
System.Object
Remarks
ConnectionConfiguration
Configuration information that's required to connect to a database.
public object ConnectionConfiguration { get; set; }
Property Value
System.Object
Remarks
DatabaseEngineType
The type of database engine that runs the database.
public string DatabaseEngineType { get; set; }
Property Value
System.String
Remarks
SqlConfiguration
Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
public object SqlConfiguration { get; set; }
Property Value
System.Object
Remarks
VpcConfiguration
Provides information for connecting to an Amazon VPC.
public object VpcConfiguration { get; set; }
Property Value
System.Object