AWS CDK Reference

Appearance

v2.275.0

SqlKnowledgeBaseConfigurationProperty Struct ​

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.

Source
Generated code
Type last changed
v2.177.0 · 25 Jan 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const sqlKnowledgeBaseConfigurationProperty: bedrock.CfnKnowledgeBase.SqlKnowledgeBaseConfigurationProperty = {
  type: 'type',

  // the properties below are optional
  redshiftConfiguration: {
    queryEngineConfiguration: {
      type: 'type',

      // the properties below are optional
      provisionedConfiguration: {
        authConfiguration: {
          type: 'type',

          // the properties below are optional
          databaseUser: 'databaseUser',
          usernamePasswordSecretArn: 'usernamePasswordSecretArn',
        },
        clusterIdentifier: 'clusterIdentifier',
      },
      serverlessConfiguration: {
        authConfiguration: {
          type: 'type',

          // the properties below are optional
          usernamePasswordSecretArn: 'usernamePasswordSecretArn',
        },
        workgroupArn: 'workgroupArn',
      },
    },
    storageConfigurations: [{
      type: 'type',

      // the properties below are optional
      awsDataCatalogConfiguration: {
        tableNames: ['tableNames'],
      },
      redshiftConfiguration: {
        databaseName: 'databaseName',
      },
    }],

    // the properties below are optional
    queryGenerationConfiguration: {
      executionTimeoutSeconds: 123,
      generationContext: {
        curatedQueries: [{
          naturalLanguage: 'naturalLanguage',
          sql: 'sql',
        }],
        tables: [{
          name: 'name',

          // the properties below are optional
          columns: [{
            description: 'description',
            inclusion: 'inclusion',
            name: 'name',
          }],
          description: 'description',
          inclusion: 'inclusion',
        }],
      },
    },
  },
};

Properties ​

redshiftConfigurationoptionalIResolvable | CfnKnowledgeBase.RedshiftConfigurationPropertyredshift_configurationoptionaltyping.Union[IResolvable, RedshiftConfigurationProperty]redshiftConfigurationoptionalIResolvableRedshiftConfigurationoptionalIResolvableRedshiftConfigurationoptionalinterface{}#
Specifies configurations for a knowledge base connected to an Amazon Redshift database.
typestringtypestrtypeStringTypestringType*stringrequired#
The type of SQL database to connect to the knowledge base.