AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Kendra::Faq

CfnFaq

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

Import

import { CfnFaq } from 'aws-cdk-lib/aws-kendra';

Or use the module namespace:

import * as kendra from 'aws-cdk-lib/aws-kendra';
// kendra.CfnFaq

Properties

Configuration passed to the constructor as CfnFaqProps.

indexIdRequired
string

The identifier of the index that contains the FAQ.

nameRequired
string

The name that you assigned the FAQ when you created or updated the FAQ.

roleArnRequired
string

The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.

s3PathRequired
IResolvable | S3PathProperty

The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.

descriptionOptional
string

A description for the FAQ.

fileFormatOptional
string

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`

languageCodeOptional
string

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) .

tagsOptional
CfnTag[]

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) .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Kendra::FaqView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-kendra
CFN TypeAWS::Kendra::Faq
Properties8

Related Constructs

Explore This Service

External Links