aws-cdk-lib.aws_bedrock.CfnKnowledgeBase.OpenSearchManagedClusterConfigurationProperty

OpenSearchManagedClusterConfigurationProperty Struct

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

For more information, see Create a vector index in OpenSearch Managed Cluster .

Source

Generated code

Type last changed

v2.190.0 · 17 Apr 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 openSearchManagedClusterConfigurationProperty: bedrock.CfnKnowledgeBase.OpenSearchManagedClusterConfigurationProperty = {
  domainArn: 'domainArn',
  domainEndpoint: 'domainEndpoint',
  fieldMapping: {
    metadataField: 'metadataField',
    textField: 'textField',
    vectorField: 'vectorField',
  },
  vectorIndexName: 'vectorIndexName',
};

Properties

domainArnstringdomain_arnstrdomainArnStringDomainArnstringDomainArn*stringrequired#

The Amazon Resource Name (ARN) of the OpenSearch domain.

domainEndpointstringdomain_endpointstrdomainEndpointStringDomainEndpointstringDomainEndpoint*stringrequired#

The endpoint URL the OpenSearch domain.

fieldMappingIResolvable | CfnKnowledgeBase.OpenSearchManagedClusterFieldMappingPropertyfield_mappingtyping.Union[IResolvable, OpenSearchManagedClusterFieldMappingProperty]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.