Creates an new set of frequently asked question (FAQ) questions and answers.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::Kendra::Faq",
"Properties" : {
"Description" : String,
"FileFormat" : String,
"IndexId" : String,
"LanguageCode" : String,
"Name" : String,
"RoleArn" : String,
"S3Path" : S3Path,
"Tags" : [ Tag, ... ]
}
}
YAML
Type: AWS::Kendra::Faq
Properties:
Description: String
FileFormat: String
IndexId: String
LanguageCode: String
Name: String
RoleArn: String
S3Path:
S3Path
Tags:
- Tag
Properties
Description-
A description for the FAQ.
Required: No
Type: String
Minimum:
1Maximum:
1000Update requires: Replacement
FileFormat-
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 | JSONUpdate requires: Replacement
-
IndexId-
The identifier of the index that contains the FAQ.
Required: Yes
Type: String
Minimum:
36Maximum:
36Update requires: Replacement
LanguageCode-
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.
Required: No
Type: String
Pattern:
[a-zA-Z-]*Minimum:
2Maximum:
10Update requires: No interruption
Name-
The name that you assigned the FAQ when you created or updated the FAQ.
Required: Yes
Type: String
Minimum:
1Maximum:
100Update requires: Replacement
RoleArn-
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:
1Maximum:
1284Update requires: Replacement
S3Path-
The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.
Required: Yes
Type: S3Path
Update requires: Replacement
-
An array of key-value pairs to apply to this resource
For more information, see Tag.
Required: No
Type: Array of Tag
Maximum:
200Update requires: No interruption
Return values
Ref
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 Ref.
Fn::GetAtt
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 Fn::GetAtt.
Arn-
arn:aws:kendra:us-west-2:111122223333:index/335c3741-41df-46a6-b5d3-61f85b787884/faq/f61995a6-cd5c-4e99-9cfc-58816d8bfaa7 Id-
The identifier for the FAQ. For example:
f61995a6-cd5c-4e99-9cfc-58816d8bfaa7
