

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](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::Lex::Bot OpensearchConfiguration
<a name="aws-properties-lex-bot-opensearchconfiguration"></a>

Contains details about the configuration of the Amazon OpenSearch Service database used for the `AMAZON.QnAIntent`.

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

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

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

```
{
  "[DomainEndpoint](#cfn-lex-bot-opensearchconfiguration-domainendpoint)" : String,
  "[ExactResponse](#cfn-lex-bot-opensearchconfiguration-exactresponse)" : Boolean,
  "[ExactResponseFields](#cfn-lex-bot-opensearchconfiguration-exactresponsefields)" : ExactResponseFields,
  "[IncludeFields](#cfn-lex-bot-opensearchconfiguration-includefields)" : [ String, ... ],
  "[IndexName](#cfn-lex-bot-opensearchconfiguration-indexname)" : String
}
```

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

```
  [DomainEndpoint](#cfn-lex-bot-opensearchconfiguration-domainendpoint): String
  [ExactResponse](#cfn-lex-bot-opensearchconfiguration-exactresponse): Boolean
  [ExactResponseFields](#cfn-lex-bot-opensearchconfiguration-exactresponsefields): 
    ExactResponseFields
  [IncludeFields](#cfn-lex-bot-opensearchconfiguration-includefields): 
    - String
  [IndexName](#cfn-lex-bot-opensearchconfiguration-indexname): String
```

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

`DomainEndpoint`  <a name="cfn-lex-bot-opensearchconfiguration-domainendpoint"></a>
The endpoint of the Amazon OpenSearch Service domain.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `5000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExactResponse`  <a name="cfn-lex-bot-opensearchconfiguration-exactresponse"></a>
Specifies whether to return an exact response or to return an answer generated by the model using the fields you specify from the database.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExactResponseFields`  <a name="cfn-lex-bot-opensearchconfiguration-exactresponsefields"></a>
Contains the names of the fields used for an exact response to the user.  
*Required*: No  
*Type*: [ExactResponseFields](aws-properties-lex-bot-exactresponsefields.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IncludeFields`  <a name="cfn-lex-bot-opensearchconfiguration-includefields"></a>
Contains a list of fields from the Amazon OpenSearch Service that the model can use to generate the answer to the query.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `5000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`IndexName`  <a name="cfn-lex-bot-opensearchconfiguration-indexname"></a>
The name of the Amazon OpenSearch Service index.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `5000`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)