Package software.amazon.awscdk.services.bedrock

Interface CfnKnowledgeBase.StorageConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBase.StorageConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnKnowledgeBase

@Stability(Stable)
public static interface CfnKnowledgeBase.StorageConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Contains the storage configuration of the knowledge base.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 StorageConfigurationProperty storageConfigurationProperty = StorageConfigurationProperty.builder()
         .type("type")
         // the properties below are optional
         .mongoDbAtlasConfiguration(MongoDbAtlasConfigurationProperty.builder()
                 .collectionName("collectionName")
                 .credentialsSecretArn("credentialsSecretArn")
                 .databaseName("databaseName")
                 .endpoint("endpoint")
                 .fieldMapping(MongoDbAtlasFieldMappingProperty.builder()
                         .metadataField("metadataField")
                         .textField("textField")
                         .vectorField("vectorField")
                         .build())
                 .vectorIndexName("vectorIndexName")
                 // the properties below are optional
                 .endpointServiceName("endpointServiceName")
                 .textIndexName("textIndexName")
                 .build())
         .neptuneAnalyticsConfiguration(NeptuneAnalyticsConfigurationProperty.builder()
                 .fieldMapping(NeptuneAnalyticsFieldMappingProperty.builder()
                         .metadataField("metadataField")
                         .textField("textField")
                         .build())
                 .graphArn("graphArn")
                 .build())
         .opensearchManagedClusterConfiguration(OpenSearchManagedClusterConfigurationProperty.builder()
                 .domainArn("domainArn")
                 .domainEndpoint("domainEndpoint")
                 .fieldMapping(OpenSearchManagedClusterFieldMappingProperty.builder()
                         .metadataField("metadataField")
                         .textField("textField")
                         .vectorField("vectorField")
                         .build())
                 .vectorIndexName("vectorIndexName")
                 .build())
         .opensearchServerlessConfiguration(OpenSearchServerlessConfigurationProperty.builder()
                 .collectionArn("collectionArn")
                 .fieldMapping(OpenSearchServerlessFieldMappingProperty.builder()
                         .metadataField("metadataField")
                         .textField("textField")
                         .vectorField("vectorField")
                         .build())
                 .vectorIndexName("vectorIndexName")
                 .build())
         .pineconeConfiguration(PineconeConfigurationProperty.builder()
                 .connectionString("connectionString")
                 .credentialsSecretArn("credentialsSecretArn")
                 .fieldMapping(PineconeFieldMappingProperty.builder()
                         .metadataField("metadataField")
                         .textField("textField")
                         .build())
                 // the properties below are optional
                 .namespace("namespace")
                 .build())
         .rdsConfiguration(RdsConfigurationProperty.builder()
                 .credentialsSecretArn("credentialsSecretArn")
                 .databaseName("databaseName")
                 .fieldMapping(RdsFieldMappingProperty.builder()
                         .metadataField("metadataField")
                         .primaryKeyField("primaryKeyField")
                         .textField("textField")
                         .vectorField("vectorField")
                         // the properties below are optional
                         .customMetadataField("customMetadataField")
                         .build())
                 .resourceArn("resourceArn")
                 .tableName("tableName")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBase.StorageConfigurationProperty.Builder	builder()
default Object	getMongoDbAtlasConfiguration()	Contains the storage configuration of the knowledge base in MongoDB Atlas.
default Object	getNeptuneAnalyticsConfiguration()	Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune.
default Object	getOpensearchManagedClusterConfiguration()	Contains details about the storage configuration of the knowledge base in OpenSearch Managed Cluster.
default Object	getOpensearchServerlessConfiguration()	Contains the storage configuration of the knowledge base in Amazon OpenSearch Service.
default Object	getPineconeConfiguration()	Contains the storage configuration of the knowledge base in Pinecone.
default Object	getRdsConfiguration()	Contains details about the storage configuration of the knowledge base in Amazon RDS.
String	getType()	The vector store service in which the knowledge base is stored.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getType

@Stability(Stable)
@NotNull
String getType()

The vector store service in which the knowledge base is stored.

See Also:

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

getMongoDbAtlasConfiguration

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

Contains the storage configuration of the knowledge base in MongoDB Atlas.

Returns union: either IResolvable or CfnKnowledgeBase.MongoDbAtlasConfigurationProperty

See Also:

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

getNeptuneAnalyticsConfiguration

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

Contains details about the Neptune Analytics configuration of the knowledge base in Amazon Neptune.

For more information, see Create a vector index in Amazon Neptune Analytics. .

Returns union: either IResolvable or CfnKnowledgeBase.NeptuneAnalyticsConfigurationProperty

See Also:

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

getOpensearchManagedClusterConfiguration

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

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

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

Returns union: either IResolvable or CfnKnowledgeBase.OpenSearchManagedClusterConfigurationProperty

See Also:

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

getOpensearchServerlessConfiguration

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

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

Returns union: either IResolvable or CfnKnowledgeBase.OpenSearchServerlessConfigurationProperty

See Also:

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

getPineconeConfiguration

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

Contains the storage configuration of the knowledge base in Pinecone.

Returns union: either IResolvable or CfnKnowledgeBase.PineconeConfigurationProperty

See Also:

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

getRdsConfiguration

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

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

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

Returns union: either IResolvable or CfnKnowledgeBase.RdsConfigurationProperty

See Also:

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

builder

@Stability(Stable)
static CfnKnowledgeBase.StorageConfigurationProperty.Builder builder()

Returns:

a CfnKnowledgeBase.StorageConfigurationProperty.Builder of CfnKnowledgeBase.StorageConfigurationProperty