Interface CfnDataSource.DatabaseConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDataSource.DatabaseConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnDataSource
@Stability(Stable)
public static interface CfnDataSource.DatabaseConfigurationProperty
extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.kendra.*;
DatabaseConfigurationProperty databaseConfigurationProperty = DatabaseConfigurationProperty.builder()
.columnConfiguration(ColumnConfigurationProperty.builder()
.changeDetectingColumns(List.of("changeDetectingColumns"))
.documentDataColumnName("documentDataColumnName")
.documentIdColumnName("documentIdColumnName")
// the properties below are optional
.documentTitleColumnName("documentTitleColumnName")
.fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
.dataSourceFieldName("dataSourceFieldName")
.indexFieldName("indexFieldName")
// the properties below are optional
.dateFieldFormat("dateFieldFormat")
.build()))
.build())
.connectionConfiguration(ConnectionConfigurationProperty.builder()
.databaseHost("databaseHost")
.databaseName("databaseName")
.databasePort(123)
.secretArn("secretArn")
.tableName("tableName")
.build())
.databaseEngineType("databaseEngineType")
// the properties below are optional
.aclConfiguration(AclConfigurationProperty.builder()
.allowedGroupsColumnName("allowedGroupsColumnName")
.build())
.sqlConfiguration(SqlConfigurationProperty.builder()
.queryIdentifiersEnclosingOption("queryIdentifiersEnclosingOption")
.build())
.vpcConfiguration(DataSourceVpcConfigurationProperty.builder()
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnDataSource.DatabaseConfigurationPropertystatic final classAn implementation forCfnDataSource.DatabaseConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectInformation about the database column that provides information for user context filtering.Information about where the index should get the document information from the database.Configuration information that's required to connect to a database.The type of database engine that runs the database.default ObjectProvides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.default ObjectProvides information for connecting to an Amazon VPC.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getColumnConfiguration
Information about where the index should get the document information from the database.Returns union: either
IResolvableorCfnDataSource.ColumnConfigurationProperty- See Also:
-
getConnectionConfiguration
Configuration information that's required to connect to a database.Returns union: either
IResolvableorCfnDataSource.ConnectionConfigurationProperty- See Also:
-
getDatabaseEngineType
The type of database engine that runs the database.- See Also:
-
getAclConfiguration
Information about the database column that provides information for user context filtering.Returns union: either
IResolvableorCfnDataSource.AclConfigurationProperty- See Also:
-
getSqlConfiguration
Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.Returns union: either
IResolvableorCfnDataSource.SqlConfigurationProperty- See Also:
-
getVpcConfiguration
Provides information for connecting to an Amazon VPC.Returns union: either
IResolvableorCfnDataSource.DataSourceVpcConfigurationProperty- See Also:
-
builder
-