@cdklabs/generative-ai-cdk-constructs
@cdklabs/generative-ai-cdk-constructs / bedrock / KnowledgeBaseBase
abstract KnowledgeBaseBaseAbstract base class for Knowledge Base (regarless the type). Contains methods valid for KBs either created with CDK or imported and applicable to Knowledge Bases of any type.
Resourcenew KnowledgeBaseBase(
scope,id):KnowledgeBaseBase
Construct
string
Resource.constructor
abstractreadonlyoptionaldescription:string
The description of the knowledge base.
readonlyenv:ResourceEnvironment
The environment this resource belongs to. For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
Resource.env
abstractreadonlyoptionalinstruction:string
A narrative instruction of the knowledge base. A Bedrock Agent can use this instruction to determine if it should query this Knowledge Base.
abstractreadonlyknowledgeBaseArn:string
The ARN of the knowledge base.
"arn:aws:bedrock:us-east-1:123456789012:knowledge-base/KB12345678"
IKnowledgeBase.knowledgeBaseArn
abstractreadonlyknowledgeBaseId:string
The ID of the knowledge base.
"KB12345678"
IKnowledgeBase.knowledgeBaseId
readonlynode:Node
The tree node.
Resource.node
protectedreadonlyphysicalName:string
Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
This value will resolve to one of the following:
"my-awesome-bucket")undefined, when a name should be generated by CloudFormationResource.physicalName
abstractreadonlyrole:IRole
The role associated with the knowledge base.
readonlystack:Stack
The stack in which this resource is defined.
Resource.stack
abstractreadonlytype:KnowledgeBaseType
The type of knowledge base.
_enableCrossEnvironment():
void
Internal
Called when this resource is referenced across environments (account/region) to order to request that a physical name will be generated for this resource during synthesis, so the resource can be referenced through its absolute name/arn.
void
Resource._enableCrossEnvironment
applyRemovalPolicy(
policy):void
Apply the given removal policy to this resource
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN).
RemovalPolicy
void
IKnowledgeBase.applyRemovalPolicy
Resource.applyRemovalPolicy
protectedgeneratePhysicalName():string
string
Resource.generatePhysicalName
protectedgetResourceArnAttribute(arnAttr,arnComponents):string
Returns an environment-sensitive token that should be used for the
resource’s “ARN” attribute (e.g. bucket.bucketArn).
Normally, this token will resolve to arnAttr, but if the resource is
referenced across environments, arnComponents will be used to synthesize
a concrete ARN with the resource’s physical name. Make sure to reference
this.physicalName in arnComponents.
string
The CFN attribute which resolves to the ARN of the resource.
Commonly it will be called “Arn” (e.g. resource.attrArn), but sometimes
it’s the CFN resource’s ref.
ArnComponents
The format of the ARN of this resource. You must
reference this.physicalName somewhere within the ARN in order for
cross-environment references to work.
string
Resource.getResourceArnAttribute
protectedgetResourceNameAttribute(nameAttr):string
Returns an environment-sensitive token that should be used for the
resource’s “name” attribute (e.g. bucket.bucketName).
Normally, this token will resolve to nameAttr, but if the resource is
referenced across environments, it will be resolved to this.physicalName,
which will be a concrete name.
string
The CFN attribute which resolves to the resource’s name.
Commonly this is the resource’s ref.
string
Resource.getResourceNameAttribute
grant(
grantee, …actions):Grant
Grant the given principal identity permissions to perform actions on this knowledge base.
IGrantable
…string[]
Grant
grantQuery(
grantee):Grant
Grant the given identity permissions to query the knowledge base. This contains:
IGrantable
Grant
grantRetrieve(
grantee):Grant
Grant the given identity permissions to retrieve content from the knowledge base.
IGrantable
Grant
grantRetrieveAndGenerate(
grantee):Grant
Grant the given identity permissions to retrieve content from the knowledge base.
IGrantable
Grant
toString():
string
Returns a string representation of this construct.
string
Resource.toString
staticisConstruct(x):x is Construct
Checks if x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
any
Any object
x is Construct
true if x is an object created from a class which extends Construct.
Resource.isConstruct
staticisOwnedResource(construct):boolean
Returns true if the construct was created by CDK, and false otherwise
IConstruct
boolean
Resource.isOwnedResource
staticisResource(construct):construct is Resource
Check whether the given construct is a Resource
IConstruct
construct is Resource
Resource.isResource