This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Bedrock::KnowledgeBase RdsFieldMapping
<a name="aws-properties-bedrock-knowledgebase-rdsfieldmapping"></a>

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

## Syntax
<a name="aws-properties-bedrock-knowledgebase-rdsfieldmapping-syntax"></a>

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

### JSON
<a name="aws-properties-bedrock-knowledgebase-rdsfieldmapping-syntax.json"></a>

```
{
  "[CustomMetadataField](#cfn-bedrock-knowledgebase-rdsfieldmapping-custommetadatafield)" : {{String}},
  "[MetadataField](#cfn-bedrock-knowledgebase-rdsfieldmapping-metadatafield)" : {{String}},
  "[PrimaryKeyField](#cfn-bedrock-knowledgebase-rdsfieldmapping-primarykeyfield)" : {{String}},
  "[TextField](#cfn-bedrock-knowledgebase-rdsfieldmapping-textfield)" : {{String}},
  "[VectorField](#cfn-bedrock-knowledgebase-rdsfieldmapping-vectorfield)" : {{String}}
}
```

### YAML
<a name="aws-properties-bedrock-knowledgebase-rdsfieldmapping-syntax.yaml"></a>

```
  [CustomMetadataField](#cfn-bedrock-knowledgebase-rdsfieldmapping-custommetadatafield): {{String}}
  [MetadataField](#cfn-bedrock-knowledgebase-rdsfieldmapping-metadatafield): {{String}}
  [PrimaryKeyField](#cfn-bedrock-knowledgebase-rdsfieldmapping-primarykeyfield): {{String}}
  [TextField](#cfn-bedrock-knowledgebase-rdsfieldmapping-textfield): {{String}}
  [VectorField](#cfn-bedrock-knowledgebase-rdsfieldmapping-vectorfield): {{String}}
```

## Properties
<a name="aws-properties-bedrock-knowledgebase-rdsfieldmapping-properties"></a>

`CustomMetadataField`  <a name="cfn-bedrock-knowledgebase-rdsfieldmapping-custommetadatafield"></a>
Provide a name for the universal metadata field where Amazon Bedrock will store any custom metadata from your data source.  
*Required*: No  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_\-]+$`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`MetadataField`  <a name="cfn-bedrock-knowledgebase-rdsfieldmapping-metadatafield"></a>
The name of the field in which Amazon Bedrock stores metadata about the vector store.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_\-]+$`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PrimaryKeyField`  <a name="cfn-bedrock-knowledgebase-rdsfieldmapping-primarykeyfield"></a>
The name of the field in which Amazon Bedrock stores the ID for each entry.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_\-]+$`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TextField`  <a name="cfn-bedrock-knowledgebase-rdsfieldmapping-textfield"></a>
The name of the field in which Amazon Bedrock stores the raw text from your data. The text is split according to the chunking strategy you choose.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_\-]+$`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`VectorField`  <a name="cfn-bedrock-knowledgebase-rdsfieldmapping-vectorfield"></a>
The name of the field in which Amazon Bedrock stores the vector embeddings for your data sources.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^[a-zA-Z0-9_\-]+$`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)