aws-cdk-lib.aws_bedrock.CfnKnowledgeBase.QueryGenerationTableProperty

QueryGenerationTableProperty Struct

Contains information about a table for the query engine to consider.

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 queryGenerationTableProperty: bedrock.CfnKnowledgeBase.QueryGenerationTableProperty = {
  name: 'name',

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

Properties

columnsIResolvable | IResolvable | CfnKnowledgeBase.QueryGenerationColumnProperty[]columnstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, QueryGenerationColumnProperty]]]columnsIResolvableColumnsIResolvableColumnsinterface{}#

An array of objects, each of which defines information about a column in the table.

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

A description of the table that helps the query engine understand the contents of the table.

inclusionstringinclusionstrinclusionStringInclusionstringInclusion*string#

Specifies whether to include or exclude the table during query generation.

If you specify EXCLUDE , the table will be ignored. If you specify INCLUDE , all other tables will be ignored.

namestringnamestrnameStringNamestringName*stringrequired#

The name of the table for which the other fields in this object apply.