CfnFaqProps

class aws_cdk.aws_kendra.CfnFaqProps(*, index_id, name, role_arn, s3_path, description=None, file_format=None, language_code=None, tags=None)

Bases: object

Properties for defining a CfnFaq.

Parameters:

index_id (str) – The identifier of the index that contains the FAQ.
name (str) – The name that you assigned the FAQ when you created or updated the FAQ.
role_arn (str) – The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.
s3_path (Union[IResolvable, S3PathProperty, Dict[str, Any]]) – The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.
description (Optional[str]) – A description for the FAQ.
file_format (Optional[str]) – 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
language_code (Optional[str]) – 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 (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_kendra as kendra

cfn_faq_props = kendra.CfnFaqProps(
    index_id="indexId",
    name="name",
    role_arn="roleArn",
    s3_path=kendra.CfnFaq.S3PathProperty(
        bucket="bucket",
        key="key"
    ),

    # the properties below are optional
    description="description",
    file_format="fileFormat",
    language_code="languageCode",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

A description for the FAQ.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-description

file_format

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-fileformat

index_id

The identifier of the index that contains the FAQ.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-indexid

language_code

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-languagecode

name

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-name

role_arn

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-rolearn

s3_path

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-s3path

tags

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

For more information, see Tag .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kendra-faq.html#cfn-kendra-faq-tags