aws-cdk-lib.aws_bedrock.CfnKnowledgeBase.OpenSearchServerlessConfigurationProperty

OpenSearchServerlessConfigurationProperty Struct

Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service.

For more information, see Create a vector index in Amazon OpenSearch Service .

Source

Generated code

Type last changed

v2.140.0 · 2 May 2024

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 openSearchServerlessConfigurationProperty: bedrock.CfnKnowledgeBase.OpenSearchServerlessConfigurationProperty = {
  collectionArn: 'collectionArn',
  fieldMapping: {
    metadataField: 'metadataField',
    textField: 'textField',
    vectorField: 'vectorField',
  },
  vectorIndexName: 'vectorIndexName',
};

Properties

collectionArnstringcollection_arnstrcollectionArnStringCollectionArnstringCollectionArn*stringrequired#

The Amazon Resource Name (ARN) of the OpenSearch Service vector store.

fieldMappingIResolvable | CfnKnowledgeBase.OpenSearchServerlessFieldMappingPropertyfield_mappingtyping.Union[IResolvable, OpenSearchServerlessFieldMappingProperty]fieldMappingIResolvableFieldMappingIResolvableFieldMappinginterface{}required#

Contains the names of the fields to which to map information about the vector store.

vectorIndexNamestringvector_index_namestrvectorIndexNameStringVectorIndexNamestringVectorIndexName*stringrequired#

The name of the vector store.