Interface ICfnFaqProps

Properties for defining a CfnFaq.

Namespace: Amazon.CDK.AWS.Kendra

Assembly: Amazon.CDK.AWS.Kendra.dll

Syntax (csharp)

public interface ICfnFaqProps

Syntax (vb)

Public Interface ICfnFaqProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Kendra;

var cfnFaqProps = new CfnFaqProps {
    IndexId = "indexId",
    Name = "name",
    RoleArn = "roleArn",
    S3Path = new S3PathProperty {
        Bucket = "bucket",
        Key = "key"
    },

    // the properties below are optional
    Description = "description",
    FileFormat = "fileFormat",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Properties

Description	A description for the FAQ.
FileFormat	The format of the input file.
IndexId	The identifier of the index that contains the FAQ.
Name	The name that you assigned the FAQ when you created or updated the FAQ.
RoleArn	The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.
S3Path	The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.
Tags	An array of key-value pairs to apply to this resource.

Properties

Description

A description for the FAQ.

virtual string Description { get; }

Property Value

System.String

Remarks

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

FileFormat

The format of the input file.

virtual string FileFormat { get; }

Property Value

System.String

Remarks

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:

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