interface SqlKnowledgeBaseConfigurationProperty

Language	Type name
.NET	Amazon.CDK.aws_bedrock.CfnKnowledgeBase.SqlKnowledgeBaseConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnKnowledgeBase_SqlKnowledgeBaseConfigurationProperty
Java	software.amazon.awscdk.services.bedrock.CfnKnowledgeBase.SqlKnowledgeBaseConfigurationProperty
Python	aws_cdk.aws_bedrock.CfnKnowledgeBase.SqlKnowledgeBaseConfigurationProperty
TypeScript	aws-cdk-lib » aws_bedrock » CfnKnowledgeBase » SqlKnowledgeBaseConfigurationProperty

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-sqlknowledgebaseconfiguration.html

Example

// 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

Name	Type	Description
type	string	The type of SQL database to connect to the knowledge base.
redshiftConfiguration?	IResolvable | RedshiftConfigurationProperty	Specifies configurations for a knowledge base connected to an Amazon Redshift database.

---

type

Type: string

The type of SQL database to connect to the knowledge base.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-sqlknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-sqlknowledgebaseconfiguration-type

---

redshiftConfiguration?

Type: IResolvable | RedshiftConfigurationProperty (optional)

Specifies configurations for a knowledge base connected to an Amazon Redshift database.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-sqlknowledgebaseconfiguration.html#cfn-bedrock-knowledgebase-sqlknowledgebaseconfiguration-redshiftconfiguration