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 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 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();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDataSource.DatabaseConfigurationProperty
static final class
An implementation forCfnDataSource.DatabaseConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Information 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 Object
Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.default Object
Provides 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. -
getConnectionConfiguration
Configuration information that's required to connect to a database. -
getDatabaseEngineType
The type of database engine that runs the database. -
getAclConfiguration
Information about the database column that provides information for user context filtering. -
getSqlConfiguration
Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source. -
getVpcConfiguration
Provides information for connecting to an Amazon VPC. -
builder
-