interface CfnFaqProps

Language	Type name
.NET	`Amazon.CDK.AWS.Kendra.CfnFaqProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskendra#CfnFaqProps`
Java	`software.amazon.awscdk.services.kendra.CfnFaqProps`
Python	`aws_cdk.aws_kendra.CfnFaqProps`
TypeScript	`aws-cdk-lib` » `aws_kendra` » `CfnFaqProps`

Properties for defining a CfnFaq.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kendra as kendra } from 'aws-cdk-lib';
const cfnFaqProps: kendra.CfnFaqProps = {
  indexId: 'indexId',
  name: 'name',
  roleArn: 'roleArn',
  s3Path: {
    bucket: 'bucket',
    key: 'key',
  },

  // the properties below are optional
  description: 'description',
  fileFormat: 'fileFormat',
  languageCode: 'languageCode',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
indexId	`string`	The identifier of the index that contains the FAQ.
name	`string`	The name that you assigned the FAQ when you created or updated the FAQ.
roleArn	`string`	The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.
s3Path	`IResolvable` `\|` `S3PathProperty`	The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.
description?	`string`	A description for the FAQ.
fileFormat?	`string`	The format of the input file.
languageCode?	`string`	The code for a language.
tags?	`CfnTag[]`	An array of key-value pairs to apply to this resource.

indexId

Type: string

The identifier of the index that contains the FAQ.

name

Type: string

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

roleArn

Type: string

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

s3Path

Type: IResolvable | S3PathProperty

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

description?

Type: string (optional)

A description for the FAQ.

fileFormat?

Type: string (optional)

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

languageCode?

Type: string (optional)

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 .

tags?

Type: CfnTag[] (optional)

An array of key-value pairs to apply to this resource.

For more information, see Tag .