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::Kendra::Faq
<a name="aws-resource-kendra-faq"></a>

Creates an new set of frequently asked question (FAQ) questions and answers.

## Syntax
<a name="aws-resource-kendra-faq-syntax"></a>

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

### JSON
<a name="aws-resource-kendra-faq-syntax.json"></a>

```
{
  "Type" : "AWS::Kendra::Faq",
  "Properties" : {
      "[Description](#cfn-kendra-faq-description)" : String,
      "[FileFormat](#cfn-kendra-faq-fileformat)" : String,
      "[IndexId](#cfn-kendra-faq-indexid)" : String,
      "[LanguageCode](#cfn-kendra-faq-languagecode)" : String,
      "[Name](#cfn-kendra-faq-name)" : String,
      "[RoleArn](#cfn-kendra-faq-rolearn)" : String,
      "[S3Path](#cfn-kendra-faq-s3path)" : S3Path,
      "[Tags](#cfn-kendra-faq-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-kendra-faq-syntax.yaml"></a>

```
Type: AWS::Kendra::Faq
Properties:
  [Description](#cfn-kendra-faq-description): String
  [FileFormat](#cfn-kendra-faq-fileformat): String
  [IndexId](#cfn-kendra-faq-indexid): String
  [LanguageCode](#cfn-kendra-faq-languagecode): String
  [Name](#cfn-kendra-faq-name): String
  [RoleArn](#cfn-kendra-faq-rolearn): String
  [S3Path](#cfn-kendra-faq-s3path): 
    S3Path
  [Tags](#cfn-kendra-faq-tags): 
    - Tag
```

## Properties
<a name="aws-resource-kendra-faq-properties"></a>

`Description`  <a name="cfn-kendra-faq-description"></a>
A description for the FAQ.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1000`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`FileFormat`  <a name="cfn-kendra-faq-fileformat"></a>
The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.   
 The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.   
Valid values are:  
+  `CSV` 
+  `CSV_WITH_HEADER` 
+  `JSON` 
*Required*: No  
*Type*: String  
*Allowed values*: `CSV | CSV_WITH_HEADER | JSON`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IndexId`  <a name="cfn-kendra-faq-indexid"></a>
The identifier of the index that contains the FAQ.  
*Required*: Yes  
*Type*: String  
*Minimum*: `36`  
*Maximum*: `36`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`LanguageCode`  <a name="cfn-kendra-faq-languagecode"></a>
The code for a language. This shows a supported language for the FAQ document as part of the summary information for FAQs. English is supported by default. For more information on supported languages, including their codes, see [Adding documents in languages other than English](https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html).  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z-]*`  
*Minimum*: `2`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-kendra-faq-name"></a>
The name that you assigned the FAQ when you created or updated the FAQ.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RoleArn`  <a name="cfn-kendra-faq-rolearn"></a>
The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.  
*Required*: Yes  
*Type*: String  
*Pattern*: `arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}`  
*Minimum*: `1`  
*Maximum*: `1284`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`S3Path`  <a name="cfn-kendra-faq-s3path"></a>
The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.  
*Required*: Yes  
*Type*: [S3Path](aws-properties-kendra-faq-s3path.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-kendra-faq-tags"></a>
An array of key-value pairs to apply to this resource  
For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).  
*Required*: No  
*Type*: Array of [Tag](aws-properties-kendra-faq-tag.md)  
*Maximum*: `200`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-kendra-faq-return-values"></a>

### Ref
<a name="aws-resource-kendra-faq-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the FAQ identifier. For example:

 `{ "Ref": "<faq-id>|<index-id>" }` 

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-kendra-faq-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-kendra-faq-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
 `arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7` 

`Id`  <a name="Id-fn::getatt"></a>
The identifier for the FAQ. For example:  
 `f61995a6-cd5c-4e99-9cfc-58816d8bfaa7` 

# AWS::Kendra::Faq S3Path
<a name="aws-properties-kendra-faq-s3path"></a>

Information required to find a specific file in an Amazon S3 bucket.

## Syntax
<a name="aws-properties-kendra-faq-s3path-syntax"></a>

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

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

```
{
  "[Bucket](#cfn-kendra-faq-s3path-bucket)" : String,
  "[Key](#cfn-kendra-faq-s3path-key)" : String
}
```

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

```
  [Bucket](#cfn-kendra-faq-s3path-bucket): String
  [Key](#cfn-kendra-faq-s3path-key): String
```

## Properties
<a name="aws-properties-kendra-faq-s3path-properties"></a>

`Bucket`  <a name="cfn-kendra-faq-s3path-bucket"></a>
The name of the S3 bucket that contains the file.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-z0-9][\.\-a-z0-9]{1,61}[a-z0-9]`  
*Minimum*: `3`  
*Maximum*: `63`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Key`  <a name="cfn-kendra-faq-s3path-key"></a>
The name of the file.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::Kendra::Faq Tag
<a name="aws-properties-kendra-faq-tag"></a>

A key-value pair that identifies or categorizes an index, FAQ, data source, or other resource. TA tag key and value can consist of Unicode letters, digits, white space, and any of the following symbols: \$1 . : / = \$1 - @.

## Syntax
<a name="aws-properties-kendra-faq-tag-syntax"></a>

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

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

```
{
  "[Key](#cfn-kendra-faq-tag-key)" : String,
  "[Value](#cfn-kendra-faq-tag-value)" : String
}
```

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

```
  [Key](#cfn-kendra-faq-tag-key): String
  [Value](#cfn-kendra-faq-tag-value): String
```

## Properties
<a name="aws-properties-kendra-faq-tag-properties"></a>

`Key`  <a name="cfn-kendra-faq-tag-key"></a>
The key for the tag. Keys are not case sensitive and must be unique for the index, FAQ, data source, or other resource.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-kendra-faq-tag-value"></a>
The value associated with the tag. The value may be an empty string but it can't be null.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)