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.84.0 (build 5404dcf)", date="2023-06-19T16:29:58.176Z") @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")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

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

    • getName

      @Stability(Stable) @NotNull String getName()
      The name that you assigned the FAQ when you created or updated the FAQ.

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

    • getS3Path

      @Stability(Stable) @NotNull Object getS3Path()
      The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      A description for the FAQ.

    • 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

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

      For more information, see Tag .

    • builder

      @Stability(Stable) static CfnFaqProps.Builder builder()
      Returns:
      a CfnFaqProps.Builder of CfnFaqProps