AWS::Bedrock::KnowledgeBase

Bedrock KnowledgeBase

Definition of AWS::Bedrock::KnowledgeBase Resource Type

Properties

6 configurable properties. 3 required. Click a row to see details.

Filter:

Property	Type	Flags
`KnowledgeBaseConfiguration`	`KnowledgeBaseConfiguration`	Required
`Name`	`string`	Required
`RoleArn`	`string`	Required
`Description`	`string`
`StorageConfiguration`	`StorageConfiguration`	Create-only
`Tags`	`TagsMap`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`CreatedAt`	`string`	The time at which the knowledge base was created.
`FailureReasons`	`Array<string>`	A list of reasons that the API operation on the knowledge base failed.
`KnowledgeBaseArn`	`string`	The ARN of the knowledge base.
`KnowledgeBaseId`	`string`	The unique identifier of the knowledge base.
`Status`	`string`	-
`UpdatedAt`	`string`	The time at which the knowledge base was last updated.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Bedrock::KnowledgeBase

Resources:
  MyResource:
    Type: AWS::Bedrock::KnowledgeBase
    Properties:
      KnowledgeBaseConfiguration: "value"
      Name: "my-name"
      RoleArn: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

bedrock:CreateKnowledgeBasebedrock:GetKnowledgeBasebedrock:TagResourcebedrock:ListTagsForResourcebedrock:AssociateThirdPartyKnowledgeBaseiam:PassRole

read

bedrock:GetKnowledgeBasebedrock:ListTagsForResource

update

bedrock:GetKnowledgeBasebedrock:UpdateKnowledgeBasebedrock:TagResourcebedrock:UntagResourcebedrock:ListTagsForResourcebedrock:AssociateThirdPartyKnowledgeBaseiam:PassRole

delete

bedrock:GetKnowledgeBasebedrock:DeleteKnowledgeBasebedrock:ListDataSources

list

bedrock:ListKnowledgeBases

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceBedrock

Properties12

Required3

TaggingSupported

Primary IDKnowledgeBaseId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

StorageConfigurationKnowledgeBaseConfiguration/TypeKnowledgeBaseConfiguration/VectorKnowledgeBaseConfigurationKnowledgeBaseConfiguration/KendraKnowledgeBaseConfigurationKnowledgeBaseConfiguration/SqlKnowledgeBaseConfiguration/TypeKnowledgeBaseConfiguration/SqlKnowledgeBaseConfiguration/RedshiftConfiguration/StorageConfigurationsKnowledgeBaseConfiguration/SqlKnowledgeBaseConfiguration/RedshiftConfiguration/QueryEngineConfiguration

Related Resources

External Links

AWS Documentation