Package software.amazon.awscdk.services.bedrock

Interface CfnKnowledgeBase.SqlKnowledgeBaseConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnKnowledgeBase.SqlKnowledgeBaseConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnKnowledgeBase
@Stability(Stable) public static interface CfnKnowledgeBase.SqlKnowledgeBaseConfigurationProperty extends software.amazon.jsii.JsiiSerializable
Contains configurations for a knowledge base connected to an SQL database.

Specify the SQL database type in the type field and include the corresponding field. For more information, see Build a knowledge base by connecting to a structured data source in the Amazon Bedrock User Guide.

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.bedrock.*;
 SqlKnowledgeBaseConfigurationProperty sqlKnowledgeBaseConfigurationProperty = SqlKnowledgeBaseConfigurationProperty.builder()
         .type("type")
         // the properties below are optional
         .redshiftConfiguration(RedshiftConfigurationProperty.builder()
                 .queryEngineConfiguration(RedshiftQueryEngineConfigurationProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .provisionedConfiguration(RedshiftProvisionedConfigurationProperty.builder()
                                 .authConfiguration(RedshiftProvisionedAuthConfigurationProperty.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .databaseUser("databaseUser")
                                         .usernamePasswordSecretArn("usernamePasswordSecretArn")
                                         .build())
                                 .clusterIdentifier("clusterIdentifier")
                                 .build())
                         .serverlessConfiguration(RedshiftServerlessConfigurationProperty.builder()
                                 .authConfiguration(RedshiftServerlessAuthConfigurationProperty.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .usernamePasswordSecretArn("usernamePasswordSecretArn")
                                         .build())
                                 .workgroupArn("workgroupArn")
                                 .build())
                         .build())
                 .storageConfigurations(List.of(RedshiftQueryEngineStorageConfigurationProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .awsDataCatalogConfiguration(RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty.builder()
                                 .tableNames(List.of("tableNames"))
                                 .build())
                         .redshiftConfiguration(RedshiftQueryEngineRedshiftStorageConfigurationProperty.builder()
                                 .databaseName("databaseName")
                                 .build())
                         .build()))
                 // the properties below are optional
                 .queryGenerationConfiguration(QueryGenerationConfigurationProperty.builder()
                         .executionTimeoutSeconds(123)
                         .generationContext(QueryGenerationContextProperty.builder()
                                 .curatedQueries(List.of(CuratedQueryProperty.builder()
                                         .naturalLanguage("naturalLanguage")
                                         .sql("sql")
                                         .build()))
                                 .tables(List.of(QueryGenerationTableProperty.builder()
                                         .name("name")
                                         // the properties below are optional
                                         .columns(List.of(QueryGenerationColumnProperty.builder()
                                                 .description("description")
                                                 .inclusion("inclusion")
                                                 .name("name")
                                                 .build()))
                                         .description("description")
                                         .inclusion("inclusion")
                                         .build()))
                                 .build())
                         .build())
                 .build())
         .build();

See Also: