Package software.amazon.awscdk.services.kendra

Interface CfnFaqProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFaqProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:03.473Z")
@Stability(Stable)
public interface CfnFaqProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.kendra.*;
 CfnFaqProps cfnFaqProps = CfnFaqProps.builder()
         .indexId("indexId")
         .name("name")
         .roleArn("roleArn")
         .s3Path(S3PathProperty.builder()
                 .bucket("bucket")
                 .key("key")
                 .build())
         // the properties below are optional
         .description("description")
         .fileFormat("fileFormat")
         .languageCode("languageCode")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFaqProps.Builder	A builder for CfnFaqProps
static final class	CfnFaqProps.Jsii$Proxy	An implementation for CfnFaqProps

Method Summary

Modifier and Type	Method	Description
static CfnFaqProps.Builder	builder()
default String	getDescription()	A description for the FAQ.
default String	getFileFormat()	The format of the input file.
String	getIndexId()	The identifier of the index that contains the FAQ.
default String	getLanguageCode()	The code for a language.
String	getName()	The name that you assigned the FAQ when you created or updated the FAQ.
String	getRoleArn()	The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ.
Object	getS3Path()	The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIndexId

@Stability(Stable)
@NotNull
String getIndexId()

The identifier of the index that contains the FAQ.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

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

See Also:

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

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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

See Also:

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

getS3Path

@Stability(Stable)
@NotNull
Object getS3Path()

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

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description for the FAQ.

See Also:

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

getFileFormat

@Stability(Stable)
@Nullable
default String getFileFormat()

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 Also:

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

getLanguageCode

@Stability(Stable)
@Nullable
default String getLanguageCode()

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 Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

For more information, see Tag .

See Also:

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

builder

@Stability(Stable)
static CfnFaqProps.Builder builder()

Returns:

a CfnFaqProps.Builder of CfnFaqProps