Class CfnKnowledgeBase.OpenSearchManagedClusterConfigurationProperty

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

Inheritance

object

CfnKnowledgeBase.OpenSearchManagedClusterConfigurationProperty

Implements

CfnKnowledgeBase.IOpenSearchManagedClusterConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Bedrock

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnKnowledgeBase.OpenSearchManagedClusterConfigurationProperty : CfnKnowledgeBase.IOpenSearchManagedClusterConfigurationProperty

Syntax (vb)

Public Class CfnKnowledgeBase.OpenSearchManagedClusterConfigurationProperty Implements CfnKnowledgeBase.IOpenSearchManagedClusterConfigurationProperty

Remarks

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

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Bedrock;

             var openSearchManagedClusterConfigurationProperty = new OpenSearchManagedClusterConfigurationProperty {
                 DomainArn = "domainArn",
                 DomainEndpoint = "domainEndpoint",
                 FieldMapping = new OpenSearchManagedClusterFieldMappingProperty {
                     MetadataField = "metadataField",
                     TextField = "textField",
                     VectorField = "vectorField"
                 },
                 VectorIndexName = "vectorIndexName"
             };

Synopsis

Constructors

OpenSearchManagedClusterConfigurationProperty()

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

Properties

DomainArn	The Amazon Resource Name (ARN) of the OpenSearch domain.
DomainEndpoint	The endpoint URL the OpenSearch domain.
FieldMapping	Contains the names of the fields to which to map information about the vector store.
VectorIndexName	The name of the vector store.

Constructors

OpenSearchManagedClusterConfigurationProperty()

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

public OpenSearchManagedClusterConfigurationProperty()

Remarks

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

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Bedrock;

             var openSearchManagedClusterConfigurationProperty = new OpenSearchManagedClusterConfigurationProperty {
                 DomainArn = "domainArn",
                 DomainEndpoint = "domainEndpoint",
                 FieldMapping = new OpenSearchManagedClusterFieldMappingProperty {
                     MetadataField = "metadataField",
                     TextField = "textField",
                     VectorField = "vectorField"
                 },
                 VectorIndexName = "vectorIndexName"
             };

Properties

DomainArn

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

public string DomainArn { get; set; }

Property Value

string

Remarks

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

DomainEndpoint

The endpoint URL the OpenSearch domain.

public string DomainEndpoint { get; set; }

Property Value

string

Remarks

FieldMapping

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

public object FieldMapping { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnKnowledgeBase.IOpenSearchManagedClusterFieldMappingProperty

VectorIndexName

The name of the vector store.

public string VectorIndexName { get; set; }