Package software.amazon.awscdk.services.bedrock

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.109.0 (build c221850)",
           date="2025-03-19T18:01:30.871Z")
@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")
                 // the properties below are optional
                 .kendraKnowledgeBaseConfiguration(KendraKnowledgeBaseConfigurationProperty.builder()
                         .kendraIndexArn("kendraIndexArn")
                         .build())
                 .sqlKnowledgeBaseConfiguration(SqlKnowledgeBaseConfigurationProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .redshiftConfiguration(RedshiftConfigurationProperty.builder()
                                 .queryEngineConfiguration(RedshiftQueryEngineConfigurationProperty.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .provisionedConfiguration(RedshiftProvisionedConfigurationProperty.builder()
                                                 .authConfiguration(RedshiftProvisionedAuthConfigurationProperty.builder()
                                                         .type("type")
                                                         // the properties below are optional
                                                         .databaseUser("databaseUser")
                                                         .usernamePasswordSecretArn("usernamePasswordSecretArn")
                                                         .build())
                                                 .clusterIdentifier("clusterIdentifier")
                                                 .build())
                                         .serverlessConfiguration(RedshiftServerlessConfigurationProperty.builder()
                                                 .authConfiguration(RedshiftServerlessAuthConfigurationProperty.builder()
                                                         .type("type")
                                                         // the properties below are optional
                                                         .usernamePasswordSecretArn("usernamePasswordSecretArn")
                                                         .build())
                                                 .workgroupArn("workgroupArn")
                                                 .build())
                                         .build())
                                 .storageConfigurations(List.of(RedshiftQueryEngineStorageConfigurationProperty.builder()
                                         .type("type")
                                         // the properties below are optional
                                         .awsDataCatalogConfiguration(RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty.builder()
                                                 .tableNames(List.of("tableNames"))
                                                 .build())
                                         .redshiftConfiguration(RedshiftQueryEngineRedshiftStorageConfigurationProperty.builder()
                                                 .databaseName("databaseName")
                                                 .build())
                                         .build()))
                                 // the properties below are optional
                                 .queryGenerationConfiguration(QueryGenerationConfigurationProperty.builder()
                                         .executionTimeoutSeconds(123)
                                         .generationContext(QueryGenerationContextProperty.builder()
                                                 .curatedQueries(List.of(CuratedQueryProperty.builder()
                                                         .naturalLanguage("naturalLanguage")
                                                         .sql("sql")
                                                         .build()))
                                                 .tables(List.of(QueryGenerationTableProperty.builder()
                                                         .name("name")
                                                         // the properties below are optional
                                                         .columns(List.of(QueryGenerationColumnProperty.builder()
                                                                 .description("description")
                                                                 .inclusion("inclusion")
                                                                 .name("name")
                                                                 .build()))
                                                         .description("description")
                                                         .inclusion("inclusion")
                                                         .build()))
                                                 .build())
                                         .build())
                                 .build())
                         .build())
                 .vectorKnowledgeBaseConfiguration(VectorKnowledgeBaseConfigurationProperty.builder()
                         .embeddingModelArn("embeddingModelArn")
                         // the properties below are optional
                         .embeddingModelConfiguration(EmbeddingModelConfigurationProperty.builder()
                                 .bedrockEmbeddingModelConfiguration(BedrockEmbeddingModelConfigurationProperty.builder()
                                         .dimensions(123)
                                         .embeddingDataType("embeddingDataType")
                                         .build())
                                 .build())
                         .supplementalDataStorageConfiguration(SupplementalDataStorageConfigurationProperty.builder()
                                 .supplementalDataStorageLocations(List.of(SupplementalDataStorageLocationProperty.builder()
                                         .supplementalDataStorageLocationType("supplementalDataStorageLocationType")
                                         // the properties below are optional
                                         .s3Location(S3LocationProperty.builder()
                                                 .uri("uri")
                                                 .build())
                                         .build()))
                                 .build())
                         .build())
                 .build())
         .name("name")
         .roleArn("roleArn")
         // the properties below are optional
         .description("description")
         .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())
         .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	Class	Description
static interface	CfnKnowledgeBase.BedrockEmbeddingModelConfigurationProperty	The vector configuration details for the Bedrock embeddings model.
static final class	CfnKnowledgeBase.Builder	A fluent builder for CfnKnowledgeBase.
static interface	CfnKnowledgeBase.CuratedQueryProperty	Contains configurations for a query, each of which defines information about example queries to help the query engine generate appropriate SQL queries.
static interface	CfnKnowledgeBase.EmbeddingModelConfigurationProperty	The configuration details for the embeddings model.
static interface	CfnKnowledgeBase.KendraKnowledgeBaseConfigurationProperty	Settings for an Amazon Kendra knowledge base.
static interface	CfnKnowledgeBase.KnowledgeBaseConfigurationProperty	Configurations to apply to a knowledge base attached to the agent during query.
static interface	CfnKnowledgeBase.OpenSearchServerlessConfigurationProperty	Contains details about the storage configuration of the knowledge base in Amazon OpenSearch Service.
static interface	CfnKnowledgeBase.OpenSearchServerlessFieldMappingProperty	Contains the names of the fields to which to map information about the vector store.
static interface	CfnKnowledgeBase.PineconeConfigurationProperty	Contains details about the storage configuration of the knowledge base in Pinecone.
static interface	CfnKnowledgeBase.PineconeFieldMappingProperty	Contains the names of the fields to which to map information about the vector store.
static interface	CfnKnowledgeBase.QueryGenerationColumnProperty	Contains information about a column in the current table for the query engine to consider.
static interface	CfnKnowledgeBase.QueryGenerationConfigurationProperty	Contains configurations for query generation.
static interface	CfnKnowledgeBase.QueryGenerationContextProperty
static interface	CfnKnowledgeBase.QueryGenerationTableProperty	Contains information about a table for the query engine to consider.
static interface	CfnKnowledgeBase.RdsConfigurationProperty	Contains details about the storage configuration of the knowledge base in Amazon RDS.
static interface	CfnKnowledgeBase.RdsFieldMappingProperty	Contains the names of the fields to which to map information about the vector store.
static interface	CfnKnowledgeBase.RedshiftConfigurationProperty	Contains configurations for an Amazon Redshift database.
static interface	CfnKnowledgeBase.RedshiftProvisionedAuthConfigurationProperty	Contains configurations for authentication to an Amazon Redshift provisioned data warehouse.
static interface	CfnKnowledgeBase.RedshiftProvisionedConfigurationProperty	Contains configurations for a provisioned Amazon Redshift query engine.
static interface	CfnKnowledgeBase.RedshiftQueryEngineAwsDataCatalogStorageConfigurationProperty	Contains configurations for storage in AWS Glue Data Catalog.
static interface	CfnKnowledgeBase.RedshiftQueryEngineConfigurationProperty	Contains configurations for an Amazon Redshift query engine.
static interface	CfnKnowledgeBase.RedshiftQueryEngineRedshiftStorageConfigurationProperty	Contains configurations for storage in Amazon Redshift.
static interface	CfnKnowledgeBase.RedshiftQueryEngineStorageConfigurationProperty	Contains configurations for Amazon Redshift data storage.
static interface	CfnKnowledgeBase.RedshiftServerlessAuthConfigurationProperty	Specifies configurations for authentication to a Redshift Serverless.
static interface	CfnKnowledgeBase.RedshiftServerlessConfigurationProperty	Contains configurations for authentication to Amazon Redshift Serverless.
static interface	CfnKnowledgeBase.S3LocationProperty	A storage location in an S3 bucket.
static interface	CfnKnowledgeBase.SqlKnowledgeBaseConfigurationProperty	Contains configurations for a knowledge base connected to an SQL database.
static interface	CfnKnowledgeBase.StorageConfigurationProperty	Contains the storage configuration of the knowledge base.
static interface	CfnKnowledgeBase.SupplementalDataStorageConfigurationProperty	Specifies configurations for the storage location of the images extracted from multimodal documents in your data source.
static interface	CfnKnowledgeBase.SupplementalDataStorageLocationProperty	Contains information about a storage location for images extracted from multimodal documents in your data source.
static interface	CfnKnowledgeBase.VectorKnowledgeBaseConfigurationProperty	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

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	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 Type	Method	Description
String	getAttrCreatedAt()	The time the knowledge base was created.
List<String>	getAttrFailureReasons()	A list of reasons that the API operation on the knowledge base failed.
String	getAttrKnowledgeBaseArn()	The Amazon Resource Name (ARN) of the knowledge base.
String	getAttrKnowledgeBaseId()	The unique identifier for a knowledge base associated with the inline agent.
String	getAttrStatus()	The status of the knowledge base.
String	getAttrUpdatedAt()	The time the knowledge base was last updated.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	The description of the knowledge base associated with the inline agent.
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.
Map<String,String>	getTags()	Metadata that you can assign to a resource as key-value pairs.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	The description of the knowledge base associated with the inline agent.
void	setKnowledgeBaseConfiguration(IResolvable value)	Contains details about the embeddings configuration of the knowledge base.
void	setKnowledgeBaseConfiguration(CfnKnowledgeBase.KnowledgeBaseConfigurationProperty value)	Contains details about the embeddings configuration of the knowledge base.
void	setName(String value)	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	setStorageConfiguration(IResolvable value)	Contains details about the storage configuration of the knowledge base.
void	setStorageConfiguration(CfnKnowledgeBase.StorageConfigurationProperty value)	Contains details about the storage configuration of the knowledge base.
void	setTags(Map<String,String> value)	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

@Stability(Stable)
public static final String 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

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

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 class CfnResource

Parameters:

props - This parameter is required.

getAttrCreatedAt

@Stability(Stable)
@NotNull
public String getAttrCreatedAt()

The time the knowledge base was created.

getAttrFailureReasons

@Stability(Stable)
@NotNull
public List<String> getAttrFailureReasons()

A list of reasons that the API operation on the knowledge base failed.

getAttrKnowledgeBaseArn

@Stability(Stable)
@NotNull
public String getAttrKnowledgeBaseArn()

The Amazon Resource Name (ARN) of the knowledge base.

getAttrKnowledgeBaseId

@Stability(Stable)
@NotNull
public String getAttrKnowledgeBaseId()

The unique identifier for a knowledge base associated with the inline agent.

getAttrStatus

@Stability(Stable)
@NotNull
public String getAttrStatus()

The status of the knowledge base.

getAttrUpdatedAt

@Stability(Stable)
@NotNull
public String getAttrUpdatedAt()

The time the knowledge base was last updated.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getKnowledgeBaseConfiguration

@Stability(Stable)
@NotNull
public Object getKnowledgeBaseConfiguration()

Contains details about the embeddings configuration of the knowledge base.

setKnowledgeBaseConfiguration

@Stability(Stable)
public void setKnowledgeBaseConfiguration(@NotNull
 IResolvable value)

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

@Stability(Stable)
@NotNull
public String getName()

The name of the knowledge base.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the knowledge base.

getRoleArn

@Stability(Stable)
@NotNull
public String getRoleArn()

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

setRoleArn

@Stability(Stable)
public void setRoleArn(@NotNull
 String value)

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

getDescription

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

The description of the knowledge base associated with the inline agent.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the knowledge base associated with the inline agent.

getStorageConfiguration

@Stability(Stable)
@Nullable
public Object getStorageConfiguration()

Contains details about the storage configuration of the knowledge base.

setStorageConfiguration

@Stability(Stable)
public void setStorageConfiguration(@Nullable
 IResolvable value)

Contains details about the storage configuration of the knowledge base.

setStorageConfiguration

@Stability(Stable)
public void setStorageConfiguration(@Nullable
 CfnKnowledgeBase.StorageConfigurationProperty value)

Contains details about the storage configuration of the knowledge base.

getTags

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

Metadata that you can assign to a resource as key-value pairs.

For more information, see the following resources:.

setTags

@Stability(Stable)
public void setTags(@Nullable
 Map<String,String> value)

Metadata that you can assign to a resource as key-value pairs.

For more information, see the following resources:.