AWS::Bedrock::KnowledgeBase RdsConfiguration - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Bedrock::KnowledgeBase RdsConfiguration

Contains details about the storage configuration of the knowledge base in Amazon RDS. For more information, see Create a vector index in Amazon RDS.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "CredentialsSecretArn" : String,
  "DatabaseName" : String,
  "FieldMapping" : RdsFieldMapping,
  "ResourceArn" : String,
  "TableName" : String
}

Properties

CredentialsSecretArn

The Amazon Resource Name (ARN) of the secret that you created in AWS Secrets Manager that is linked to your Amazon RDS database.

Required: Yes

Type: String

Pattern: ^arn:aws(|-cn|-us-gov):secretsmanager:[a-z0-9-]{1,20}:([0-9]{12}|):secret:[a-zA-Z0-9!/_+=.@-]{1,512}$

Update requires: Replacement

DatabaseName

The name of your Amazon RDS database.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_\-]+$

Maximum: 63

Update requires: Replacement

FieldMapping

Contains the names of the fields to which to map information about the vector store.

Required: Yes

Type: RdsFieldMapping

Update requires: Replacement

ResourceArn

The Amazon Resource Name (ARN) of the vector store.

Required: Yes

Type: String

Pattern: ^arn:aws(|-cn|-us-gov):rds:[a-zA-Z0-9-]*:[0-9]{12}:cluster:[a-zA-Z0-9-]{1,63}$

Update requires: Replacement

TableName

The name of the table in the database.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_\.\-]+$

Maximum: 63

Update requires: Replacement