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::Kendra::Index DocumentMetadataConfiguration
<a name="aws-properties-kendra-index-documentmetadataconfiguration"></a>

Specifies the properties, such as relevance tuning and searchability, of an index field.

## Syntax
<a name="aws-properties-kendra-index-documentmetadataconfiguration-syntax"></a>

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

### JSON
<a name="aws-properties-kendra-index-documentmetadataconfiguration-syntax.json"></a>

```
{
  "[Name](#cfn-kendra-index-documentmetadataconfiguration-name)" : String,
  "[Relevance](#cfn-kendra-index-documentmetadataconfiguration-relevance)" : Relevance,
  "[Search](#cfn-kendra-index-documentmetadataconfiguration-search)" : Search,
  "[Type](#cfn-kendra-index-documentmetadataconfiguration-type)" : String
}
```

### YAML
<a name="aws-properties-kendra-index-documentmetadataconfiguration-syntax.yaml"></a>

```
  [Name](#cfn-kendra-index-documentmetadataconfiguration-name): String
  [Relevance](#cfn-kendra-index-documentmetadataconfiguration-relevance): 
    Relevance
  [Search](#cfn-kendra-index-documentmetadataconfiguration-search): 
    Search
  [Type](#cfn-kendra-index-documentmetadataconfiguration-type): String
```

## Properties
<a name="aws-properties-kendra-index-documentmetadataconfiguration-properties"></a>

`Name`  <a name="cfn-kendra-index-documentmetadataconfiguration-name"></a>
The name of the index field.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `30`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Relevance`  <a name="cfn-kendra-index-documentmetadataconfiguration-relevance"></a>
Provides tuning parameters to determine how the field affects the search results.  
*Required*: No  
*Type*: [Relevance](aws-properties-kendra-index-relevance.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Search`  <a name="cfn-kendra-index-documentmetadataconfiguration-search"></a>
Provides information about how the field is used during a search.  
*Required*: No  
*Type*: [Search](aws-properties-kendra-index-search.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-kendra-index-documentmetadataconfiguration-type"></a>
The data type of the index field.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `STRING_VALUE | STRING_LIST_VALUE | LONG_VALUE | DATE_VALUE`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)