interface OpenSearchManagedClusterConfigurationProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins.CfnKnowledgeBasePropsMixin.OpenSearchManagedClusterConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsbedrock/mixins#CfnKnowledgeBasePropsMixin_OpenSearchManagedClusterConfigurationProperty
Java	software.amazon.awscdk.mixins.preview.services.bedrock.mixins.CfnKnowledgeBasePropsMixin.OpenSearchManagedClusterConfigurationProperty
Python	aws_cdk.mixins_preview.aws_bedrock.mixins.CfnKnowledgeBasePropsMixin.OpenSearchManagedClusterConfigurationProperty
TypeScript	@aws-cdk/mixins-preview » aws_bedrock » mixins » CfnKnowledgeBasePropsMixin » OpenSearchManagedClusterConfigurationProperty

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 .

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as bedrock_mixins } from '@aws-cdk/mixins-preview/aws-bedrock';
const openSearchManagedClusterConfigurationProperty: bedrock_mixins.CfnKnowledgeBasePropsMixin.OpenSearchManagedClusterConfigurationProperty = {
  domainArn: 'domainArn',
  domainEndpoint: 'domainEndpoint',
  fieldMapping: {
    metadataField: 'metadataField',
    textField: 'textField',
    vectorField: 'vectorField',
  },
  vectorIndexName: 'vectorIndexName',
};

Properties

Name	Type	Description
domainArn?	string	The Amazon Resource Name (ARN) of the OpenSearch domain.
domainEndpoint?	string	The endpoint URL the OpenSearch domain.
fieldMapping?	IResolvable | OpenSearchManagedClusterFieldMappingProperty	Contains the names of the fields to which to map information about the vector store.
vectorIndexName?	string	The name of the vector store.

---

domainArn?

Type: string (optional)

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

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

---

domainEndpoint?

Type: string (optional)

The endpoint URL the OpenSearch domain.

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

---

fieldMapping?

Type: IResolvable | OpenSearchManagedClusterFieldMappingProperty (optional)

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

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

---

vectorIndexName?

Type: string (optional)

The name of the vector store.

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