

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::Lex::Bot CustomVocabularyItem
<a name="aws-properties-lex-bot-customvocabularyitem"></a>

Specifies an entry in a custom vocabulary.

## Syntax
<a name="aws-properties-lex-bot-customvocabularyitem-syntax"></a>

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

### JSON
<a name="aws-properties-lex-bot-customvocabularyitem-syntax.json"></a>

```
{
  "[DisplayAs](#cfn-lex-bot-customvocabularyitem-displayas)" : {{String}},
  "[Phrase](#cfn-lex-bot-customvocabularyitem-phrase)" : {{String}},
  "[Weight](#cfn-lex-bot-customvocabularyitem-weight)" : {{Integer}}
}
```

### YAML
<a name="aws-properties-lex-bot-customvocabularyitem-syntax.yaml"></a>

```
  [DisplayAs](#cfn-lex-bot-customvocabularyitem-displayas): {{String}}
  [Phrase](#cfn-lex-bot-customvocabularyitem-phrase): {{String}}
  [Weight](#cfn-lex-bot-customvocabularyitem-weight): {{Integer}}
```

## Properties
<a name="aws-properties-lex-bot-customvocabularyitem-properties"></a>

`DisplayAs`  <a name="cfn-lex-bot-customvocabularyitem-displayas"></a>
The DisplayAs value for the custom vocabulary item from the custom vocabulary list.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Phrase`  <a name="cfn-lex-bot-customvocabularyitem-phrase"></a>
Specifies 1 - 4 words that should be recognized.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Weight`  <a name="cfn-lex-bot-customvocabularyitem-weight"></a>
Specifies the degree to which the phrase recognition is boosted. The default value is 1.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Maximum*: `3`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)