Package software.amazon.awscdk.cfnpropertymixins.services.bedrock

Interface CfnKnowledgeBasePropsMixin.OpenSearchServerlessConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBasePropsMixin.OpenSearchServerlessConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBasePropsMixin

@Stability(Stable)
public static interface CfnKnowledgeBasePropsMixin.OpenSearchServerlessConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.bedrock.*;
 OpenSearchServerlessConfigurationProperty openSearchServerlessConfigurationProperty = OpenSearchServerlessConfigurationProperty.builder()
         .collectionArn("collectionArn")
         .fieldMapping(OpenSearchServerlessFieldMappingProperty.builder()
                 .metadataField("metadataField")
                 .textField("textField")
                 .vectorField("vectorField")
                 .build())
         .vectorIndexName("vectorIndexName")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnKnowledgeBasePropsMixin.OpenSearchServerlessConfigurationProperty.Builder	A builder for CfnKnowledgeBasePropsMixin.OpenSearchServerlessConfigurationProperty
static final class	CfnKnowledgeBasePropsMixin.OpenSearchServerlessConfigurationProperty.Jsii$Proxy	An implementation for CfnKnowledgeBasePropsMixin.OpenSearchServerlessConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBasePropsMixin.OpenSearchServerlessConfigurationProperty.Builder	builder()
default String	getCollectionArn()	The Amazon Resource Name (ARN) of the OpenSearch Service vector store.
default Object	getFieldMapping()	Contains the names of the fields to which to map information about the vector store.
default String	getVectorIndexName()	The name of the vector store.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCollectionArn

@Stability(Stable)
@Nullable
default String getCollectionArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessconfiguration.html#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-collectionarn

getFieldMapping

@Stability(Stable)
@Nullable
default Object getFieldMapping()

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

Returns union: either IResolvable or CfnKnowledgeBasePropsMixin.OpenSearchServerlessFieldMappingProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessconfiguration.html#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-fieldmapping

getVectorIndexName

@Stability(Stable)
@Nullable
default String getVectorIndexName()

The name of the vector store.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-knowledgebase-opensearchserverlessconfiguration.html#cfn-bedrock-knowledgebase-opensearchserverlessconfiguration-vectorindexname

builder

@Stability(Stable)
static CfnKnowledgeBasePropsMixin.OpenSearchServerlessConfigurationProperty.Builder builder()

Returns:

a CfnKnowledgeBasePropsMixin.OpenSearchServerlessConfigurationProperty.Builder of CfnKnowledgeBasePropsMixin.OpenSearchServerlessConfigurationProperty