Class BedrockKnowledgeBaseL3Construct

Hierarchy

MdaaL3Construct
- BedrockKnowledgeBaseL3Construct

Index

Constructors

constructor

new BedrockKnowledgeBaseL3Construct(
    scope: Construct,
    id: string,
    props: BedrockKnowledgeBaseL3ConstructProps,
): BedrockKnowledgeBaseL3Construct
Parameters
- scope: Construct
- id: string
- props: BedrockKnowledgeBaseL3ConstructProps
Returns BedrockKnowledgeBaseL3Construct
Overrides MdaaL3Construct.constructor
- Defined in packages/constructs/L3/ai/bedrock-knowledge-base-l3-construct/lib/bedrock-knowledge-base-l3-construct.ts:350

Properties

`Protected` `Readonly`baseprops

baseprops: MdaaL3ConstructProps

`Readonly`kbRole

kbRole: IRole

The execution role used by this knowledge base

`Readonly`knowledgeBase

knowledgeBase: CfnKnowledgeBase

`Readonly`node

node: Node

The tree node.

`Readonly`props

props: BedrockKnowledgeBaseL3ConstructProps

`Protected` `Readonly`scope

scope: Construct

`Readonly`vectorStore

vectorStore: MdaaAuroraPgVector | MdaaOpensearchServerlessCollection

Jsii

ignore

Accessors

`Protected`account

get account(): string
Returns string
Inherited from MdaaL3Construct.account
- Defined in packages/constructs/L3/core/l3-construct/lib/l3construct.d.ts:30

`Protected`partition

get partition(): string
Returns string
Inherited from MdaaL3Construct.partition
- Defined in packages/constructs/L3/core/l3-construct/lib/l3construct.d.ts:29

`Protected`region

get region(): string
Returns string
Inherited from MdaaL3Construct.region
- Defined in packages/constructs/L3/core/l3-construct/lib/l3construct.d.ts:31

Methods

getCrossAccountStack

getCrossAccountStack(account?: string, region?: string): Stack | undefined
Parameters
- Optionalaccount: string
- Optionalregion: string
Returns Stack | undefined
Inherited from MdaaL3Construct.getCrossAccountStack
- Defined in packages/constructs/L3/core/l3-construct/lib/l3construct.d.ts:27

`Protected`getFirstCrossAccountRegion

getFirstCrossAccountRegion(account: string): string
Parameters
- account: string
Returns string
Inherited from MdaaL3Construct.getFirstCrossAccountRegion
- Defined in packages/constructs/L3/core/l3-construct/lib/l3construct.d.ts:28

toString

toString(): string
Returns a string representation of this construct.

Returns string
Inherited from MdaaL3Construct.toString
- Defined in node_modules/constructs/lib/construct.d.ts:261

`Static`createDataSyncPolicy

createDataSyncPolicy(
    scope: Construct,
    naming: IMdaaResourceNaming,
    nameSuffix: string,
    kbIds: string[],
): MdaaManagedPolicy
Creates a data sync policy for knowledge base(s). Can be used for single KB (single-element arrays) or consolidated policies (multi-element arrays).
Parameters
- scope: Construct
  The construct scope
- naming: IMdaaResourceNaming
  The naming configuration
- nameSuffix: string
  Identifier for the policy name (e.g., KB name or role identifier)
- kbIds: string[]
  Array of knowledge base IDs
Returns MdaaManagedPolicy
The created managed policy
- Defined in packages/constructs/L3/ai/bedrock-knowledge-base-l3-construct/lib/bedrock-knowledge-base-l3-construct.ts:1189

`Static`createFoundationModelPolicy

createFoundationModelPolicy(
    scope: Construct,
    naming: IMdaaResourceNaming,
    nameSuffix: string,
    namedKbConfigs: NamedKbConfig[],
    kmsKey: IKey,
): MdaaManagedPolicy
Creates a foundation model policy for knowledge base(s). Can be used for single KB (single-element arrays) or consolidated policies (multi-element arrays). Creates a separate statement for each KB config.
Parameters
- scope: Construct
  The construct scope
- naming: IMdaaResourceNaming
  The naming configuration
- nameSuffix: string
  Suffix for the policy name (e.g., KB name or role identifier)
- namedKbConfigs: NamedKbConfig[]
  Array of named knowledge base configurations
- kmsKey: IKey
  KMS key for encryption
Returns MdaaManagedPolicy
The created managed policy
- Defined in packages/constructs/L3/ai/bedrock-knowledge-base-l3-construct/lib/bedrock-knowledge-base-l3-construct.ts:646

`Static`createVectorStorePolicy

createVectorStorePolicy(
    scope: Construct,
    naming: IMdaaResourceNaming,
    nameSuffix: string,
    stores: (MdaaAuroraPgVector | MdaaOpensearchServerlessCollection)[],
    kmsKey: IKey,
): MdaaManagedPolicy
Creates a vector store access policy for knowledge base(s). Handles both Aurora PostgreSQL and OpenSearch Serverless vector stores. Can be used for single store or consolidated policies for multiple stores.
Parameters
- scope: Construct
  The construct scope
- naming: IMdaaResourceNaming
  The naming configuration
- nameSuffix: string
  Suffix for the policy name (e.g., KB name or role identifier)
- stores: (MdaaAuroraPgVector | MdaaOpensearchServerlessCollection)[]
  Array of vector stores (Aurora or OpenSearch)
- kmsKey: IKey
  KMS key for encryption (required for Aurora stores)
Returns MdaaManagedPolicy
The created managed policy
- Defined in packages/constructs/L3/ai/bedrock-knowledge-base-l3-construct/lib/bedrock-knowledge-base-l3-construct.ts:729

`Static`isConstruct

isConstruct(x: any): 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.
Parameters
- x: any
  Any object
Returns x is Construct
true if x is an object created from a class which extends Construct.
Inherited from MdaaL3Construct.isConstruct
- Defined in node_modules/constructs/lib/construct.d.ts:243

Class BedrockKnowledgeBaseL3Construct

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns BedrockKnowledgeBaseL3Construct

Properties

Protected Readonlybaseprops

ReadonlykbRole

ReadonlyknowledgeBase

Readonlynode

Readonlyprops

Protected Readonlyscope

ReadonlyvectorStore

Jsii

Accessors

Protectedaccount

Returns string

Protectedpartition

Returns string

Protectedregion

Returns string

Methods

getCrossAccountStack

Parameters

Returns Stack | undefined

ProtectedgetFirstCrossAccountRegion

Parameters

Returns string

toString

Returns string

StaticcreateDataSyncPolicy

Parameters

Returns MdaaManagedPolicy

StaticcreateFoundationModelPolicy

Parameters

Returns MdaaManagedPolicy

StaticcreateVectorStorePolicy

Parameters

Returns MdaaManagedPolicy

StaticisConstruct

Parameters

Returns x is Construct

Settings

On This Page

`Protected` `Readonly`baseprops

`Readonly`kbRole

`Readonly`knowledgeBase

`Readonly`node

`Readonly`props

`Protected` `Readonly`scope

`Readonly`vectorStore

`Protected`account

`Protected`partition

`Protected`region

`Protected`getFirstCrossAccountRegion

`Static`createDataSyncPolicy

`Static`createFoundationModelPolicy

`Static`createVectorStorePolicy

`Static`isConstruct