Package software.amazon.awscdk.services.kendra

Class CfnFaqProps.Builder

java.lang.Object
software.amazon.awscdk.services.kendra.CfnFaqProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnFaqProps>
Enclosing interface:
CfnFaqProps
@Stability(Stable) public static final class CfnFaqProps.Builder extends Object implements software.amazon.jsii.Builder<CfnFaqProps>
A builder for CfnFaqProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • indexId

      @Stability(Stable) public CfnFaqProps.Builder indexId(String indexId)
      Sets the value of CfnFaqProps.getIndexId()
      Parameters:
      indexId - The identifier of the index that contains the FAQ. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnFaqProps.Builder name(String name)
      Sets the value of CfnFaqProps.getName()
      Parameters:
      name - The name that you assigned the FAQ when you created or updated the FAQ. This parameter is required.
      Returns:
      this

    • roleArn

      @Stability(Stable) public CfnFaqProps.Builder roleArn(String roleArn)
      Sets the value of CfnFaqProps.getRoleArn()
      Parameters:
      roleArn - The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQ. This parameter is required.
      Returns:
      this

    • s3Path

      @Stability(Stable) public CfnFaqProps.Builder s3Path(IResolvable s3Path)
      Sets the value of CfnFaqProps.getS3Path()
      Parameters:
      s3Path - The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data. This parameter is required.
      Returns:
      this

    • s3Path

      @Stability(Stable) public CfnFaqProps.Builder s3Path(CfnFaq.S3PathProperty s3Path)
      Sets the value of CfnFaqProps.getS3Path()
      Parameters:
      s3Path - The Amazon Simple Storage Service (Amazon S3) location of the FAQ input data. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnFaqProps.Builder description(String description)
      Sets the value of CfnFaqProps.getDescription()
      Parameters:
      description - A description for the FAQ.
      Returns:
      this

    • fileFormat

      @Stability(Stable) public CfnFaqProps.Builder fileFormat(String fileFormat)
      Sets the value of CfnFaqProps.getFileFormat()
      Parameters:
      fileFormat - 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
      Returns:
      this

    • tags

      @Stability(Stable) public CfnFaqProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnFaqProps.getTags()
      Parameters:
      tags - An array of key-value pairs to apply to this resource. For more information, see Tag .
      Returns:
      this

    • build

      @Stability(Stable) public CfnFaqProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnFaqProps>
      Returns:
      a new instance of CfnFaqProps
      Throws:
      NullPointerException - if any required attribute was not provided