software.amazon.awscdk.services.kendra

Interface CfnDataSource.DatabaseConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.DatabaseConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=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

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDataSource.DatabaseConfigurationProperty.Builder A builder for CfnDataSource.DatabaseConfigurationProperty
static class	CfnDataSource.DatabaseConfigurationProperty.Jsii$Proxy An implementation for CfnDataSource.DatabaseConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.DatabaseConfigurationProperty.Builder	builder()
default Object	getAclConfiguration() Information about the database column that provides information for user context filtering.
Object	getColumnConfiguration() Information about where the index should get the document information from the database.
Object	getConnectionConfiguration() Configuration information that's required to connect to a database.
String	getDatabaseEngineType() The type of database engine that runs the database.
default Object	getSqlConfiguration() Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.
default Object	getVpcConfiguration() Provides information for connecting to an Amazon VPC.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getColumnConfiguration

@Stability(value=Stable)
 @NotNull
Object getColumnConfiguration()

Information about where the index should get the document information from the database.

getConnectionConfiguration

@Stability(value=Stable)
 @NotNull
Object getConnectionConfiguration()

Configuration information that's required to connect to a database.

getDatabaseEngineType

@Stability(value=Stable)
 @NotNull
String getDatabaseEngineType()

The type of database engine that runs the database.

getAclConfiguration

@Stability(value=Stable)
 @Nullable
default Object getAclConfiguration()

Information about the database column that provides information for user context filtering.

getSqlConfiguration

@Stability(value=Stable)
 @Nullable
default Object getSqlConfiguration()

Provides information about how Amazon Kendra uses quote marks around SQL identifiers when querying a database data source.

getVpcConfiguration

@Stability(value=Stable)
 @Nullable
default Object getVpcConfiguration()

Provides information for connecting to an Amazon VPC.

builder

@Stability(value=Stable)
static CfnDataSource.DatabaseConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.DatabaseConfigurationProperty.Builder of CfnDataSource.DatabaseConfigurationProperty