aws-cdk-lib.aws_bedrock.CfnKnowledgeBase.RedshiftConfigurationProperty

RedshiftConfigurationProperty Struct

Contains configurations for an Amazon Redshift database.

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

// 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 redshiftConfigurationProperty: bedrock.CfnKnowledgeBase.RedshiftConfigurationProperty = {
  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

queryEngineConfigurationIResolvable | CfnKnowledgeBase.RedshiftQueryEngineConfigurationPropertyquery_engine_configurationtyping.Union[IResolvable, RedshiftQueryEngineConfigurationProperty]queryEngineConfigurationIResolvableQueryEngineConfigurationIResolvableQueryEngineConfigurationinterface{}required#

Specifies configurations for an Amazon Redshift query engine.

queryGenerationConfiguration?optionalIResolvable | CfnKnowledgeBase.QueryGenerationConfigurationPropertyquery_generation_configuration?optionaltyping.Union[IResolvable, QueryGenerationConfigurationProperty]queryGenerationConfiguration?optionalIResolvableQueryGenerationConfiguration?optionalIResolvableQueryGenerationConfiguration?optionalinterface{}#

Specifies configurations for generating queries.

storageConfigurationsIResolvable | IResolvable | CfnKnowledgeBase.RedshiftQueryEngineStorageConfigurationProperty[]storage_configurationstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, RedshiftQueryEngineStorageConfigurationProperty]]]storageConfigurationsIResolvableStorageConfigurationsIResolvableStorageConfigurationsinterface{}required#

Specifies configurations for Amazon Redshift database storage.