Package software.amazon.awscdk.cfnpropertymixins.services.kendra

Interface CfnDataSourcePropsMixin.DatabaseConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSourcePropsMixin.DatabaseConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSourcePropsMixin

@Stability(Stable)
public static interface CfnDataSourcePropsMixin.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.cfnpropertymixins.services.kendra.*;
 DatabaseConfigurationProperty databaseConfigurationProperty = DatabaseConfigurationProperty.builder()
         .aclConfiguration(AclConfigurationProperty.builder()
                 .allowedGroupsColumnName("allowedGroupsColumnName")
                 .build())
         .columnConfiguration(ColumnConfigurationProperty.builder()
                 .changeDetectingColumns(List.of("changeDetectingColumns"))
                 .documentDataColumnName("documentDataColumnName")
                 .documentIdColumnName("documentIdColumnName")
                 .documentTitleColumnName("documentTitleColumnName")
                 .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                         .dataSourceFieldName("dataSourceFieldName")
                         .dateFieldFormat("dateFieldFormat")
                         .indexFieldName("indexFieldName")
                         .build()))
                 .build())
         .connectionConfiguration(ConnectionConfigurationProperty.builder()
                 .databaseHost("databaseHost")
                 .databaseName("databaseName")
                 .databasePort(123)
                 .secretArn("secretArn")
                 .tableName("tableName")
                 .build())
         .databaseEngineType("databaseEngineType")
         .sqlConfiguration(SqlConfigurationProperty.builder()
                 .queryIdentifiersEnclosingOption("queryIdentifiersEnclosingOption")
                 .build())
         .vpcConfiguration(DataSourceVpcConfigurationProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSourcePropsMixin.DatabaseConfigurationProperty.Builder	builder()
default Object	getAclConfiguration()	Information about the database column that provides information for user context filtering.
default Object	getColumnConfiguration()	Information about where the index should get the document information from the database.
default Object	getConnectionConfiguration()	Configuration information that's required to connect to a database.
default 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 Details

getAclConfiguration

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

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

Returns union: either IResolvable or CfnDataSourcePropsMixin.AclConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-aclconfiguration

getColumnConfiguration

@Stability(Stable)
@Nullable
default Object getColumnConfiguration()

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

Returns union: either IResolvable or CfnDataSourcePropsMixin.ColumnConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-columnconfiguration

getConnectionConfiguration

@Stability(Stable)
@Nullable
default Object getConnectionConfiguration()

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

Returns union: either IResolvable or CfnDataSourcePropsMixin.ConnectionConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-connectionconfiguration

getDatabaseEngineType

@Stability(Stable)
@Nullable
default String getDatabaseEngineType()

The type of database engine that runs the database.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-databaseenginetype

getSqlConfiguration

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

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

Returns union: either IResolvable or CfnDataSourcePropsMixin.SqlConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-sqlconfiguration

getVpcConfiguration

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

Provides information for connecting to an Amazon VPC.

Returns union: either IResolvable or CfnDataSourcePropsMixin.DataSourceVpcConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-databaseconfiguration.html#cfn-kendra-datasource-databaseconfiguration-vpcconfiguration

builder

@Stability(Stable)
static CfnDataSourcePropsMixin.DatabaseConfigurationProperty.Builder builder()

Returns:

a CfnDataSourcePropsMixin.DatabaseConfigurationProperty.Builder of CfnDataSourcePropsMixin.DatabaseConfigurationProperty