Class CfnKnowledgeBase
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.bedrock.CfnKnowledgeBase
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
date="2024-07-05T20:26:27.776Z")
@Stability(Stable)
public class CfnKnowledgeBase
extends CfnResource
implements IInspectable, ITaggableV2
Specifies a knowledge base as a resource in a top-level template. Minimally, you must specify the following properties:.
- Name – Specify a name for the knowledge base.
- RoleArn – Specify the Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base. For more information, see Create a service role for Knowledge base for Amazon Bedrock .
- KnowledgeBaseConfiguration – Specify the embeddings configuration of the knowledge base. The following sub-properties are required:
- Type – Specify the value
VECTOR
. - StorageConfiguration – Specify information about the vector store in which the data source is stored. The following sub-properties are required:
- Type – Specify the vector store service that you are using.
Redis Enterprise Cloud vector stores are currently unsupported in AWS CloudFormation .
For more information about using knowledge bases in Amazon Bedrock , see Knowledge base for Amazon Bedrock .
See the Properties section below for descriptions of both the required and optional properties.
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.*; CfnKnowledgeBase cfnKnowledgeBase = CfnKnowledgeBase.Builder.create(this, "MyCfnKnowledgeBase") .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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnKnowledgeBase
.static interface
Contains details about the embeddings configuration of the knowledge base.static interface
Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service.static interface
Contains the names of the fields to which to map information about the vector store.static interface
Contains details about the storage configuration of the knowledge base in Pinecone.static interface
Contains the names of the fields to which to map information about the vector store.static interface
Contains details about the storage configuration of the knowledge base in Amazon RDS.static interface
Contains the names of the fields to which to map information about the vector store.static interface
Contains the storage configuration of the knowledge base.static interface
Contains details about the model used to create vector embeddings for the knowledge base.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
CfnKnowledgeBase
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnKnowledgeBase
(software.amazon.jsii.JsiiObjectRef objRef) CfnKnowledgeBase
(software.constructs.Construct scope, String id, CfnKnowledgeBaseProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe time at which the knowledge base was created.A list of reasons that the API operation on the knowledge base failed.The Amazon Resource Name (ARN) of the knowledge base.The unique identifier of the knowledge base.The status of the knowledge base.The time at which the knowledge base was last updated.Tag Manager which manages the tags for this resource.The description of the knowledge base.Contains details about the embeddings configuration of the knowledge base.getName()
The name of the knowledge base.The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.Contains details about the storage configuration of the knowledge base.getTags()
Metadata that you can assign to a resource as key-value pairs.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setDescription
(String value) The description of the knowledge base.void
Contains details about the embeddings configuration of the knowledge base.void
Contains details about the embeddings configuration of the knowledge base.void
The name of the knowledge base.void
setRoleArn
(String value) The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.void
Contains details about the storage configuration of the knowledge base.void
Contains details about the storage configuration of the knowledge base.void
Metadata that you can assign to a resource as key-value pairs.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnKnowledgeBase
protected CfnKnowledgeBase(software.amazon.jsii.JsiiObjectRef objRef) -
CfnKnowledgeBase
protected CfnKnowledgeBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnKnowledgeBase
@Stability(Stable) public CfnKnowledgeBase(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnKnowledgeBaseProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrCreatedAt
The time at which the knowledge base was created. -
getAttrFailureReasons
A list of reasons that the API operation on the knowledge base failed. -
getAttrKnowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base. -
getAttrKnowledgeBaseId
The unique identifier of the knowledge base. -
getAttrStatus
The status of the knowledge base. -
getAttrUpdatedAt
The time at which the knowledge base was last updated. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getKnowledgeBaseConfiguration
Contains details about the embeddings configuration of the knowledge base. -
setKnowledgeBaseConfiguration
Contains details about the embeddings configuration of the knowledge base. -
setKnowledgeBaseConfiguration
@Stability(Stable) public void setKnowledgeBaseConfiguration(@NotNull CfnKnowledgeBase.KnowledgeBaseConfigurationProperty value) Contains details about the embeddings configuration of the knowledge base. -
getName
The name of the knowledge base. -
setName
The name of the knowledge base. -
getRoleArn
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base. -
setRoleArn
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base. -
getStorageConfiguration
Contains details about the storage configuration of the knowledge base. -
setStorageConfiguration
Contains details about the storage configuration of the knowledge base. -
setStorageConfiguration
@Stability(Stable) public void setStorageConfiguration(@NotNull CfnKnowledgeBase.StorageConfigurationProperty value) Contains details about the storage configuration of the knowledge base. -
getDescription
The description of the knowledge base. -
setDescription
The description of the knowledge base. -
getTags
Metadata that you can assign to a resource as key-value pairs.For more information, see the following resources:.
-
setTags
Metadata that you can assign to a resource as key-value pairs.For more information, see the following resources:.
-