Package software.amazon.awscdk.services.bedrock

Interface CfnKnowledgeBaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnKnowledgeBaseProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-22T22:42:48.172Z")
@Stability(Stable)
public interface CfnKnowledgeBaseProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnKnowledgeBase.

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.*;
 CfnKnowledgeBaseProps cfnKnowledgeBaseProps = CfnKnowledgeBaseProps.builder()
         .knowledgeBaseConfiguration(KnowledgeBaseConfigurationProperty.builder()
                 .type("type")
                 .vectorKnowledgeBaseConfiguration(VectorKnowledgeBaseConfigurationProperty.builder()
                         .embeddingModelArn("embeddingModelArn")
                         .build())
                 .build())
         .name("name")
         .roleArn("roleArn")
         .storageConfiguration(StorageConfigurationProperty.builder()
                 .type("type")
                 // the properties below are optional
                 .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")
                                 .build())
                         .resourceArn("resourceArn")
                         .tableName("tableName")
                         .build())
                 .build())
         // the properties below are optional
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnKnowledgeBaseProps.Builder	builder()
default String	getDescription()	The description of the knowledge base.
Object	getKnowledgeBaseConfiguration()	Contains details about the embeddings configuration of the knowledge base.
String	getName()	The name of the knowledge base.
String	getRoleArn()	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
Object	getStorageConfiguration()	Contains details about the storage configuration of the knowledge base.
default Map<String,String>	getTags()	Metadata that you can assign to a resource as key-value pairs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKnowledgeBaseConfiguration

@Stability(Stable)
@NotNull
Object getKnowledgeBaseConfiguration()

Contains details about the embeddings configuration of the knowledge base.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-knowledgebaseconfiguration

getName

@Stability(Stable)
@NotNull
String getName()

The name of the knowledge base.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-name

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-rolearn

getStorageConfiguration

@Stability(Stable)
@NotNull
Object getStorageConfiguration()

Contains details about the storage configuration of the knowledge base.

See Also:

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

getDescription

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

The description of the knowledge base.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-description

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

• Tag naming limits and requirements
• Tagging best practices

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-knowledgebase.html#cfn-bedrock-knowledgebase-tags

builder

@Stability(Stable)
static CfnKnowledgeBaseProps.Builder builder()

Returns:

a CfnKnowledgeBaseProps.Builder of CfnKnowledgeBaseProps